cspell 6.2.2 → 6.3.0

package/dist/application.d.ts

@@ -2,11 +2,11 @@
 import type { CSpellReporter, RunResult } from '@cspell/cspell-types';
 import type { CheckTextInfo, TraceResult } from 'cspell-lib';
 import { TimedSuggestionsForWordResult } from './emitters/suggestionsEmitter';
-import { BaseOptions, LegacyOptions, LinterOptions, SuggestionOptions, TraceOptions } from './options';
+import { BaseOptions, LegacyOptions, LinterCliOptions, SuggestionOptions, TraceOptions } from './options';
 export { IncludeExcludeFlag } from 'cspell-lib';
 export type { TraceResult } from 'cspell-lib';
 export declare type AppError = NodeJS.ErrnoException;
-export declare function lint(fileGlobs: string[], options: LinterOptions, emitters: CSpellReporter): Promise<RunResult>;
+export declare function lint(fileGlobs: string[], options: LinterCliOptions, reporter?: CSpellReporter): Promise<RunResult>;
 export declare function trace(words: string[], options: TraceOptions): AsyncIterableIterator<TraceResult[]>;
 export declare type CheckTextResult = CheckTextInfo;
 export declare function checkText(filename: string, options: BaseOptions & LegacyOptions): Promise<CheckTextResult>;

package/dist/application.js

@@ -27,6 +27,7 @@ exports.createInit = exports.suggestions = exports.checkText = exports.trace = e
 const cspell_pipe_1 = require("@cspell/cspell-pipe");
 const cspell_lib_1 = require("cspell-lib");
 const path = __importStar(require("path"));
+const cli_reporter_1 = require("./cli-reporter");
 const lint_1 = require("./lint");
 const options_1 = require("./options");
 const repl_1 = require("./repl");
@@ -36,9 +37,9 @@ const timer_1 = require("./util/timer");
 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(fileGlobs, options, emitters) {
+function lint(fileGlobs, options, reporter) {
     options = (0, options_1.fixLegacy)(options);
-    const cfg = new lint_1.LintRequest(fileGlobs, options, emitters);
+    const cfg = new lint_1.LintRequest(fileGlobs, options, reporter ?? (0, cli_reporter_1.getReporter)({ ...options, fileGlobs }));
     return (0, lint_1.runLint)(cfg);
 }
 exports.lint = lint;

package/dist/commandLint.js

@@ -26,7 +26,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.commandLint = void 0;
 const commander_1 = require("commander");
 const App = __importStar(require("./application"));
-const cli_reporter_1 = require("./cli-reporter");
 const cache_1 = require("./util/cache");
 const errors_1 = require("./util/errors");
 // interface InitOptions extends Options {}
@@ -100,9 +99,7 @@ function commandLint(prog) {
         .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) => {
+        return App.lint(fileGlobs, options).then((result) => {
             if (!fileGlobs.length && !result.files && !result.errors && !fileList) {
                 spellCheckCommand.outputHelp();
                 throw new errors_1.CheckFailed('outputHelp', 1);

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from '@cspell/cspell-types';
 export * from './application';
-export type { BaseOptions, LinterOptions as CSpellApplicationOptions, TraceOptions } from './options';
+export type { BaseOptions, LinterCliOptions as CSpellApplicationOptions, TraceOptions } from './options';
+export { getReporter as getDefaultReporter } from './cli-reporter';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,6 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultReporter = void 0;
 __exportStar(require("@cspell/cspell-types"), exports);
 __exportStar(require("./application"), exports);
+var cli_reporter_1 = require("./cli-reporter");
+Object.defineProperty(exports, "getDefaultReporter", { enumerable: true, get: function () { return cli_reporter_1.getReporter; } });
 //# sourceMappingURL=index.js.map

package/dist/lint/LintRequest.d.ts

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

package/dist/lint/LintRequest.js

@@ -41,7 +41,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 || [];
+        this.fileLists = (options.fileList ?? options.fileLists) || [];
     }
 }
 exports.LintRequest = LintRequest;

package/dist/options.d.ts

@@ -53,7 +53,7 @@ export interface LinterOptions extends BaseOptions, Omit<CacheOptions, 'version'
      * 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;
+    fileList?: string[] | undefined;
     /**
      * Files must be found and processed otherwise it is considered an error.
      */
@@ -125,21 +125,36 @@ export interface BaseOptions {
      */
     defaultConfiguration?: boolean;
 }
-export interface LinterCliOptions extends Omit<LinterOptions, 'fileLists'> {
+export interface LinterCliOptions extends LinterOptions {
+    /**
+     * Show legacy output
+     */
     legacy?: boolean;
-    summary: boolean;
-    issues: boolean;
-    silent: boolean;
-    mustFindFiles: boolean;
+    /**
+     * Show summary at the end
+     */
+    summary?: boolean;
+    /**
+     * Show issues
+     */
+    issues?: boolean;
+    /**
+     * Run in silent mode.
+     * @default false
+     */
+    silent?: boolean;
+    /**
+     * Show progress
+     */
     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.
+     * Files must be found or cli will exit with an error.
      */
-    fileList?: string[];
+    mustFindFiles?: boolean;
 }
 export declare function fixLegacy<T extends BaseOptions>(opts: T & LegacyOptions): Omit<T & LegacyOptions, 'local'>;
 //# sourceMappingURL=options.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "6.2.2",
+  "version": "6.3.0",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "main": "dist/index.js",
@@ -70,12 +70,12 @@
   },
   "homepage": "https://streetsidesoftware.github.io/cspell/",
   "dependencies": {
-    "@cspell/cspell-pipe": "^6.2.2",
+    "@cspell/cspell-pipe": "^6.3.0",
     "chalk": "^4.1.2",
     "commander": "^9.3.0",
-    "cspell-gitignore": "^6.2.2",
-    "cspell-glob": "^6.2.2",
-    "cspell-lib": "^6.2.2",
+    "cspell-gitignore": "^6.3.0",
+    "cspell-glob": "^6.3.0",
+    "cspell-lib": "^6.3.0",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^6.0.1",
     "fs-extra": "^10.1.0",
@@ -90,8 +90,8 @@
     "node": ">=14"
   },
   "devDependencies": {
-    "@cspell/cspell-json-reporter": "^6.2.2",
-    "@cspell/cspell-types": "^6.2.2",
+    "@cspell/cspell-json-reporter": "^6.3.0",
+    "@cspell/cspell-types": "^6.3.0",
     "@types/file-entry-cache": "^5.0.2",
     "@types/fs-extra": "^9.0.13",
     "@types/glob": "^7.2.0",
@@ -103,8 +103,8 @@
     "micromatch": "^4.0.5",
     "minimatch": "^5.1.0",
     "rimraf": "^3.0.2",
-    "rollup": "^2.75.7",
+    "rollup": "^2.76.0",
     "rollup-plugin-dts": "^4.2.2"
   },
-  "gitHead": "b7716e80c39a780f98cde747ad66c55247636621"
+  "gitHead": "6b7b2a0e92f0b3c760dd3c3fd6bc8a8a873e1987"
 }