How to use dict-git?

[assyrus-favolo]

I've tried following the instructions here https://www.npmjs.com/package/@cspell/dict-git (install the package link it and provide --language-id commit-msg argument to cspell) but regardless I keep getting an error on this, for example:

Unknown word (EDITMSG)

despite being included in the word list.
What am I doing wrong?

[Jason3S]

@assyrus-favolo,

You should not need to install it. It is installed by default. But, you do need to enable the dictionary.

cspell.json

{
  "dictionaries": ["git"]
}

[assyrus-favolo]

Alright, so I guess the documentation should be updated.
But, aside from that, I can't manage to have that work with the command line options, I tried this:

npx cspell --language-id git .\test.md

(test.md only contains the word "EDITMSG" and nothing else)
I also tried with commit-msg in place of git, still wrong.

I get the same error, with the configuration it does work though, is it that I used the wrong option? I also tried --locale, I can't figure out which is the "dictionaries" equivalent

[Jason3S]

At the moment, there isn't an option to enable a dictionary in the command line. In this case, it is needed, because without it, the only way to enable the git word list is to use a config file.

I opened to #4452 so that language-id=commit-msg will work.

[assyrus-favolo]

Oh wow, thank you so much!! That's perfect

[Jason3S]

Since cspell v9.1, it is possible to use the --dictionary option to enable the git dictionary.

Like this:

cspell --dictionary git --file ./.git/COMMIT_EDITMSG 

[ccoVeille]

Are you able to change the "marked as answer" to point to this one?

[assyrus-favolo]

Done!