Using non-default cspell-dicts with pre-commit

[danielfdickinson]

It looks like the cspell-cli pre-commit hook doesn't have a way to add non-default dictionaries 'automagically'. (e.g. as an args parameter). I can see ways to make it work IFF the dictionary is installed (or cloned) by some other means.

Unless I am mistaken, the automatic adding of the dictionaries to the pre-commit environment would require it's own hook (so that pre-commit is aware it needs to download something). In particular, with https://pre-commit.ci pre-commit doesn't like to download extra files except via a hook.

It seems to me, the most realistic way to make non-default cspell-dicts work with pre-commit is to add desired dictionaries to one's project as a git submodule, and use an import.

E.g. modifying from the fr_FR dictionary's README, with cspell-dicts cloned to tests/config/cspell-dicts and using a cspell.json in tests/config

{
    // …
    "import": ["./cspell-dicts/dictionaries/fr_FR/cspell-ext.json"],
    // …
}

Is there a better way to do this with with pre-commit, presuming this method even works?

EDIT: This 'almost' works, except the fr_fr.trie is not compressed. If I gzip it and enable the dictionary in my cspell.json then it works.

I don't think there is a way to get what I want without either writing a new pre-commit hook, modifying cspell-cli, or 'True Evil(tm)' like using npm and committing the node_modules folder.

So I found additional_dependencies for pre-commit. Now I just have to add some glue to the cspell-cli that does the equivalent of cspell link before executing cspell lint.

EDIT again: It may not be necessary to modify cspell-cli at all. If I get it working I will submit an issue and PR for the docs with the solution.

[danielfdickinson]

I have figured out something that works. Using French as example:

In one's pre-commit-config.yaml one needs:

    hooks:
      - id: cspell
        additional_dependencies:
          - "@cspell/dict-fr-fr"
          - "@cspell/dict-fr-reforme"
        args:
          - "lint"
          - "--locale"
          - "fr" # We do this for this doc's simplicity

You can of course use overrides to set the locale for some glob instead of checking all files with this locale. In this case it is just a convenient way to auto-enable the french dictionaries.

In one's cspell.json one needs:

"import": [
  "@cspell/dict-fr-fr/cspell-ext.json",
  "@cspell/dict-fr-reforme/cspell-ext.json"
]

cspell link add doesn't seem to work with a --config parameter (and/or the pre-commit environment; I haven't fully determined the cause as I found something that worked).

[lwbt]

Note to myself:

https://pre-commit.com/hooks.html leads to https://github.com/streetsidesoftware/cspell-cli which, at the time of writing, instructs you to create cspell.config.yaml or cSpell.json. Which makes you think that YAML is the preferred format, which doesn't seem to be true. Following getting-started and using the JSON example as a base instead made the answer work right away.

Thanks for the answer.

Edit: Okay, it seems that one needs to keep the quotes in YAML too, e.g. "@cspell/dict-fr-fr/cspell-ext.json". But I will stick with JSON now.