cspell 5.18.0 → 5.18.4

package/dist/application.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import type { CSpellReporter, RunResult } from '@cspell/cspell-types';
-import type { CheckTextInfo, SuggestionsForWordResult, TraceResult } from 'cspell-lib';
+import type { CheckTextInfo, TraceResult } from 'cspell-lib';
+import { TimedSuggestionsForWordResult } from './emitters/suggestionsEmitter';
 import { BaseOptions, LegacyOptions, LinterOptions, SuggestionOptions, TraceOptions } from './options';
 export { IncludeExcludeFlag } from 'cspell-lib';
 export type { TraceResult } from 'cspell-lib';
@@ -9,6 +10,6 @@ export declare function lint(fileGlobs: string[], options: LinterOptions, emitte
 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>;
-export declare function suggestions(words: string[], options: SuggestionOptions): AsyncIterable<SuggestionsForWordResult>;
+export declare function suggestions(words: string[], options: SuggestionOptions): AsyncIterable<TimedSuggestionsForWordResult>;
 export declare function createInit(): Promise<void>;
 //# sourceMappingURL=application.d.ts.map

package/dist/application.js

@@ -20,13 +20,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createInit = exports.suggestions = exports.checkText = exports.trace = exports.lint = exports.IncludeExcludeFlag = void 0;
+const cspell_pipe_1 = require("@cspell/cspell-pipe");
 const cspell_lib_1 = require("cspell-lib");
 const path = __importStar(require("path"));
 const lint_1 = require("./lint");
 const options_1 = require("./options");
-const async = __importStar(require("@cspell/cspell-pipe"));
+const repl_1 = require("./repl");
 const fileHelper_1 = require("./util/fileHelper");
 const stdin_1 = require("./util/stdin");
+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; } });
@@ -38,7 +40,7 @@ function lint(fileGlobs, options, emitters) {
 exports.lint = lint;
 async function* trace(words, options) {
     options = (0, options_1.fixLegacy)(options);
-    const iWords = options.stdin ? async.toAsyncIterable(words, (0, stdin_1.readStdin)()) : words;
+    const iWords = options.stdin ? (0, cspell_pipe_1.toAsyncIterable)(words, (0, stdin_1.readStdin)()) : words;
     const { languageId, locale, allowCompoundWords, ignoreCase } = options;
     const configFile = await (0, fileHelper_1.readConfig)(options.config, undefined);
     const config = (0, cspell_lib_1.mergeSettings)((0, cspell_lib_1.getDefaultSettings)(), (0, cspell_lib_1.getGlobalSettings)(), configFile.config);
@@ -60,9 +62,25 @@ exports.checkText = checkText;
 async function* suggestions(words, options) {
     options = (0, options_1.fixLegacy)(options);
     const configFile = await (0, fileHelper_1.readConfig)(options.config, undefined);
-    const iWords = options.useStdin ? async.toAsyncIterable(words, (0, stdin_1.readStdin)()) : words;
+    let timer;
+    function tapStart() {
+        timer = (0, timer_1.getTimeMeasurer)();
+    }
+    function mapStart(v) {
+        tapStart();
+        return v;
+    }
+    function mapEnd(v) {
+        const elapsedTimeMs = timer === null || timer === void 0 ? void 0 : timer();
+        return { ...v, elapsedTimeMs };
+    }
+    const iWords = options.repl
+        ? (0, cspell_pipe_1.pipeAsync)((0, cspell_pipe_1.toAsyncIterable)(words, (0, repl_1.simpleRepl)()), (0, cspell_pipe_1.opTap)(tapStart))
+        : options.useStdin
+            ? (0, cspell_pipe_1.pipeAsync)((0, cspell_pipe_1.toAsyncIterable)(words, (0, stdin_1.readStdin)()), (0, cspell_pipe_1.opTap)(tapStart))
+            : words.map(mapStart);
     try {
-        const results = (0, cspell_lib_1.suggestionsForWords)(iWords, options, configFile.config);
+        const results = (0, cspell_pipe_1.pipeAsync)((0, cspell_lib_1.suggestionsForWords)(iWords, options, configFile.config), (0, cspell_pipe_1.opMap)(mapEnd));
         yield* results;
     }
     catch (e) {

package/dist/cli-reporter.js

@@ -66,9 +66,21 @@ function relativeUriFilename(uri, fsPathRoot) {
     return '.' + path.sep + rel;
 }
 function reportProgress(p) {
-    if (p.type !== 'ProgressFileComplete') {
-        return;
+    if (p.type === 'ProgressFileComplete') {
+        return reportProgressFileComplete(p);
     }
+    if (p.type === 'ProgressFileBegin') {
+        return reportProgressFileBegin(p);
+    }
+}
+function reportProgressFileBegin(p) {
+    const fc = '' + p.fileCount;
+    const fn = (' '.repeat(fc.length) + p.fileNum).slice(-fc.length);
+    const idx = fn + '/' + fc;
+    const filename = chalk.gray(relativeFilename(p.filename));
+    process.stderr.write(`\r${idx} ${filename} ...`);
+}
+function reportProgressFileComplete(p) {
     const fc = '' + p.fileCount;
     const fn = (' '.repeat(fc.length) + p.fileNum).slice(-fc.length);
     const idx = fn + '/' + fc;
@@ -76,7 +88,7 @@ function reportProgress(p) {
     const time = reportTime(p.elapsedTimeMs, !!p.cached);
     const skipped = p.processed === false ? ' skipped' : '';
     const hasErrors = p.numErrors ? chalk.red ` X` : '';
-    console.error(`${idx} ${filename} ${time}${skipped}${hasErrors}`);
+    console.error(`\r${idx} ${filename} ${time}${skipped}${hasErrors}`);
 }
 function reportTime(elapsedTimeMs, cached) {
     if (cached)
@@ -124,6 +136,10 @@ function getReporter(options) {
         if (!fileGlobs.length && !result.files) {
             return;
         }
+        if (result.cachedFiles) {
+            console.error('CSpell: Files checked: %d (%d from cache), Issues found: %d in %d files', result.files, result.cachedFiles, result.issues, result.filesWithIssues.size);
+            return;
+        }
         console.error('CSpell: Files checked: %d, Issues found: %d in %d files', result.files, result.issues, result.filesWithIssues.size);
     };
     return {

package/dist/commandSuggestion.js

@@ -53,6 +53,7 @@ function commandSuggestion(prog) {
         .option('--num-suggestions <number>', 'Number of suggestions', asNumber, 8)
         .option('--no-include-ties', 'Force the number of suggested to be limited, by not including suggestions that have the same edit cost.')
         .option('--stdin', 'Use stdin for input.')
+        .addOption(new commander_1.Option('--repl', 'REPL interface for looking up suggestions.').hideHelp())
         .option('-v, --verbose', 'Show detailed output.', count, 0)
         .option('-d, --dictionary <dictionary name>', 'Use the dictionary specified. Only dictionaries specified will be used.', collect)
         .option('--dictionaries <dictionary names...>', 'Use the dictionaries specified. Only dictionaries specified will be used.')
@@ -62,7 +63,7 @@ function commandSuggestion(prog) {
         .action(async (words, options) => {
         options.useStdin = options.stdin;
         options.dictionaries = mergeArrays(options.dictionaries, options.dictionary);
-        if (!words.length && !options.useStdin) {
+        if (!words.length && !options.useStdin && !options.repl) {
             suggestionCommand.outputHelp();
             throw new errors_1.CheckFailed('outputHelp', 1);
         }

package/dist/emitters/suggestionsEmitter.d.ts

@@ -6,5 +6,8 @@ export interface EmitSuggestionOptions {
         log: (text: string) => void;
     };
 }
-export declare function emitSuggestionResult(result: SuggestionsForWordResult, options: EmitSuggestionOptions): void;
+export interface TimedSuggestionsForWordResult extends SuggestionsForWordResult {
+    elapsedTimeMs?: number;
+}
+export declare function emitSuggestionResult(result: TimedSuggestionsForWordResult, options: EmitSuggestionOptions): void;
 //# sourceMappingURL=suggestionsEmitter.d.ts.map

package/dist/emitters/suggestionsEmitter.js

@@ -6,21 +6,25 @@ const util_1 = require("../util/util");
 function emitSuggestionResult(result, options) {
     const { word, suggestions } = result;
     const { verbose, output = console } = options;
-    output.log(word ? chalk.green(word) : chalk.yellow('<empty>') + ':');
+    const elapsed = verbose && verbose > 1 && result.elapsedTimeMs ? ` ${result.elapsedTimeMs.toFixed(2)} ms` : '';
+    output.log((word ? chalk.yellow(word) : chalk.yellow('<empty>')) + ':' + elapsed);
     if (!suggestions.length) {
         console.log(chalk.yellow(' <no suggestions>'));
         return;
     }
     if (verbose) {
-        const maxWidth = suggestions.map((r) => r.word.length).reduce((max, len) => Math.max(max, len), 0);
+        const maxWidth = suggestions
+            .map((r) => (0, util_1.width)(r.compoundWord || r.word))
+            .reduce((max, len) => Math.max(max, len), 0);
         for (const sug of suggestions) {
-            const { word, cost, dictionaries } = sug;
-            const padding = ' '.repeat(maxWidth - word.length);
+            const { word, cost, dictionaries, compoundWord } = sug;
+            const w = compoundWord || word;
+            const padding = ' '.repeat((0, util_1.padWidth)(w, maxWidth));
             const forbid = sug.forbidden ? chalk.red('X') : ' ';
             const ignore = sug.noSuggest ? chalk.yellow('N') : ' ';
             const strCost = (0, util_1.padLeft)(cost.toString(10), 4);
             const dicts = dictionaries.map((n) => chalk.gray(n)).join(', ');
-            output.log(` - ${formatWord(word, sug)}${padding} ${forbid}${ignore} - ${chalk.yellow(strCost)} ${dicts}`);
+            output.log(` - ${formatWord(w, sug)}${padding} ${forbid}${ignore} - ${chalk.yellow(strCost)} ${dicts}`);
         }
     }
     else {

package/dist/emitters/traceEmitter.js

@@ -32,7 +32,7 @@ function emitTraceResults(results, options) {
     var _a;
     const maxWordLength = results
         .map((r) => r.foundWord || r.word)
-        .reduce((a, b) => Math.max(a, b.length), 'Word'.length);
+        .reduce((a, b) => Math.max(a, (0, util_1.width)(b)), 'Word'.length);
     const cols = {
         word: maxWordLength,
         dictName: colWidthDictionaryName,
@@ -66,7 +66,7 @@ function emitTraceResult(r, colWidths, options) {
     const dictColor = r.dictActive ? chalk.yellowBright : chalk.rgb(200, 128, 50);
     const n = dictColor(dictName);
     const info = [w, f, n].join(' ') + ' ';
-    const used = (0, strip_ansi_1.default)(info).length;
+    const used = (0, util_1.width)((0, strip_ansi_1.default)(info));
     const widthSrc = terminalWidth - used;
     const c = errors ? chalk.red : chalk.white;
     const s = c(formatDictionaryLocation(r.dictSource, widthSrc, options.cwd));

package/dist/lint/lint.js

@@ -46,10 +46,11 @@ async function runLint(cfg) {
     return lintResult;
     async function processFile(filename, configInfo, cache) {
         var _a, _b, _c, _d;
+        const getElapsedTimeMs = (0, timer_1.getTimeMeasurer)();
         const cachedResult = await cache.getCachedLintResults(filename);
         if (cachedResult) {
             reporter.debug(`Filename: ${filename}, using cache`);
-            return cachedResult;
+            return { ...cachedResult, elapsedTimeMs: getElapsedTimeMs() };
         }
         const result = {
             fileInfo: {
@@ -74,7 +75,6 @@ async function runLint(cfg) {
         const { text } = fileInfo;
         reporter.debug(`Filename: ${filename}, LanguageIds: ${(_a = doc.languageId) !== null && _a !== void 0 ? _a : 'default'}`);
         result.fileInfo = fileInfo;
-        const getElapsedTimeMs = (0, timer_1.getTimeMeasurer)();
         let spellResult = {};
         reporter.info(`Checking: ${filename}, File type: ${(_b = doc.languageId) !== null && _b !== void 0 ? _b : 'auto'}, Language: ${(_c = doc.locale) !== null && _c !== void 0 ? _c : 'default'}`, cspell_types_1.MessageTypes.Info);
         try {
@@ -114,10 +114,16 @@ async function runLint(cfg) {
         const status = runResult();
         const cache = (0, cache_1.createCache)(cacheSettings);
         const failFast = (_b = (_a = cfg.options.failFast) !== null && _a !== void 0 ? _a : configInfo.config.failFast) !== null && _b !== void 0 ? _b : false;
-        const emitProgress = (filename, fileNum, result) => reporter.progress({
+        const emitProgressBegin = (filename, fileNum, fileCount) => reporter.progress({
+            type: 'ProgressFileBegin',
+            fileNum,
+            fileCount,
+            filename,
+        });
+        const emitProgressComplete = (filename, fileNum, fileCount, result) => reporter.progress({
             type: 'ProgressFileComplete',
             fileNum,
-            fileCount: fileCount !== null && fileCount !== void 0 ? fileCount : fileNum,
+            fileCount,
             filename,
             elapsedTimeMs: result === null || result === void 0 ? void 0 : result.elapsedTimeMs,
             processed: result === null || result === void 0 ? void 0 : result.processed,
@@ -128,6 +134,7 @@ async function runLint(cfg) {
             let i = 0;
             for await (const filename of files) {
                 ++i;
+                emitProgressBegin(filename, i, fileCount !== null && fileCount !== void 0 ? fileCount : i);
                 const result = await processFile(filename, configInfo, cache);
                 yield { filename, fileNum: i, result };
             }
@@ -136,7 +143,7 @@ async function runLint(cfg) {
             const { filename, fileNum, result } = await fileP;
             status.files += 1;
             status.cachedFiles = (status.cachedFiles || 0) + (result.cached ? 1 : 0);
-            emitProgress(filename, fileNum, result);
+            emitProgressComplete(filename, fileNum, fileCount !== null && fileCount !== void 0 ? fileCount : fileNum, result);
             // Show the spelling errors after emitting the progress.
             result.issues.filter(cfg.uniqueFilter).forEach((issue) => reporter.issue(issue));
             if (result.issues.length || result.errors) {

package/dist/options.d.ts

@@ -98,6 +98,10 @@ export interface SuggestionOptions extends BaseOptions {
      * Use stdin for the input
      */
     useStdin?: boolean;
+    /**
+     * Use REPL interface for making suggestions.
+     */
+    repl?: boolean;
 }
 export interface LegacyOptions {
     local?: string;

package/dist/repl/index.d.ts

@@ -0,0 +1,18 @@
+export declare function simpleRepl(): AsyncIterable<string>;
+export declare type CompleterResult = [string[], string];
+export declare type Completer = (line: string) => CompleterResult;
+export declare class SimpleRepl implements AsyncIterable<string> {
+    prompt: string;
+    beforeEach: undefined | (() => void);
+    completer: undefined | Completer;
+    private _history;
+    private rl;
+    constructor(prompt?: string);
+    question(query: string): Promise<string>;
+    private _completer;
+    get history(): string[];
+    [Symbol.asyncIterator](): {
+        next: () => Promise<IteratorResult<string, undefined>>;
+    };
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/repl/index.js

@@ -0,0 +1,71 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleRepl = exports.simpleRepl = void 0;
+const readline = __importStar(require("readline"));
+function simpleRepl() {
+    return new SimpleRepl();
+}
+exports.simpleRepl = simpleRepl;
+class SimpleRepl {
+    constructor(prompt = '> ') {
+        this.prompt = prompt;
+        this._history = [];
+        this.rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+            prompt,
+            history: this._history,
+            historySize: 100,
+            completer: (line) => this._completer(line),
+        });
+        this.rl.on('history', (h) => ((this._history = h), undefined));
+    }
+    question(query) {
+        return new Promise((resolve) => {
+            this.rl.question(query, resolve);
+        });
+    }
+    _completer(line) {
+        // console.log('Complete: %s', line);
+        // console.log('History: %o', this._history);
+        if (this.completer)
+            return this.completer(line);
+        const hist = this._history.filter((h) => h.startsWith(line));
+        return [hist, line];
+    }
+    get history() {
+        return this._history;
+    }
+    [Symbol.asyncIterator]() {
+        const next = () => {
+            if (this.beforeEach)
+                this.beforeEach();
+            // console.log('%o', this.rl);
+            return this.question(this.prompt)
+                .then((value) => ({ value }))
+                .catch(() => ({ done: true, value: undefined }));
+        };
+        return { next };
+    }
+}
+exports.SimpleRepl = SimpleRepl;
+//# sourceMappingURL=index.js.map

package/dist/util/InMemoryReporter.d.ts

@@ -1,4 +1,4 @@
-import type { CSpellReporter, Issue, ProgressFileComplete, RunResult } from '@cspell/cspell-types';
+import type { CSpellReporter, Issue, ProgressItem, RunResult } from '@cspell/cspell-types';
 export interface InMemoryResult {
     log: string[];
     issues: Issue[];
@@ -21,7 +21,7 @@ export declare class InMemoryReporter implements CSpellReporter, InMemoryResult
     error: (message: string, error: Error) => void;
     info: (message: string) => void;
     debug: (message: string) => void;
-    progress: (p: ProgressFileComplete) => void;
+    progress: (p: ProgressItem) => void;
     result: (r: RunResult) => void;
     dump: () => InMemoryResult;
 }

package/dist/util/util.d.ts

@@ -4,7 +4,9 @@ export declare function uniqueFilterFnGenerator<T>(): FilterFn<T>;
 export declare function uniqueFilterFnGenerator<T, U>(extractFn: (v: T) => U): FilterFn<T>;
 export declare function unique<T>(src: T[]): T[];
 export declare function clean<T>(src: T): T;
+export declare function padWidth(s: string, target: number): number;
 export declare function pad(s: string, w: number): string;
 export declare function padLeft(s: string, w: number): string;
+export declare function width(s: string): number;
 export {};
 //# sourceMappingURL=util.d.ts.map

package/dist/util/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.padLeft = exports.pad = exports.clean = exports.unique = exports.uniqueFilterFnGenerator = exports.uniqueFn = void 0;
+exports.width = exports.padLeft = exports.pad = exports.padWidth = exports.clean = exports.unique = exports.uniqueFilterFnGenerator = exports.uniqueFn = void 0;
 // alias for uniqueFilterFnGenerator
 exports.uniqueFn = uniqueFilterFnGenerator;
 function uniqueFilterFnGenerator(extractFn) {
@@ -28,16 +28,28 @@ function clean(src) {
     return r;
 }
 exports.clean = clean;
+function padWidth(s, target) {
+    const sWidth = width(s);
+    return Math.max(target - sWidth, 0);
+}
+exports.padWidth = padWidth;
 function pad(s, w) {
-    if (s.length >= w)
+    const p = padWidth(s, w);
+    if (!p)
         return s;
-    return (s + ' '.repeat(w)).slice(0, w);
+    return s + ' '.repeat(p);
 }
 exports.pad = pad;
 function padLeft(s, w) {
-    if (s.length >= w)
+    const p = padWidth(s, w);
+    if (!p)
         return s;
-    return (' '.repeat(w) + s).slice(-w);
+    return ' '.repeat(p) + s;
 }
 exports.padLeft = padLeft;
+function width(s) {
+    // eslint-disable-next-line no-control-regex
+    return s.replace(/[\u0300-\u036f\x00-\x1f]/g, '').length;
+}
+exports.width = width;
 //# sourceMappingURL=util.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "5.18.0",
+  "version": "5.18.4",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "main": "dist/index.js",
@@ -70,13 +70,13 @@
   },
   "homepage": "https://streetsidesoftware.github.io/cspell/",
   "dependencies": {
-    "@cspell/cspell-pipe": "^5.18.0",
+    "@cspell/cspell-pipe": "^5.18.4",
     "chalk": "^4.1.2",
-    "commander": "^8.3.0",
-    "comment-json": "^4.1.1",
-    "cspell-gitignore": "^5.18.0",
-    "cspell-glob": "^5.18.0",
-    "cspell-lib": "^5.18.0",
+    "commander": "^9.0.0",
+    "comment-json": "^4.2.2",
+    "cspell-gitignore": "^5.18.4",
+    "cspell-glob": "^5.18.4",
+    "cspell-lib": "^5.18.4",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^6.0.1",
     "fs-extra": "^10.0.0",
@@ -91,8 +91,8 @@
     "node": ">=12.13.0"
   },
   "devDependencies": {
-    "@cspell/cspell-json-reporter": "^5.18.0",
-    "@cspell/cspell-types": "^5.18.0",
+    "@cspell/cspell-json-reporter": "^5.18.4",
+    "@cspell/cspell-types": "^5.18.4",
     "@types/file-entry-cache": "^5.0.2",
     "@types/fs-extra": "^9.0.13",
     "@types/glob": "^7.2.0",
@@ -100,12 +100,12 @@
     "@types/micromatch": "^4.0.2",
     "@types/minimatch": "^3.0.5",
     "@types/semver": "^7.3.9",
-    "jest": "^27.4.7",
+    "jest": "^27.5.0",
     "micromatch": "^4.0.4",
     "minimatch": "^3.0.4",
     "rimraf": "^3.0.2",
-    "rollup": "^2.66.1",
+    "rollup": "^2.67.0",
     "rollup-plugin-dts": "^4.1.0"
   },
-  "gitHead": "ef4c46dfb6f2938724afb5332ea2fdf9b67d99e4"
+  "gitHead": "26769ba64ce9eff227492524e5210709bec36416"
 }