Should I use eslint plugin, CLI, or both ?

[CaptainZiboo]

Hello everyone ! 👋
Just as the title says... I'm building a monorepo project and I was wondering how I should include cspell, should I rather use the eslint plugin, the CLI or both ? What is the best option and why ? I would love to read your opinions about it

[Jason3S]

@CaptainZiboo,

Good question.

Like most situations, it depend upon you need.

1. If you want to spell check code, comments, strings, and documents, then the CLI should work fine. The downside is that you might need to add third party library names to your dictionary.
2. If you want more control over what to spell check in JavaScript or TypeScript, like just strings and comments, then using the ESLint Plugin will make that easier.
3. It is possible to use both. Since the ESLint Plugin will check JavaScript/TypeScript files, adding ignorePaths: [**/*.{js,ts}] to your cspell.config.yaml will tell the CLI to not spell check those file.

In all cases, I suggest you create a cspell.config.yaml file and your own dictionary. This will help with configuration.

[CaptainZiboo]

Thanks a lot for your answer, I'll try with the CLI and add the eslint plugin later on if I feel like I really need it ! 🙏