cspell 5.13.2 → 5.14.0

package/README.md

@@ -69,7 +69,7 @@ cspell lint --help
 ### Options
 
 ```text
-Usage: cspell lint [options] [files...]
+Usage: cspell lint [options] [globs...]
 
 Check spelling
 
@@ -77,8 +77,8 @@ Options:
   -c, --config <cspell.json>   Configuration file to use.  By default cspell
                                looks for cspell.json in the current directory.
 
-  -v, --verbose                display more information about the files being
-                               checked and the configuration
+  -v, --verbose                Display more information about the files being
+                               checked and the configuration.
 
   --locale <locale>            Set language locales. i.e. "en,fr" for English
                                and French, or "en-GB" for British English.
@@ -92,28 +92,30 @@ Options:
   -u, --unique                 Only output the first instance of a word not
                                found in the dictionaries.
 
-  --debug                      Output information useful for debugging
-                               cspell.json files.
-
   -e, --exclude <glob>         Exclude files matching the glob pattern. This
                                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.
+
   --no-issues                  Do not show the spelling errors.
   --no-progress                Turn off progress messages
-  --no-summary                 Turn off summary message in console
-  -s, --silent                 Silent mode, suppress error messages
+  --no-summary                 Turn off summary message in console.
+  -s, --silent                 Silent mode, suppress error messages.
   -r, --root <root folder>     Root directory, defaults to current directory.
   --relative                   Issues are displayed relative to root.
   --show-context               Show the surrounding text around an issue.
   --show-suggestions           Show spelling suggestions.
-  --no-must-find-files         Do not error if no files are found
+  --no-must-find-files         Do not error if no files are found.
 
-  --cache                      Only check changed files (default: false)
-  --cache-strategy <strategy>  Strategy to use for detecting changed files
+  --cache                      Only check changed files. (default: false)
+
+  --cache-strategy <strategy>  Strategy to use for detecting changed files.
                                (choices: "metadata", "content")
 
-  --cache-location <path>      Path to the cache file or directory (default:
+  --cache-location <path>      Path to the cache file or directory. (default:
                                ".cspellcache")
 
   --dot                        Include files and directories starting with `.`
@@ -128,7 +130,9 @@ Options:
                                root.
 
   --no-color                   Turn off color.
-  --color                      Force color
+  --color                      Force color.
+  --debug                      Output information useful for debugging
+                               cspell.json files.
   -h, --help                   display help for command
 
 
@@ -196,8 +200,7 @@ npm install -SD cspell
 ```
 #!/bin/sh
 
-files=$(git diff --cached --name-only)
-exec npx cspell -- --no-summary $files
+exec git diff --cached --name-only | npx cspell -- --no-summary --no-progress --no-must-find-files --file-list stdin
 ```
 
 ## Requirements

package/dist/app.d.ts

@@ -1,5 +1,5 @@
 import * as commander from 'commander';
-export { LinterCliOptions as Options } from './commandLint';
+export { LinterCliOptions as Options } from './options';
 export { CheckFailed } from './util/errors';
 export declare function run(program?: commander.Command, argv?: string[]): Promise<void>;
 //# sourceMappingURL=app.d.ts.map

package/dist/app.js

@@ -22,19 +22,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.run = exports.CheckFailed = void 0;
 const commander = __importStar(require("commander"));
 const path = __importStar(require("path"));
+const semver = __importStar(require("semver"));
 const commandCheck_1 = require("./commandCheck");
 const commandLink_1 = require("./commandLink");
 const commandLint_1 = require("./commandLint");
 const commandTrace_1 = require("./commandTrace");
+const errors_1 = require("./util/errors");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const npmPackage = require(path.join(__dirname, '..', 'package.json'));
-var errors_1 = require("./util/errors");
-Object.defineProperty(exports, "CheckFailed", { enumerable: true, get: function () { return errors_1.CheckFailed; } });
+var errors_2 = require("./util/errors");
+Object.defineProperty(exports, "CheckFailed", { enumerable: true, get: function () { return errors_2.CheckFailed; } });
 async function run(program, argv) {
     const prog = program || commander.program;
     const args = argv || process.argv;
     prog.exitOverride();
     prog.version(npmPackage.version).description('Spelling Checker for Code').name('cspell');
+    if (!semver.satisfies(process.versions.node, npmPackage.engines.node)) {
+        throw new errors_1.ApplicationError(`Unsupported NodeJS version (${process.versions.node}); ${npmPackage.engines.node} is required`);
+    }
     (0, commandLint_1.commandLint)(prog);
     (0, commandTrace_1.commandTrace)(prog);
     (0, commandCheck_1.commandCheck)(prog);

package/dist/application.d.ts

@@ -5,7 +5,7 @@ import { BaseOptions, LinterOptions, TraceOptions } from './options';
 export { IncludeExcludeFlag } from 'cspell-lib';
 export type { TraceResult } from 'cspell-lib';
 export declare type AppError = NodeJS.ErrnoException;
-export declare function lint(files: string[], options: LinterOptions, emitters: CSpellReporter): Promise<RunResult>;
+export declare function lint(fileGlobs: string[], options: LinterOptions, emitters: CSpellReporter): Promise<RunResult>;
 export declare function trace(words: string[], options: TraceOptions): Promise<TraceResult[]>;
 export declare type CheckTextResult = CheckTextInfo;
 export declare function checkText(filename: string, options: BaseOptions): Promise<CheckTextResult>;

package/dist/application.js

@@ -28,8 +28,8 @@ const lint_1 = require("./lint");
 const util = __importStar(require("./util/util"));
 var cspell_lib_2 = require("cspell-lib");
 Object.defineProperty(exports, "IncludeExcludeFlag", { enumerable: true, get: function () { return cspell_lib_2.IncludeExcludeFlag; } });
-function lint(files, options, emitters) {
-    const cfg = new lint_1.LintRequest(files, options, emitters);
+function lint(fileGlobs, options, emitters) {
+    const cfg = new lint_1.LintRequest(fileGlobs, options, emitters);
     return (0, lint_1.runLint)(cfg);
 }
 exports.lint = lint;

package/dist/cli-reporter.d.ts

@@ -1,9 +1,12 @@
 import type { CSpellReporter, Issue } from '@cspell/cspell-types';
-import { Options } from './app';
+import { LinterCliOptions } from './options';
 export interface ReporterIssue extends Issue {
     filename: string;
 }
-export declare function getReporter(options: Options): CSpellReporter;
+export interface ReporterOptions extends Pick<LinterCliOptions, 'debug' | 'issues' | 'legacy' | 'progress' | 'relative' | 'root' | 'showContext' | 'showSuggestions' | 'silent' | 'summary' | 'verbose' | 'wordsOnly'> {
+    fileGlobs: string[];
+}
+export declare function getReporter(options: ReporterOptions): CSpellReporter;
 declare function formatIssue(templateStr: string, issue: ReporterIssue, maxIssueTextWidth: number): string;
 export declare const __testing__: {
     formatIssue: typeof formatIssue;

package/dist/cli-reporter.js

@@ -98,7 +98,7 @@ function getReporter(options) {
                 : options.showSuggestions
                     ? templateIssueWithSuggestions
                     : templateIssue;
-    const { files, silent, summary, issues, progress, verbose, debug } = options;
+    const { fileGlobs, silent, summary, issues, progress, verbose, debug } = options;
     const emitters = {
         Debug: !silent && debug ? (s) => console.info(chalk.cyan(s)) : nullEmitter,
         Info: !silent && verbose ? (s) => console.info(chalk.yellow(s)) : nullEmitter,
@@ -121,7 +121,7 @@ function getReporter(options) {
         };
     }
     const resultEmitter = (result) => {
-        if (!files.length && !result.files) {
+        if (!fileGlobs.length && !result.files) {
             return;
         }
         console.error('CSpell: Files checked: %d, Issues found: %d in %d files', result.files, result.issues, result.filesWithIssues.size);

package/dist/commandLint.d.ts

@@ -1,17 +1,3 @@
 import { Command } from 'commander';
-import { LinterOptions } from './options';
-export interface LinterCliOptions extends LinterOptions {
-    files: string[];
-    legacy?: boolean;
-    summary: boolean;
-    issues: boolean;
-    silent: boolean;
-    mustFindFiles: boolean;
-    progress?: boolean;
-    /**
-     * issues are shown with a relative path to the root or `cwd`
-     */
-    relative?: boolean;
-}
 export declare function commandLint(prog: Command): Command;
 //# sourceMappingURL=commandLint.d.ts.map

package/dist/commandLint.js

@@ -47,50 +47,53 @@ function commandLint(prog) {
     spellCheckCommand
         .description('Check spelling')
         .option('-c, --config <cspell.json>', 'Configuration file to use.  By default cspell looks for cspell.json in the current directory.')
-        .option('-v, --verbose', 'display more information about the files being checked and the configuration')
+        .option('-v, --verbose', 'Display more information about the files being checked and the configuration.')
         .option('--locale <locale>', 'Set language locales. i.e. "en,fr" for English and French, or "en-GB" for British English.')
         .option('--language-id <language>', 'Force programming language for unknown extensions. i.e. "php" or "scala"')
         .addOption(new commander_1.Option('--languageId <language>', 'Force programming language for unknown extensions. i.e. "php" or "scala"').hideHelp())
         .option('--words-only', 'Only output the words not found in the dictionaries.')
         .addOption(new commander_1.Option('--wordsOnly', 'Only output the words not found in the dictionaries.').hideHelp())
         .option('-u, --unique', 'Only output the first instance of a word not found in the dictionaries.')
-        .option('--debug', 'Output information useful for debugging cspell.json files.')
         .option('-e, --exclude <glob>', 'Exclude files matching the glob pattern. This option can be used multiple times to add multiple globs. ', collect)
+        .option('--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.', collect)
         .option('--no-issues', 'Do not show the spelling errors.')
         .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-summary', 'Turn off summary message in console.')
+        .option('-s, --silent', 'Silent mode, suppress error messages.')
         .option('-r, --root <root folder>', 'Root directory, defaults to current directory.')
         .option('--relative', 'Issues are displayed relative to root.')
         .option('--show-context', 'Show the surrounding text around an issue.')
         .option('--show-suggestions', 'Show spelling suggestions.')
-        .addOption(new commander_1.Option('--must-find-files', 'Error if no files are found').default(true).hideHelp())
-        .option('--no-must-find-files', 'Do not error if no files are found')
+        .addOption(new commander_1.Option('--must-find-files', 'Error if no files are found.').default(true).hideHelp())
+        .option('--no-must-find-files', 'Do not error if no files are found.')
         // The following options are planned features
         // .option('-w, --watch', 'Watch for any changes to the matching files and report any errors')
         // .option('--force', 'Force the exit value to always be 0')
-        .option('--legacy', 'Legacy output')
+        .addOption(new commander_1.Option('--legacy', 'Legacy output').hideHelp())
         .addOption(new commander_1.Option('--local <local>', 'Deprecated -- Use: --locale').hideHelp())
-        .option('--cache', 'Only check changed files', false)
-        .addOption(new commander_1.Option('--cache-strategy <strategy>', 'Strategy to use for detecting changed files').choices([
+        .option('--cache', 'Only check changed files.', false)
+        .addOption(new commander_1.Option('--cache-strategy <strategy>', 'Strategy to use for detecting changed files.').choices([
         'metadata',
         'content',
     ]))
-        .option('--cache-location <path>', `Path to the cache file or directory`, cache_1.DEFAULT_CACHE_LOCATION)
+        .option('--cache-location <path>', `Path to the cache file or directory.`, cache_1.DEFAULT_CACHE_LOCATION)
         .option('--dot', 'Include files and directories starting with `.` (period) when matching globs.')
         .option('--gitignore', 'Ignore files matching glob patterns found in .gitignore files.')
         .option('--no-gitignore', 'Do NOT use .gitignore files.')
         .option('--gitignore-root <path>', 'Prevent searching for .gitignore files past root.', collect)
         .option('--no-color', 'Turn off color.')
-        .option('--color', 'Force color')
+        .option('--color', 'Force color.')
+        .option('--debug', 'Output information useful for debugging cspell.json files.')
         .addHelpText('after', usage)
-        .arguments('[files...]')
-        .action((files, options) => {
-        options.files = files;
-        const { mustFindFiles } = options;
-        const cliReporter = (0, cli_reporter_1.getReporter)(options);
-        return App.lint(files, options, cliReporter).then((result) => {
-            if (!files.length && !result.files) {
+        .arguments('[globs...]')
+        .action((fileGlobs, options) => {
+        const { mustFindFiles, fileList } = options;
+        const cliReporter = (0, cli_reporter_1.getReporter)({ ...options, fileGlobs });
+        const lintOptions = { ...options, fileLists: fileList };
+        return App.lint(fileGlobs, lintOptions, cliReporter).then((result) => {
+            if (!fileGlobs.length && !result.files && !result.errors && !fileList) {
                 spellCheckCommand.outputHelp();
                 throw new errors_1.CheckFailed('outputHelp', 1);
             }

package/dist/fileHelper.d.ts

@@ -33,4 +33,18 @@ export declare function readFile(filename: string, encoding?: string): Promise<s
  */
 export declare function findFiles(globPatterns: string[], options: GlobOptions): Promise<string[]>;
 export declare function calcFinalConfigInfo(configInfo: ConfigInfo, settingsFromCommandLine: CSpellUserSettings, filename: string, text: string): FileConfigInfo;
+/**
+ * Read
+ * @param listFiles - array of file paths to read that will contain a list of files. Paths contained in each
+ *   file will be resolved relative to the containing file.
+ * @returns - a list of files to be processed.
+ */
+export declare function readFileListFiles(listFiles: string[]): Promise<string[]>;
+/**
+ * Read a `listFile` and return the containing file paths resolved relative to the `listFile`.
+ * @param listFiles - array of file paths to read that will contain a list of files. Paths contained in each
+ *   file will be resolved relative to the containing file.
+ * @returns - a list of files to be processed.
+ */
+export declare function readFileListFile(listFile: string): Promise<string[]>;
 //# sourceMappingURL=fileHelper.d.ts.map

package/dist/fileHelper.js

@@ -22,13 +22,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calcFinalConfigInfo = exports.findFiles = exports.readFile = exports.readFileInfo = exports.fileInfoToDocument = exports.readConfig = void 0;
+exports.readFileListFile = exports.readFileListFiles = exports.calcFinalConfigInfo = exports.findFiles = exports.readFile = exports.readFileInfo = exports.fileInfoToDocument = exports.readConfig = void 0;
 const cspell = __importStar(require("cspell-lib"));
 const fsp = __importStar(require("fs-extra"));
 const get_stdin_1 = __importDefault(require("get-stdin"));
 const glob_1 = require("./util/glob");
 const path = __importStar(require("path"));
 const cspell_lib_1 = require("cspell-lib");
+const errors_1 = require("./util/errors");
 const UTF8 = 'utf8';
 const STDIN = 'stdin';
 async function readConfig(configFile, root) {
@@ -61,10 +62,7 @@ function readFileInfo(filename, encoding = UTF8) {
     return pText.then((text) => ({ text, filename }), (error) => {
         return error.code === 'EISDIR'
             ? Promise.resolve({ text: '', filename })
-            : Promise.reject({
-                ...error,
-                message: `Error reading file: "${filename}"`,
-            });
+            : Promise.reject((0, errors_1.toApplicationError)(error, `Error reading file: "${filename}"`));
     });
 }
 exports.readFileInfo = readFileInfo;
@@ -98,4 +96,44 @@ function calcFinalConfigInfo(configInfo, settingsFromCommandLine, filename, text
     };
 }
 exports.calcFinalConfigInfo = calcFinalConfigInfo;
+/**
+ * Read
+ * @param listFiles - array of file paths to read that will contain a list of files. Paths contained in each
+ *   file will be resolved relative to the containing file.
+ * @returns - a list of files to be processed.
+ */
+async function readFileListFiles(listFiles) {
+    return flatten(await Promise.all(listFiles.map(readFileListFile)));
+}
+exports.readFileListFiles = readFileListFiles;
+/**
+ * Read a `listFile` and return the containing file paths resolved relative to the `listFile`.
+ * @param listFiles - array of file paths to read that will contain a list of files. Paths contained in each
+ *   file will be resolved relative to the containing file.
+ * @returns - a list of files to be processed.
+ */
+async function readFileListFile(listFile) {
+    try {
+        const relTo = path.resolve(path.dirname(listFile));
+        const content = await readFile(listFile);
+        const lines = content
+            .split('\n')
+            .map((a) => a.trim())
+            .filter((a) => !!a)
+            .map((file) => path.resolve(relTo, file));
+        return lines;
+    }
+    catch (err) {
+        throw (0, errors_1.toApplicationError)(err, `Error reading file list from: "${listFile}"`);
+    }
+}
+exports.readFileListFile = readFileListFile;
+function flatten(fileLists) {
+    function* f() {
+        for (const list of fileLists) {
+            yield* list;
+        }
+    }
+    return [...f()];
+}
 //# sourceMappingURL=fileHelper.js.map

package/dist/lint/LintRequest.d.ts

@@ -2,7 +2,7 @@ import type { CSpellReporter, Issue } from '@cspell/cspell-types';
 import { LinterOptions } from '../options';
 import { GlobSrcInfo } from '../util/glob';
 export declare class LintRequest {
-    readonly files: string[];
+    readonly fileGlobs: string[];
     readonly options: LinterOptions;
     readonly reporter: CSpellReporter;
     readonly uniqueFilter: (issue: Issue) => boolean;
@@ -12,6 +12,7 @@ export declare class LintRequest {
     readonly root: string;
     readonly showContext: number;
     readonly enableGlobDot: boolean | undefined;
-    constructor(files: string[], options: LinterOptions, reporter: CSpellReporter);
+    readonly fileLists: string[];
+    constructor(fileGlobs: string[], options: LinterOptions, reporter: CSpellReporter);
 }
 //# sourceMappingURL=LintRequest.d.ts.map

package/dist/lint/LintRequest.js

@@ -25,8 +25,8 @@ const glob_1 = require("../util/glob");
 const util = __importStar(require("../util/util"));
 const defaultContextRange = 20;
 class LintRequest {
-    constructor(files, options, reporter) {
-        this.files = files;
+    constructor(fileGlobs, options, reporter) {
+        this.fileGlobs = fileGlobs;
         this.options = options;
         this.reporter = reporter;
         this.root = path.resolve(options.root || process.cwd());
@@ -37,6 +37,7 @@ class LintRequest {
         this.uniqueFilter = options.unique ? util.uniqueFilterFnGenerator((issue) => issue.text) : () => true;
         this.showContext =
             options.showContext === true ? defaultContextRange : options.showContext ? options.showContext : 0;
+        this.fileLists = options.fileLists || [];
     }
 }
 exports.LintRequest = LintRequest;

package/dist/lint/lint.js

@@ -23,6 +23,7 @@ exports.runLint = void 0;
 const cspell_types_1 = require("@cspell/cspell-types");
 const commentJson = __importStar(require("comment-json"));
 const cspell_gitignore_1 = require("cspell-gitignore");
+const cspell_glob_1 = require("cspell-glob");
 const cspell = __importStar(require("cspell-lib"));
 const path = __importStar(require("path"));
 const util_1 = require("util");
@@ -36,6 +37,7 @@ const timer_1 = require("../util/timer");
 const util = __importStar(require("../util/util"));
 async function runLint(cfg) {
     let { reporter } = cfg;
+    const { fileLists } = cfg;
     cspell.setLogger(getLoggerFromReporter(reporter));
     const configErrors = new Set();
     const lintResult = await run();
@@ -175,7 +177,7 @@ async function runLint(cfg) {
         const useGitignore = (_b = (_a = cfg.options.gitignore) !== null && _a !== void 0 ? _a : configInfo.config.useGitignore) !== null && _b !== void 0 ? _b : false;
         const gitignoreRoots = (_c = cfg.options.gitignoreRoot) !== null && _c !== void 0 ? _c : configInfo.config.gitignoreRoot;
         const gitIgnore = useGitignore ? await generateGitIgnore(gitignoreRoots) : undefined;
-        const cliGlobs = cfg.files;
+        const cliGlobs = cfg.fileGlobs;
         const allGlobs = cliGlobs.length ? cliGlobs : configInfo.config.files || [];
         const combinedGlobs = (0, glob_1.normalizeGlobsToRoot)(allGlobs, cfg.root, false);
         const cliExcludeGlobs = (0, glob_1.extractPatterns)(cfg.excludes).map((p) => p.glob);
@@ -183,7 +185,8 @@ async function runLint(cfg) {
         const includeGlobs = combinedGlobs.filter((g) => !g.startsWith('!'));
         const excludeGlobs = combinedGlobs.filter((g) => g.startsWith('!')).concat(normalizedExcludes);
         const fileGlobs = includeGlobs;
-        if (!fileGlobs.length) {
+        const hasFileLists = !!fileLists.length;
+        if (!fileGlobs.length && !hasFileLists) {
             // Nothing to do.
             return runResult();
         }
@@ -208,10 +211,19 @@ async function runLint(cfg) {
         if (enableGlobDot !== undefined) {
             globOptions.dot = enableGlobDot;
         }
-        const foundFiles = await (0, fileHelper_1.findFiles)(fileGlobs, globOptions);
-        const filtered = gitIgnore ? await gitIgnore.filterOutIgnored(foundFiles) : foundFiles;
-        const files = filterFiles(filtered, globMatcher);
-        return processFiles(files, configInfo, files.length);
+        try {
+            const foundFiles = await (hasFileLists
+                ? useFileLists(fileLists, allGlobs, root, enableGlobDot)
+                : (0, fileHelper_1.findFiles)(fileGlobs, globOptions));
+            const filtered = gitIgnore ? await gitIgnore.filterOutIgnored(foundFiles) : foundFiles;
+            const files = filterFiles(filtered, globMatcher);
+            return await processFiles(files, configInfo, files.length);
+        }
+        catch (e) {
+            const err = (0, errors_1.toApplicationError)(e);
+            reporter.error('Linter', err);
+            return runResult({ errors: 1 });
+        }
     }
     function header(files, cliExcludes) {
         const formattedFiles = files.length > 100 ? files.slice(0, 100).concat(['...']) : files;
@@ -227,13 +239,13 @@ Options:
     unique:    ${yesNo(!!cfg.options.unique)}
 `, cspell_types_1.MessageTypes.Info);
     }
-    function isExcluded(filename, globMatcher) {
+    function isExcluded(filename, globMatcherExclude) {
         if (cspell.isBinaryFile(vscode_uri_1.URI.file(filename))) {
             return true;
         }
         const { root } = cfg;
         const absFilename = path.resolve(root, filename);
-        const r = globMatcher.matchEx(absFilename);
+        const r = globMatcherExclude.matchEx(absFilename);
         if (r.matched) {
             const { glob, source } = extractGlobSource(r.pattern);
             reporter.info(`Excluded File: ${path.relative(root, absFilename)}; Excluded by ${glob} from ${source}`, cspell_types_1.MessageTypes.Info);
@@ -247,14 +259,14 @@ Options:
             source,
         };
     }
-    function filterFiles(files, globMatcher) {
-        const patterns = globMatcher.patterns;
+    function filterFiles(files, globMatcherExclude) {
+        const patterns = globMatcherExclude.patterns;
         const excludeInfo = patterns
             .map(extractGlobSource)
             .map(({ glob, source }) => `Glob: ${glob} from ${source}`)
             .filter(util.uniqueFn());
         reporter.info(`Exclusion Globs: \n    ${excludeInfo.join('\n    ')}\n`, cspell_types_1.MessageTypes.Info);
-        const result = files.filter(util.uniqueFn()).filter((filename) => !isExcluded(filename, globMatcher));
+        const result = files.filter(util.uniqueFn()).filter((filename) => !isExcluded(filename, globMatcherExclude));
         return result;
     }
 }
@@ -323,4 +335,14 @@ async function generateGitIgnore(roots) {
     }
     return new cspell_gitignore_1.GitIgnore(root === null || root === void 0 ? void 0 : root.map((p) => path.resolve(p)));
 }
+async function useFileLists(fileListFiles, includeGlobPatterns, root, dot) {
+    includeGlobPatterns = includeGlobPatterns.length ? includeGlobPatterns : ['**'];
+    const options = { root, mode: 'include' };
+    if (dot !== undefined) {
+        options.dot = dot;
+    }
+    const globMatcher = new cspell_glob_1.GlobMatcher(includeGlobPatterns, options);
+    const files = await (0, fileHelper_1.readFileListFiles)(fileListFiles);
+    return files.filter((file) => globMatcher.match(file));
+}
 //# sourceMappingURL=lint.js.map

package/dist/options.d.ts

@@ -48,6 +48,12 @@ export interface LinterOptions extends BaseOptions, CacheOptions {
      * Stop searching for a `.gitignore`s when a root is reached.
      */
     gitignoreRoot?: string | string[];
+    /**
+     * List of files that contains the paths to files to be spell checked.
+     * The files in the lists will be filtered against the glob patterns.
+     * - an entry of `stdin` means to read the file list from **`stdin`**
+     */
+    fileLists?: string[] | undefined;
 }
 export interface TraceOptions extends BaseOptions {
     allowCompoundWords?: boolean;
@@ -59,4 +65,20 @@ export interface BaseOptions {
     locale?: string;
     local?: string;
 }
+export interface LinterCliOptions extends Omit<LinterOptions, 'fileLists'> {
+    legacy?: boolean;
+    summary: boolean;
+    issues: boolean;
+    silent: boolean;
+    mustFindFiles: boolean;
+    progress?: boolean;
+    /**
+     * issues are shown with a relative path to the root or `cwd`
+     */
+    relative?: boolean;
+    /**
+     * List of file paths to files that contains a list of files to be spell checked.
+     */
+    fileList?: string[];
+}
 //# sourceMappingURL=options.d.ts.map

package/dist/util/errors.d.ts

@@ -4,8 +4,10 @@ export declare class CheckFailed extends Error {
 }
 export declare class ApplicationError extends Error {
     readonly exitCode: number;
-    constructor(message: string, exitCode?: number);
+    readonly cause?: Error | undefined;
+    constructor(message: string, exitCode?: number, cause?: Error | undefined);
 }
 export declare function toError(e: unknown): Error;
 export declare function isError(e: unknown): e is Error;
+export declare function toApplicationError(e: unknown, message?: string): ApplicationError;
 //# sourceMappingURL=errors.d.ts.map

package/dist/util/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isError = exports.toError = exports.ApplicationError = exports.CheckFailed = void 0;
+exports.toApplicationError = exports.isError = exports.toError = exports.ApplicationError = exports.CheckFailed = void 0;
 const util_1 = require("util");
 class CheckFailed extends Error {
     constructor(message, exitCode = 1) {
@@ -10,9 +10,10 @@ class CheckFailed extends Error {
 }
 exports.CheckFailed = CheckFailed;
 class ApplicationError extends Error {
-    constructor(message, exitCode = 1) {
+    constructor(message, exitCode = 1, cause) {
         super(message);
         this.exitCode = exitCode;
+        this.cause = cause;
     }
 }
 exports.ApplicationError = ApplicationError;
@@ -31,7 +32,14 @@ function isError(e) {
     if (!e || typeof e !== 'object')
         return false;
     const ex = e;
-    return typeof ex.name === 'string' && typeof ex.message === 'string';
+    return typeof ex.message === 'string';
 }
 exports.isError = isError;
+function toApplicationError(e, message) {
+    if (e instanceof ApplicationError && !message)
+        return e;
+    const err = toError(e);
+    return new ApplicationError(message !== null && message !== void 0 ? message : err.message, undefined, err);
+}
+exports.toApplicationError = toApplicationError;
 //# sourceMappingURL=errors.js.map

package/dist/util/glob.d.ts

@@ -25,7 +25,7 @@ export declare function calcExcludeGlobInfo(root: string, commandLineExclude: st
 export declare function extractGlobExcludesFromConfig(root: string, source: string, config: CSpellUserSettings): GlobSrcInfo[];
 /**
  * Build GlobMatcher from command line or config file globs.
- * @param globs Glob patterns.
+ * @param globs Glob patterns or file paths
  * @param root - directory to use as the root
  */
 export declare function buildGlobMatcher(globs: Glob[], root: string, isExclude: boolean): GlobMatcher;

package/dist/util/glob.js

@@ -120,7 +120,7 @@ function extractGlobExcludesFromConfig(root, source, config) {
 exports.extractGlobExcludesFromConfig = extractGlobExcludesFromConfig;
 /**
  * Build GlobMatcher from command line or config file globs.
- * @param globs Glob patterns.
+ * @param globs Glob patterns or file paths
  * @param root - directory to use as the root
  */
 function buildGlobMatcher(globs, root, isExclude) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "5.13.2",
+  "version": "5.14.0",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "main": "dist/index.js",
@@ -72,34 +72,36 @@
     "chalk": "^4.1.2",
     "commander": "^8.3.0",
     "comment-json": "^4.1.1",
-    "cspell-gitignore": "^5.13.2",
-    "cspell-glob": "^5.13.2",
-    "cspell-lib": "^5.13.2",
+    "cspell-gitignore": "^5.14.0",
+    "cspell-glob": "^5.14.0",
+    "cspell-lib": "^5.14.0",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^6.0.1",
     "fs-extra": "^10.0.0",
     "get-stdin": "^8.0.0",
     "glob": "^7.2.0",
     "imurmurhash": "^0.1.4",
+    "semver": "^7.3.5",
     "strip-ansi": "^6.0.1",
-    "vscode-uri": "^3.0.2"
+    "vscode-uri": "^3.0.3"
   },
   "engines": {
     "node": ">=12.13.0"
   },
   "devDependencies": {
-    "@cspell/cspell-json-reporter": "^5.13.2",
-    "@cspell/cspell-types": "^5.13.2",
+    "@cspell/cspell-json-reporter": "^5.14.0",
+    "@cspell/cspell-types": "^5.14.0",
     "@types/file-entry-cache": "^5.0.2",
     "@types/fs-extra": "^9.0.13",
     "@types/glob": "^7.2.0",
     "@types/imurmurhash": "^0.1.1",
     "@types/micromatch": "^4.0.2",
     "@types/minimatch": "^3.0.5",
-    "jest": "^27.4.0",
+    "@types/semver": "^7.3.9",
+    "jest": "^27.4.5",
     "micromatch": "^4.0.4",
     "minimatch": "^3.0.4",
     "rimraf": "^3.0.2"
   },
-  "gitHead": "98bce0c75dcf4328b0adc80a9014809b393c0d37"
+  "gitHead": "8c8dfb70479584839e8035094771762f77118667"
 }