cspell 8.17.1 → 8.17.3

package/README.md

@@ -145,8 +145,8 @@ Options:
   -u, --unique                 Only output the first instance of a word not
                                found in the dictionaries.
   -e, --exclude <glob>         Exclude files matching the glob pattern. This
-                               option can be used multiple times to add
-                               multiple globs.
+                               option can be used multiple times to add multiple
+                               globs.
   --file-list <path or stdin>  Specify a list of files to be spell checked. The
                                list is filtered against the glob file patterns.
                                Note: the format is 1 file path per line.
@@ -179,8 +179,7 @@ Options:
   --gitignore                  Ignore files matching glob patterns found in
                                .gitignore files.
   --no-gitignore               Do NOT use .gitignore files.
-  --gitignore-root <path>      Prevent searching for .gitignore files past
-                               root.
+  --gitignore-root <path>      Prevent searching for .gitignore files past root.
   --validate-directives        Validate in-document CSpell directives.
   --color                      Force color.
   --no-color                   Turn off color.
@@ -259,8 +258,8 @@ Trace words -- Search for words in the configuration and dictionaries.
 Options:
   -c, --config <cspell.json>  Configuration file to use.  By default cspell
                               looks for cspell.json in the current directory.
-  --locale <locale>           Set language locales. i.e. "en,fr" for English
-                              and French, or "en-GB" for British English.
+  --locale <locale>           Set language locales. i.e. "en,fr" for English and
+                              French, or "en-GB" for British English.
   --language-id <language>    Use programming language. i.e. "php" or "scala".
   --allow-compound-words      Turn on allowCompoundWords
   --no-allow-compound-words   Turn off allowCompoundWords
@@ -315,7 +314,7 @@ exec git diff --cached --name-only | npx cspell --no-summary --no-progress --no-
 
 ## Requirements
 
-cspell needs Node 14 and above.
+CSpell needs Node 18 and above.
 
 ## How it works
 

package/bin.mjs

@@ -3,16 +3,17 @@ import { format } from 'node:util';
 
 import { CommanderError, program } from 'commander';
 
-import * as app from './dist/esm/app.mjs';
+import { ApplicationError, CheckFailed, run } from './dist/esm/app.mjs';
 
-app.run(program, process.argv).catch((e) => {
-    if (!(e instanceof CommanderError) && !(e instanceof app.CheckFailed)) {
-        const msg = e instanceof app.ApplicationError ? e.message : format(e);
+run(program, process.argv).catch((e) => {
+    if (!(e instanceof CommanderError) && !(e instanceof CheckFailed)) {
+        const verbose = process.argv.includes('--verbose') || process.argv.includes('-v');
+        const msg = !verbose && e instanceof ApplicationError ? e.message : format(e);
         process.stdout.write(msg + '\n');
         // It is possible an explicit exit code was set, use it if it was.
         process.exitCode = process.exitCode || 1;
     }
-    if (e instanceof app.CheckFailed) {
+    if (e instanceof CheckFailed) {
         process.exitCode = e.exitCode;
     }
 });

package/dist/esm/commandLint.js

@@ -205,14 +205,15 @@ function augmentCommandHelp(context) {
     const showHidden = !!opts.verbose;
     const hiddenHelp = [];
     const help = command.createHelp();
+    help.helpWidth = process.stdout.columns || 80;
     const hiddenOptions = command.options.filter((opt) => opt.hidden && showHidden);
     const flagColWidth = Math.max(...command.options.map((opt) => opt.flags.length), 0);
-    const indent = flagColWidth + 4;
+    // const indent = flagColWidth + 4;
     for (const options of hiddenOptions) {
         if (!hiddenHelp.length) {
             hiddenHelp.push('\nHidden Options:');
         }
-        hiddenHelp.push(help.wrap(`  ${options.flags.padEnd(flagColWidth)}  ${options.description}`, process.stdout.columns || 80, indent));
+        hiddenHelp.push(help.formatItem(options.flags, flagColWidth, options.description, help));
     }
     output.push(...hiddenHelp, advanced);
     return helpIssueTemplate(opts) + output.join('\n');

package/dist/esm/lint/lint.d.ts

@@ -1,4 +1,8 @@
 import type { RunResult } from '@cspell/cspell-types';
 import type { LintRequest } from './LintRequest.js';
 export declare function runLint(cfg: LintRequest): Promise<RunResult>;
+export declare class LinterError extends Error {
+    constructor(message: string);
+    toString(): string;
+}
 //# sourceMappingURL=lint.d.ts.map

package/dist/esm/lint/lint.js

@@ -88,7 +88,7 @@ export async function runLint(cfg) {
         const fileInfo = prefetch?.fileInfo || (await readFileInfo(filename, undefined, true));
         if (fileInfo.errorCode) {
             if (fileInfo.errorCode !== 'EISDIR' && cfg.options.mustFindFiles) {
-                const err = toError(`File not found: "${filename}"`);
+                const err = new LinterError(`File not found: "${filename}"`);
                 reporter.error('Linter:', err);
                 result.errors += 1;
             }
@@ -541,4 +541,12 @@ async function writeDictionaryLog() {
 function globPattern(g) {
     return typeof g === 'string' ? g : g.glob;
 }
+export class LinterError extends Error {
+    constructor(message) {
+        super(message);
+    }
+    toString() {
+        return this.message;
+    }
+}
 //# sourceMappingURL=lint.js.map

package/dist/esm/pkgInfo.d.ts

@@ -1,6 +1,6 @@
 export { pkgDir } from './dirname.js';
 export declare const name = "cspell";
-export declare const version = "8.17.1";
+export declare const version = "8.17.3";
 export declare const engines: {
     node: string;
 };

package/dist/esm/pkgInfo.js

@@ -1,7 +1,7 @@
 // This file is generated by tools/patch-version.mjs
 export { pkgDir } from './dirname.js';
 export const name = 'cspell';
-export const version = '8.17.1';
+export const version = '8.17.3';
 export const engines = { node: '>=18' };
 export const npmPackage = { name, version, engines };
 //# sourceMappingURL=pkgInfo.js.map

package/dist/esm/util/cache/createCache.js

@@ -1,7 +1,7 @@
 import assert from 'node:assert';
 import { stat } from 'node:fs/promises';
 import path from 'node:path';
-import { isError } from '../errors.js';
+import { isErrorLike } from '../errors.js';
 import { DiskCache } from './DiskCache.js';
 import { DummyCache } from './DummyCache.js';
 // cspell:word cspellcache
@@ -47,7 +47,7 @@ async function resolveCacheLocation(cacheLocation) {
         return path.join(cacheLocation, DEFAULT_CACHE_LOCATION);
     }
     catch (err) {
-        if (isError(err) && err.code === 'ENOENT') {
+        if (isErrorLike(err) && err.code === 'ENOENT') {
             return cacheLocation;
         }
         throw err;

package/dist/esm/util/errors.d.ts

@@ -15,6 +15,7 @@ export declare class IOError extends ApplicationError {
 }
 export declare function toError(e: unknown): NodeError;
 export declare function isError(e: unknown): e is NodeError;
+export declare function isErrorLike(e: unknown): e is NodeError;
 export declare function toApplicationError(e: unknown, message?: string): ApplicationError;
 export interface NodeError extends Error {
     code?: string;

package/dist/esm/util/errors.js

@@ -31,14 +31,19 @@ export class IOError extends ApplicationError {
 export function toError(e) {
     if (isError(e))
         return e;
+    if (isErrorLike(e)) {
+        const ex = new Error(e.message, { cause: e });
+        if (e.code !== undefined)
+            ex.code = e.code;
+        return ex;
+    }
     const message = format(e);
-    return {
-        name: 'error',
-        message,
-        toString: () => message,
-    };
+    return new Error(message);
 }
 export function isError(e) {
+    return e instanceof Error;
+}
+export function isErrorLike(e) {
     if (e instanceof Error)
         return true;
     if (!e || typeof e !== 'object')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "8.17.1",
+  "version": "8.17.3",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "bin": {
@@ -81,19 +81,19 @@
   },
   "homepage": "https://cspell.org/",
   "dependencies": {
-    "@cspell/cspell-json-reporter": "8.17.1",
-    "@cspell/cspell-pipe": "8.17.1",
-    "@cspell/cspell-types": "8.17.1",
-    "@cspell/dynamic-import": "8.17.1",
-    "@cspell/url": "8.17.1",
-    "chalk": "^5.3.0",
+    "@cspell/cspell-json-reporter": "8.17.3",
+    "@cspell/cspell-pipe": "8.17.3",
+    "@cspell/cspell-types": "8.17.3",
+    "@cspell/dynamic-import": "8.17.3",
+    "@cspell/url": "8.17.3",
+    "chalk": "^5.4.1",
     "chalk-template": "^1.1.0",
-    "commander": "^12.1.0",
-    "cspell-dictionary": "8.17.1",
-    "cspell-gitignore": "8.17.1",
-    "cspell-glob": "8.17.1",
-    "cspell-io": "8.17.1",
-    "cspell-lib": "8.17.1",
+    "commander": "^13.1.0",
+    "cspell-dictionary": "8.17.3",
+    "cspell-gitignore": "8.17.3",
+    "cspell-glob": "8.17.3",
+    "cspell-io": "8.17.3",
+    "cspell-lib": "8.17.3",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^9.1.0",
     "get-stdin": "^9.0.0",
@@ -111,5 +111,5 @@
     "micromatch": "^4.0.8",
     "minimatch": "^9.0.5"
   },
-  "gitHead": "476a03accde11d8bb97c2fd09322f962c83b116a"
+  "gitHead": "9a0d2b4584112b33d137faa98e9931ad4e7b6050"
 }