Reorganize custom dictionaries, better spell checking infra

[Josh-Cena]

This should be merged after my fleet of typo fix PRs.

This PR splits our custom dictionaries by topic, making them easier to maintain and inspect. It could also allow for more granular options in the future, such as whether each one should provide suggestions, or whether they should be case-sensitive.

@OnkarRuikar @bsmth

[OnkarRuikar]

Give me 2-3 days.

[OnkarRuikar]

command [filePaths...]

You are using both ellipsis and plural from of the word.

How to denote at least one file is required? command <filePath> [filePath...]? I think command [filePath]... does that.

[Josh-Cena]

Huh, the GH actions shell does not automatically expand glob patterns. That's inconvenient.

[Josh-Cena]

You are using both ellipsis and plural from of the word.

How to denote at least one file is required? command <filePath> [filePath...]? I think command [filePath]... does that.

This is the description format as used by commander.js

[OnkarRuikar]

In writing docs we need to explain following points:

• when to use cSpell inline ignore comments in content
• the purpose of each dictionary
• nuances like cities are to be put in cultural-words but towns and places in proper-name. We don't want to suggest small towns and places but want countries and cities etc.

I am waiting on content fixes to merge to check regex and other codes.

[OnkarRuikar]

Huh, the GH actions shell does not automatically expand glob patterns. That's inconvenient.

You can specify shell to a task:

jobs:
  name-of-job:
    runs-on: ubuntu-latest
    steps:
      - name: Hello world
        shell: pwsh
        run: |
          write-output "Hello World"

steps:
  - name: Display the path
    run: |
      import os
      print(os.environ['PATH'])
    shell: python

steps:
  - name: Display the path
    run: echo $PATH
    shell: bash

[github-actions]

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

[github-actions]

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

[github-actions]

Preview URLs

• /en-US/docs/Learn/Tools_and_testing/Cross_browser_testing/Automated_testing
• /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: 2024-10-31 02:20:13)

[Josh-Cena]

In writing docs we need to explain following points:

Which docs are you referring to? The comments and descriptions in the cSpell config?

[bsmth]

Looking good, leaving a +1, shall we wait for Onkar to have a look or are we ready to merge?

[Josh-Cena]

Will merge once @OnkarRuikar also gives a thumbsup

[OnkarRuikar]

A few suggestions and questions. I was waiting for related content changes to merge.

In writing docs we need to explain following points:

Which docs are you referring to? The comments and descriptions in the cSpell config?

In the spellings section in writing guidelines we could have short description of cspell and dictionaries. And can mention the command to check spellings manually:

npx cspell --no-progress --gitignore --config .vscode/cspell.json "**/*.md"

[OnkarRuikar]

Suggested change

	media.peerconnection.rtpsourcesapi
	rtpsourcesapi

Why put the entire fully qualified name? Adding the interface name should be sufficient, right?
There are multiple occurrences of these like dom.abortablepromise.

One word per line will keep it simple and reduce the dictionary size significantly.

[Josh-Cena]

These are Firefox preferences. I add the prefix to prevent abortablepromise being a valid word on its own; I want the ignored words to be as contextualized and specific as possible because it's always easier to fix false positives than catch false negatives.

[OnkarRuikar]

I add the prefix to prevent abortablepromise being a valid word on its own

I see. 👍

It would be great if this feature/case is documented somewhere.

[Josh-Cena]

I've added a sentence to cspell.json's comment:

// Note: when adding words to these lists, be as specific and contextualized
    // as possible, to avoid typos being masked elsewhere. For example, all FF
    // preferences should include prefixes: `dom.abortablepromise` instead of
    // just `abortablepromise`, which may be missing a space in other contexts.

[OnkarRuikar]

Suggested change

	enable-tracejit
	tracejit

We don't have to put the entire term. Same for color-CBDT etc.

[Josh-Cena]

Again, tracejit should not be a word unless there's evidence that we actually write it. The only valid usage is in the whole context of enable-tracejit—other than that it should be a typo.

[OnkarRuikar]

Suggested change

219ffwef9w0f

Like "sessionid=\\w+", can we add Set-Cookie: .*? qwerty=\\w+

[Josh-Cena]

I don't want to do this because Set-Cookie could contain legitimate words in the attribute names.

[OnkarRuikar]

Also, it makes no sense to add regex if there is only one instance.

[OnkarRuikar]

Suggested change

	bruce_vs_ironman
	ironman

[Josh-Cena]

Again ironman is not a valid word. It's "Iron Man". It's only valid in this particular file name because I don't want to change it.

[bsmth]

Super, thank you 👍🏻

[OnkarRuikar]

One nit

[OnkarRuikar]

The PR changes look good to me. Thanks for taking on this monumental task!

[Josh-Cena]

Great, let's go!

[bsmth]

Well done 👏🏻