cspell-eslint-plugin: how do I tell which dictionaries are enabled by default?

[lkraav]

Everything is mostly working great, but occasionally I'm getting specialty words flagged, in this case "anonymization".

node@e0f0d2ba6d1e:/app$ npx eslint apps/admin-api/src/resources/review/getByTestId/index.js

/app/apps/admin-api/src/resources/review/getByTestId/index.js
  80:14  warning  Unknown word: "Anonymization"  @cspell/spellchecker
  80:46  warning  Unknown word: "Anonymization"  @cspell/spellchecker

✖ 2 problems (0 errors, 2 warnings)

OK then, eslint.config.js is simple:

...
  ...compat.extends('plugin:@cspell/recommended'),
...

Running eslint --print-config gives us:

...
    "@cspell/spellchecker": [
      1,
      {
        "autoFix": false,
        "checkComments": true,
        "checkIdentifiers": true,
        "checkJSXText": true,
        "checkStringTemplates": true,
        "checkStrings": true,
        "generateSuggestions": true,
        "ignoreImportProperties": true,
        "ignoreImports": true,
        "numSuggestions": 8
      }
    ],
...

CLI tool trace shows this word exists in multiple dicts:

node@e0f0d2ba6d1e:/app$ npx cspell trace anonymization
Word          F Dictionary             Dictionary Location
anonymization - [flagWords]*           From Settings `flagWords`
anonymization - [ignoreWords]*         From Settings `ignoreWords`
anonymization - [suggestWords]*        From Settings `suggestWords`
anonymization - [words]*               From Settings `words`
anonymization - aws*                   node_modules/@cspell/dict-aws/dict/aws.txt
anonymization - companies*             node_modules/@cspell/dict-companies/dict/companies.txt
anonymization - computing-acronyms*    node_modules/@cspell/dict-software-terms/dict/computing-acronyms.txt
anonymization - cryptocurrencies*      node_modules/@cspell/dict-cryptocurrencies/dict/cryptocurrencies.txt
anonymization * data-science           node_modules/@cspell/dict-data-science/dict/data-science.txt
anonymization - en_us*                 node_modules/@cspell/dict-en_us/en_US.trie.gz
anonymization - en-common-misspelling* node_modules/@cspell/dict-en-common-misspellings/dict-en.yaml
anonymization * en-gb                  node_modules/@cspell/dict-en-gb/en_GB.trie.gz
anonymization - filetypes*             node_modules/@cspell/dict-filetypes/filetypes.txt.gz
anonymization - public-licenses*       node_modules/@cspell/dict-public-licenses/public-licenses.txt.gz
anonymization - softwareTerms*         node_modules/@cspell/dict-software-terms/dict/softwareTerms.txt
anonymization - web-services*          node_modules/@cspell/dict-software-terms/dict/webServices.txt

❓ But how do I tell which dictionaries are being used by cspell-eslint-plugin right now?

Ideally I would get a list and then I'd be able to append a chosen dictionary to it, or what's the alternative?

[Jason3S]

@lkraav,

Two things:

Possible issues

I think the issue is that US English is used by default. The language setting can be used to tell the plugin to use British English.

   "@cspell/spellchecker": [
      1,
      {
        "autoFix": false,
        "checkComments": true,
        "checkIdentifiers": true,
        "checkJSXText": true,
        "checkStringTemplates": true,
        "checkStrings": true,
        "generateSuggestions": true,
        "ignoreImportProperties": true,
        "ignoreImports": true,
        "numSuggestions": 8,
        "cspell": {
          "language": "en-gb", // or "en-gb,en-us" to use both dictionaries.
        }
      }
   ],

Plugin-Settings

It isn't easy for cspell to read the settings used by the plugin. The easiest is to use a cspell.config.yaml file to add cspell specific configuration. That can be used by both the plugin and the command line tool.

I hope this helps.

[lkraav]

I think the issue is that US English is used by default. The language setting can be used to tell the plugin to use British English.

Thanks for an uber-fast reply 💯 Well this is a US-audience oriented app, so en-US would be the appropriate choice.

But I can see now I missed details in docs: "The word is found in a dictionary if a * appears before the dictionary name."

I've been staring at the trailing * (dictionary enabled).

Here, I think bringing data-science dictionary off the bench might make sense, will try that now.

[lkraav]

Do you think cspell-eslint-plugin (v7+) could be more explicit about its dictionary choices with eslint --print-config? Sounds like a reasonable issue for me to file?

[lkraav]

suggested monkey-patching https://github.com/streetsidesoftware/cspell/blob/cspell7/packages/cspell-eslint-plugin/src/worker/spellCheck.mts reportConfigurationErrors() and indeed, this provides the clarity I needed

node@e0f0d2ba6d1e:/app$ npx eslint apps/admin-api/src/resources/review/getByTestId/index.js

/app/apps/admin-api/src/resources/review/getByTestId/index.js
  80:14  warning  Unknown word: "Anonymization"  @cspell/spellchecker
  80:46  warning  Unknown word: "Anonymization"  @cspell/spellchecker

✖ 2 problems (0 errors, 2 warnings)

[en_us]