Adding custom hunspell dictionary

[tdimitrov]

Is it still possible to add your own dictionary in hunspell format?

I found this discussion but the link there is now dead.

A bit more context. The project I work on uses this dictionary and I want to integrate it in my workflow.

[Jason3S]

@tdimitrov,

The dictionaries used in the spell checker are found here: https://github.com/streetsidesoftware/cspell-dicts
They use the cspell-tools-cli to convert Hunspell files into a supported format.

The README for cspell-tools seems to be out of date. There are more options.

The easiest way to try it would be:

cspell-tools.config.yaml

targets:
  - name: company-dictionary
    sources:
      - src/hunspell/index.aff
    format: trie3
    generateNonStrict: true

cspell-tools-cli build

The build command looks for a cspell-tools.config.yaml file and will generate a company-dictionary.trie file that can be used in a cspell.config.yaml file.

cspell.config.yaml

dictionaryDefinitions:
  - name: company-dictionary
    path: ./company-dictionary.trie
dictionaries:
  - company-dictionary

[tdimitrov]

Thanks @Jason3S! I'll give it a try.

[tdimitrov]

My input is .dic file so I created:

targets:
  - name: polkadot
    sources:
      - lingua.dic
    format: trie3
    generateNonStrict: true

and it yields:

$ cspell-tools-cli build
2023-05-22T17:27:43.312Z Start compile: polkadot
2023-05-22T17:27:43.314Z Reading lingua.dic
[Error: ENOENT: no such file or directory, open '/work/lingua.aff'] {
  errno: -2,
  code: 'ENOENT',
  syscall: 'open',
  path: '/work/lingua.aff'
}

/work is my CWD, but I've got no lingua.aff file.

Also if this step succeeds what should I do with the cspell.config.yaml file?

[Jason3S]

@tdimitrov,

The good news is that you do not have a Hunspell dictionary. So, all of the above is not needed.

Hunspell dictionaries have two parts, a .aff and a .dic file. The .aff file is to define the manipulation rules. The .dic file is a list of words with possible rules to apply.

The spell checker allows for custom dictionary files, but cannot apply Hunspell rules. Since you do not have any, you can use the .dic file without modification.

The cSpell.customDictionaries setting should work for you.

settings.json

  "cSpell.customDictionaries": {
    "company-dictionary": {
      "name": "company-dictionary",
      "path": "/path/or/url/to/dictionary.dic"
    }
  }

[tdimitrov]

Sorry about the confusion @Jason3S. I got mislead by the way it's used (it mentions hunspell).

I've tried what you suggested, it partially works but the dictionary has got some keywords which aren't interpreted correctly. E.g. accessor/MS. I don't know what they mean but they are interpreted literally - if I remove them the word is recognized otherwise the spell checker marks it as wrong. This is my initial issue actually.