CSpell: How to exit without error when no files are checked?

[CreativeTechGuy]

Info

Kind of Issue

• runtime - command-line tools

Which Tool or library

• cspell -- the command-line spelling tool

Which Version

Version: 5.6.6

OS:

• Macos
• Linux
• Windows

Bug Description

Running cspell on a single file which is excluded via ignorePaths results in a non-zero exit code.

To Reproduce

• Create a cspell.json file with ignorePaths: ["someFile.json"]
• Create a file someFile.json
• Run npx cspell someFile.json
• Output is CSpell: Files checked: 0, Issues found: 0 in 0 files but the exit code is 1

Expected behavior

Command should be a no-op and have a successful exit code

Additional context

This is a huge issue when running cspell in lint-staged on changed files. If only one file was changed, and that file is ignored via ignorePaths the commit fails even though it should succeed since the file is ignored.

cspell.json

[Jason3S]

@CreativeTechGuy,

This behavior is by design.

Please check out npx cspell lint --help. I think npx cspell --no-must-find-files someFile.json will do what you want.

[CreativeTechGuy]

Can the documentation for cspell be added to the README in the repo? That's the place I'd look for what arguments are available and how to use it. The only two things I see that are currently somewhat mentioned are cspell and cspell check but they don't really explain when to use each, or what other options there might be, etc.

I'd like to see a section like this which lists all of the CLI arguments and details (can even be generated directly from --help).

[Jason3S]

@CreativeTechGuy,

Thank you for the feed back. I adjusted the cspell README with #1530.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.