fix: Add --no-exit-code option to prevent spelling issues from impacting the exit code.

[fughilli]

This PR implements a simple --allow-failure flag, which configures cspell to return 0 exit code even when there are findings. This is useful for uses in CI (such as in a pre-commit hook) to allow reporting findings without failing the pre-commit.

[Jason3S]

@fughilli,

Thank you. I'm open to the idea. I have to think about the name.

Things to consider:

There is a difference between issues and errors.

• Spelling Issues - something was detected in a document.
  • ignored - the word has been marked to be ignored.
  • suggest - there is a suggested change, but it is not considered incorrect.
  • unknown - the word was not found in any dictionary and is considered incorrect.
  • flagged - the word has been flagged as forbidden.

Only unknown and flagged issues are reported and will cause an exit code of 1.

• Errors - something went wrong.
  • file errors
  • bad or missing configuration.

This new option should only impact issues and not errors.

Errors can be handled using the || command line syntax: cspell . || echo ok.

Ideas:

• --exit-code-for-issues <number> - If issues (unknown or flagged) are found, use the <number> given.

A future option: --issues-level <suggest|unknown|flagged> - to set the level where the exit code is used.

[Jason3S]

Related to #4809 (comment)

How about --no-exit-code - Spelling issues will not set the exit code.? Implies --no-must-find-files.

[Jason3S]

result.errors is a real error.

Logic:

Suggested change

	const exitCode = options.allowFailure ? 0 : 1;
	const exitCode = result.errors || !options.allowFailure ? 1 : 0;

[Jason3S]

@fughilli,

It will be necessary to update the snapshots.

In packages/cspell:

pnpm vitest run -u

[fughilli]

I'm open to either --exit-code-for-issues or --no-exit-code, which would be preferable? Good catch on the result.errors nuance, I wasn't paying close enough attention to the conditional expression.

Also, I was trying to build using pnpm build and ran into:

...
packages/cspell-lib build$ tsc -b . && pnpm run build:api
packages/cspell-lib build: error TS6305: Output file '/Users/kbalke/Projects/git_checkouts/vendored/cspell/packages/cspell-lib/src/lib-cjs/pkg-info.d.cts' has not been built from source file '/Users/kbalke/Projects
/git_checkouts/vendored/cspell/packages/cspell-lib/src/lib-cjs/pkg-info.cts'.
packages/cspell-lib build:   The file is in the program because:
packages/cspell-lib build:     Matched by default include pattern '**/*'
packages/cspell-lib build: Failed
/Users/kbalke/Projects/git_checkouts/vendored/cspell/packages/cspell-lib:
 ERR_PNPM_RECURSIVE_RUN_FIRST_FAIL  cspell-lib@7.3.2 build: `tsc -b . && pnpm run build:api`
Exit status 1
 ELIFECYCLE  Command failed with exit code 1.

Any ideas?

[Jason3S]

@fughilli,

Let's go with --no-exit-code, I think that is the simplest for users to understand.

As far as the build, I think you might need to clean first: pnpm i && pnpm clean at the root.

[fughilli]

How does this look? @Jason3S

[Jason3S]

@fughilli,

The command line parser turns --no-exit-code into exitCode.

I corrects the Options interface and updated the snapshots.