ci(cspell-bot): group words by file to reduce log size #38575

OnkarRuikar · 2025-03-11T09:56:53Z

Problem

In the weekly spelling check bot, the current scheme of reporting each word on a separate line with corresponding file is generating massive logs. If someone adds a different version of lorem ipsum then it breaks the GitHub workflow with an error

GraphQL: Body is too long (maximum is 65536 characters) (createIssue)

https://github.com/mdn/content/actions/runs/13753835872/job/38458187038#step:5:876

Solution

Instead of having file-word combinations, have file-words combinations. That is, list a file path followed by the list of unknown words in it. It will reduce files x words lines to only files.

For example, the equivalent outcome of the failed workflow would be:

files/en-us/learn_web_development/howto/solve_html_problems/use_javascript_within_a_webpage/index.md - Unknown words (Matuzovic)

files/en-us/web/api/performance_api/monitoring_bfcache_blocking_reasons/index.md - Unknown words (idbversionchangeevent, idledetector, keyboardlock, otpcredential, pictureinpicturewindow, smartcardconnection, speechrecognition, webhid, webxrdevice)

files/en-us/web/api/trusted_types_api/index.md - Unknown words (tinyfill)

files/en-us/web/css/_colon_first-child/index.md - Unknown words (Adhemar, Blankers, Bubka, Gebrselassie, Haile, Irena, Junxia, Kersee, Koen, Paavo, Szewinska, Usain, Zatopek)

files/en-us/web/css/_colon_lang/index.md - Unknown words (czaszką, lepiej, napisem, narysowaną, wchodzić, widzimy, znak, środka)

files/en-us/web/css/_colon_last-child/index.md - Unknown words (Adhemar, Blankers, Bubka, Gebrselassie, Haile, Irena, Junxia, Kersee, Koen, Paavo, Szewinska, Usain, Zatopek)

files/en-us/web/css/_colon_nth-child/index.md - Unknown words (Adhemar, Blankers, Bubka, Gebrselassie, Haile, Irena, Junxia, Kersee, Koen, Paavo, Szewinska, Usain, Zatopek)

files/en-us/web/css/_colon_nth-last-child/index.md - Unknown words (Cloquet, Hinckley, Kursha, Miramichi, Peshtigo)

files/en-us/web/css/_colon_only-child/index.md - Unknown words (Downey, Scarlett)

files/en-us/web/css/_doublecolon_after/index.md - Unknown words (Indo, scorpionfish)

files/en-us/web/css/_doublecolon_first-letter/index.md - Unknown words (Robison, dragonfish)

files/en-us/web/css/_doublecolon_first-line/index.md - Unknown words (Exocoetidae)

files/en-us/web/css/_doublecolon_marker/index.md - Unknown words (Deke, Gordo, Grissom, Schirra, Slayton)

files/en-us/web/css/animation/index.md - Unknown words (slidein)

files/en-us/web/css/clip-path/index.md - Unknown words (Aéro)

files/en-us/web/css/counter/index.md - Unknown words (Bron, Dwyane, Giancarlo, Iniesta, Xavi)

files/en-us/web/css/css_conditional_rules/container_scroll-state_queries/index.md - Unknown words (Aristonem, Aristoxeni, Atqui, Beatus, Conferam, Duarum, Falli, Huius, Lyco, Memini, Metrodori, Nescio, Neutrum, Omnes, Omnia, Pisonem, Polemonis, Praeteritis, Prioris, Putabam, Quonam, Rationis, Tria, Triarium, Videmus, abducam, adesse, aequius, agas, altera, angustiarum, apertissimis, apparet, auctoritatem, beate, bonorum, capienda, causa, censent, commendas, concedamus, conquiescere, consumptum, controversia, controversiam, cuique, deinde, dicitis, dicitur, dicuntur, differt, discipulum, dissensio, dissensione, disseramus, dissimile, dixisse, dixisset, docilitas, eiusdem, equidem, erit, erunt, expositum, faciam, faciat, falsone, finem, fingunt, futtiles, gaudeo, haec, hilaretur, homines, ielunior, igitur, ille, infantes, ingenium, inprudens, instituta, ipsis, istarum, iucundum, iudicare, iustitia, laboro, laudatur, leves, liberius, liberos, locuples, longi, loqui, maior, maximarum, melius, memoria, motum, musicis, natos, nimium, nomine, occurrentia, oculis, omnes, oportere, oportunitatis, oratione, paria, peccata, pecuniae, perfectio, pertinacem, philosophiae, philosophos, possint, possumus, potest, potestne, praetervolavit, privasse, pulsi, putas, quaerere, recurrant, redargueret, reperies, ridens, saepius, satis, satisfacit, sensus, sequens, sequuntur, sordidos, subicias, subtilius, sumus, superiori, tantae, targetting, timore, utebare, utilitatem, vanos, veniunt, vere, videmus, vides, vincunt, vitarum, vivere)

files/en-us/web/css/font-optical-sizing/index.md - Unknown words (slablike)

files/en-us/web/css/shape-image-threshold/index.md - Unknown words (Aéro)

files/en-us/web/css/shape-margin/index.md - Unknown words (Aéro)

files/en-us/web/css/shape-outside/index.md - Unknown words (Aéro)

files/en-us/web/css/white-space/index.md - Unknown words (stept)

files/en-us/web/html/element/aside/index.md - Unknown words (rainforest)

files/en-us/web/html/element/mark/index.md - Unknown words (rainforest)

files/en-us/web/svg/element/discard/index.md - Unknown words (Dahlström's)

A custom CSpell reporter

As suggested in the An option to consolidate the misspelled words per file streetsidesoftware/cspell#7006 discussion, I've created a custom group-by-file reporter that can be used to reduce the size of the opening post of the weekly spelling check GitHub issues.

package.json

.github/workflows/spelling-check-bot.yml

github-actions · 2025-03-12T05:48:40Z

Preview URLs

/en-US/docs/MDN/Writing_guidelines/Writing_style_guide

External URLs (1)

URL: /en-US/docs/MDN/Writing_guidelines/Writing_style_guide
Title: Writing style guide

https://cspell.org/ (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2025-03-14 12:37:45)

OnkarRuikar · 2025-03-12T05:57:42Z

Made some changes based on the review comments so far:

Moved all the linters to dev dependencies.
Added CSpell to the dev dependencies. We don't have to use npx anymore.
Added three new commands to the package.json:
- lint:typos (plain cspell command)
- lint:typos-group-by-file (need this in the GitHub workflow)
- lint:typos-words-only (I need this to fix cspell issues quickly)

OnkarRuikar · 2025-03-12T06:10:44Z

Successful run of the changes: https://github.com/OnkarRuikar/content/actions/runs/13805014898/job/38614067158#step:6:62

This is how the new issue looks: OnkarRuikar#46

bsmth · 2025-03-12T09:07:23Z

files/en-us/mdn/writing_guidelines/writing_style_guide/index.md


 ```bash
-npx cspell --no-progress --gitignore --config .vscode/cspell.json "**/*.md"
+yarn lint:typos
 ```


Regarding the root cause of this problem, as far as I can see, anything generated from here conforms with our existing cSpell lorem-ipsum dictionary: https://www.lipsum.com/feed/html

A good follow-up to this PR is:

Update the container scroll-state queries page with passing Lorem text

Mention this generator (https://www.lipsum.com/feed/html) in our writing guidelines somewhere as a hint for placeholder text.

https://github.com/mdn/content/blob/main/.vscode/cspell.json#L23

I held back on submitting typo fixes so that when this PR merges, you'll manually trigger the workflow and we get to test these changes live.

Update the container scroll-state queries page with passing Lorem text

Agree. There is no point in having other versions of filler texts. We can also recommend the lorem-ipsum plugin in our https://github.com/mdn/content/blob/main/.vscode/extensions.json file. I will do the writing guidelines after these issues get resolved.

the writing guidelines have been updated here: fix(writing guidelines): Mention recommended sources for lorem ipsum #38677

bsmth

Thanks, Onkar! LGTM with a comment for when we're going to fix the typos afterwards

github-actions · 2025-03-13T12:19:35Z

This pull request has merge conflicts that must be resolved before it can be merged.

github-actions · 2025-03-13T13:35:27Z

This pull request has merge conflicts that must be resolved before it can be merged.

bsmth · 2025-03-14T12:36:58Z

I think we're good to merge now, thanks 👍🏻

OnkarRuikar requested review from mdn-bot and a team as code owners March 11, 2025 09:56

github-actions bot added system [PR only] Infrastructure and configuration for the project size/s [PR only] 6-50 LoC changed labels Mar 11, 2025

bsmth reviewed Mar 11, 2025

View reviewed changes

package.json Outdated Show resolved Hide resolved

Josh-Cena reviewed Mar 12, 2025

View reviewed changes

.github/workflows/spelling-check-bot.yml Show resolved Hide resolved

OnkarRuikar requested a review from a team as a code owner March 12, 2025 05:46

OnkarRuikar requested review from dipikabh and removed request for a team March 12, 2025 05:46

OnkarRuikar force-pushed the ci_cspell_bot branch from 831db93 to 2453173 Compare March 12, 2025 05:46

github-actions bot added Content:Meta Content in the meta docs size/l [PR only] 501-1000 LoC changed and removed size/s [PR only] 6-50 LoC changed labels Mar 12, 2025

OnkarRuikar requested a review from bsmth March 12, 2025 05:58

bsmth reviewed Mar 12, 2025

View reviewed changes

bsmth approved these changes Mar 12, 2025

View reviewed changes

OnkarRuikar requested a review from bsmth March 13, 2025 02:55

github-actions bot added the merge conflicts 🚧 [PR only] label Mar 13, 2025

OnkarRuikar force-pushed the ci_cspell_bot branch from 4650922 to fb05222 Compare March 13, 2025 13:31

github-actions bot added merge conflicts 🚧 [PR only] and removed merge conflicts 🚧 [PR only] labels Mar 13, 2025

OnkarRuikar added 4 commits March 13, 2025 19:06

ci(cspell-bot): group words by file to reduce log size

17372a4

need to run yarn install now

bb4a2dd

add cspell and other linters to dev deps, add lint:typo commands

8c68214

remove extra info from the output

755772f

update yarn.lock

0c18a60

OnkarRuikar force-pushed the ci_cspell_bot branch from fb05222 to 0c18a60 Compare March 13, 2025 13:37

github-actions bot removed the merge conflicts 🚧 [PR only] label Mar 13, 2025

dipikabh removed their request for review March 13, 2025 17:59

mdn deleted a comment from github-actions bot Mar 14, 2025

Merge branch 'main' into ci_cspell_bot

6159558

bsmth merged commit 2865d3c into mdn:main Mar 14, 2025
16 of 17 checks passed

OnkarRuikar deleted the ci_cspell_bot branch March 15, 2025 04:42

This was referenced Mar 17, 2025

Weekly spelling check #38671

Closed

fix(writing guidelines): Mention recommended sources for lorem ipsum #38677

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci(cspell-bot): group words by file to reduce log size #38575

ci(cspell-bot): group words by file to reduce log size #38575

OnkarRuikar commented Mar 11, 2025

github-actions bot commented Mar 12, 2025 •

edited

Loading

OnkarRuikar commented Mar 12, 2025

OnkarRuikar commented Mar 12, 2025 •

edited

Loading

bsmth Mar 12, 2025

bsmth Mar 12, 2025

OnkarRuikar Mar 13, 2025

OnkarRuikar Mar 17, 2025

bsmth left a comment

github-actions bot commented Mar 13, 2025

github-actions bot commented Mar 13, 2025

bsmth commented Mar 14, 2025

ci(cspell-bot): group words by file to reduce log size #38575

ci(cspell-bot): group words by file to reduce log size #38575

Conversation

OnkarRuikar commented Mar 11, 2025

Problem

Solution

A custom CSpell reporter

github-actions bot commented Mar 12, 2025 • edited Loading

OnkarRuikar commented Mar 12, 2025

OnkarRuikar commented Mar 12, 2025 • edited Loading

bsmth Mar 12, 2025

Choose a reason for hiding this comment

bsmth Mar 12, 2025

Choose a reason for hiding this comment

OnkarRuikar Mar 13, 2025

Choose a reason for hiding this comment

OnkarRuikar Mar 17, 2025

Choose a reason for hiding this comment

bsmth left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 13, 2025

github-actions bot commented Mar 13, 2025

bsmth commented Mar 14, 2025

github-actions bot commented Mar 12, 2025 •

edited

Loading

OnkarRuikar commented Mar 12, 2025 •

edited

Loading