cspell 7.3.5 → 7.3.7

package/README.md

@@ -154,6 +154,7 @@ Options:
   --no-progress                Turn off progress messages
   --no-summary                 Turn off summary message in console.
   -s, --silent                 Silent mode, suppress error messages.
+  --no-exit-code               Do not return an exit code if issues are found.
   --quiet                      Only show spelling issues or errors.
   --fail-fast                  Exit after first file with an issue or error.
   -r, --root <root folder>     Root directory, defaults to current directory.

package/dist/esm/commandCheck.js

@@ -12,9 +12,11 @@ export function commandCheck(prog) {
         .option('--no-validate-directives', 'Do not validate in-document CSpell directives.')
         .option('--no-color', 'Turn off color.')
         .option('--color', 'Force color')
+        .option('--no-exit-code', 'Do not return an exit code if issues are found.')
         .addOption(new CommanderOption('--default-configuration', 'Load the default configuration and dictionaries.').hideHelp())
         .addOption(new CommanderOption('--no-default-configuration', 'Do not load the default configuration and dictionaries.'))
         .action(async (files, options) => {
+        const useExitCode = options.exitCode ?? true;
         App.parseApplicationFeatureFlags(options.flag);
         let issueCount = 0;
         for (const filename of files) {
@@ -41,7 +43,8 @@ export function commandCheck(prog) {
             console.log();
         }
         if (issueCount) {
-            throw new CheckFailed('Issues found', 1);
+            const exitCode = useExitCode ?? true ? 1 : 0;
+            throw new CheckFailed('Issues found', exitCode);
         }
     });
 }

package/dist/esm/commandCheck.mjs

@@ -12,9 +12,11 @@ export function commandCheck(prog) {
         .option('--no-validate-directives', 'Do not validate in-document CSpell directives.')
         .option('--no-color', 'Turn off color.')
         .option('--color', 'Force color')
+        .option('--no-exit-code', 'Do not return an exit code if issues are found.')
         .addOption(new CommanderOption('--default-configuration', 'Load the default configuration and dictionaries.').hideHelp())
         .addOption(new CommanderOption('--no-default-configuration', 'Do not load the default configuration and dictionaries.'))
         .action(async (files, options) => {
+        const useExitCode = options.exitCode ?? true;
         App.parseApplicationFeatureFlags(options.flag);
         let issueCount = 0;
         for (const filename of files) {
@@ -41,7 +43,8 @@ export function commandCheck(prog) {
             console.log();
         }
         if (issueCount) {
-            throw new CheckFailed('Issues found', 1);
+            const exitCode = useExitCode ?? true ? 1 : 0;
+            throw new CheckFailed('Issues found', exitCode);
         }
     });
 }

package/dist/esm/commandLint.js

@@ -67,6 +67,7 @@ export function commandLint(prog) {
         .option('--no-progress', 'Turn off progress messages')
         .option('--no-summary', 'Turn off summary message in console.')
         .option('-s, --silent', 'Silent mode, suppress error messages.')
+        .option('--no-exit-code', 'Do not return an exit code if issues are found.')
         .addOption(new CommanderOption('--quiet', 'Only show spelling issues or errors.').implies({
         summary: false,
         progress: false,
@@ -110,6 +111,7 @@ export function commandLint(prog) {
         .addHelpText('after', advanced)
         .arguments('[globs...]')
         .action((fileGlobs, options) => {
+        const useExitCode = options.exitCode ?? true;
         App.parseApplicationFeatureFlags(options.flag);
         const { mustFindFiles, fileList } = options;
         return App.lint(fileGlobs, options).then((result) => {
@@ -117,9 +119,13 @@ export function commandLint(prog) {
                 spellCheckCommand.outputHelp();
                 throw new CheckFailed('outputHelp', 1);
             }
-            if (result.issues || result.errors || (mustFindFiles && !result.files)) {
+            if (result.errors || (mustFindFiles && !result.files)) {
                 throw new CheckFailed('check failed', 1);
             }
+            if (result.issues) {
+                const exitCode = useExitCode ? 1 : 0;
+                throw new CheckFailed('check failed', exitCode);
+            }
             return;
         });
     });

package/dist/esm/commandLint.mjs

@@ -67,6 +67,7 @@ export function commandLint(prog) {
         .option('--no-progress', 'Turn off progress messages')
         .option('--no-summary', 'Turn off summary message in console.')
         .option('-s, --silent', 'Silent mode, suppress error messages.')
+        .option('--no-exit-code', 'Do not return an exit code if issues are found.')
         .addOption(new CommanderOption('--quiet', 'Only show spelling issues or errors.').implies({
         summary: false,
         progress: false,
@@ -110,6 +111,7 @@ export function commandLint(prog) {
         .addHelpText('after', advanced)
         .arguments('[globs...]')
         .action((fileGlobs, options) => {
+        const useExitCode = options.exitCode ?? true;
         App.parseApplicationFeatureFlags(options.flag);
         const { mustFindFiles, fileList } = options;
         return App.lint(fileGlobs, options).then((result) => {
@@ -117,9 +119,13 @@ export function commandLint(prog) {
                 spellCheckCommand.outputHelp();
                 throw new CheckFailed('outputHelp', 1);
             }
-            if (result.issues || result.errors || (mustFindFiles && !result.files)) {
+            if (result.errors || (mustFindFiles && !result.files)) {
                 throw new CheckFailed('check failed', 1);
             }
+            if (result.issues) {
+                const exitCode = useExitCode ? 1 : 0;
+                throw new CheckFailed('check failed', exitCode);
+            }
             return;
         });
     });

package/dist/esm/options.d.mts

@@ -136,6 +136,11 @@ export interface BaseOptions {
      * Check In-Document CSpell directives for correctness.
      */
     validateDirectives?: boolean;
+    /**
+     * Return an exit code if there are issues found.
+     * @default true
+     */
+    exitCode?: boolean;
     /**
      * Execution flags.
      * Used primarily for releasing experimental features.

package/dist/esm/options.d.ts

@@ -136,6 +136,11 @@ export interface BaseOptions {
      * Check In-Document CSpell directives for correctness.
      */
     validateDirectives?: boolean;
+    /**
+     * Return an exit code if there are issues found.
+     * @default true
+     */
+    exitCode?: boolean;
     /**
      * Execution flags.
      * Used primarily for releasing experimental features.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "7.3.5",
+  "version": "7.3.7",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "bin": {
@@ -80,20 +80,20 @@
   },
   "homepage": "https://streetsidesoftware.github.io/cspell/",
   "dependencies": {
-    "@cspell/cspell-json-reporter": "7.3.5",
-    "@cspell/cspell-pipe": "7.3.5",
-    "@cspell/cspell-types": "7.3.5",
-    "@cspell/dynamic-import": "7.3.5",
+    "@cspell/cspell-json-reporter": "7.3.7",
+    "@cspell/cspell-pipe": "7.3.7",
+    "@cspell/cspell-types": "7.3.7",
+    "@cspell/dynamic-import": "7.3.7",
     "chalk": "^5.3.0",
     "chalk-template": "^1.1.0",
     "commander": "^11.0.0",
-    "cspell-gitignore": "7.3.5",
-    "cspell-glob": "7.3.5",
-    "cspell-io": "7.3.5",
-    "cspell-lib": "7.3.5",
+    "cspell-gitignore": "7.3.7",
+    "cspell-glob": "7.3.7",
+    "cspell-io": "7.3.7",
+    "cspell-lib": "7.3.7",
     "fast-glob": "^3.3.1",
     "fast-json-stable-stringify": "^2.1.0",
-    "file-entry-cache": "^6.0.1",
+    "file-entry-cache": "^7.0.0",
     "get-stdin": "^9.0.0",
     "semver": "^7.5.4",
     "strip-ansi": "^7.1.0",
@@ -105,10 +105,10 @@
   "devDependencies": {
     "@types/file-entry-cache": "^5.0.2",
     "@types/glob": "^8.1.0",
-    "@types/micromatch": "^4.0.2",
-    "@types/semver": "^7.5.1",
+    "@types/micromatch": "^4.0.3",
+    "@types/semver": "^7.5.3",
     "micromatch": "^4.0.5",
     "minimatch": "^9.0.3"
   },
-  "gitHead": "23fb2fbae335526185ab53a22e0cac0f3e8f1a25"
+  "gitHead": "22246a7924b9ae27ae39f0d0217890a1c2736f68"
 }