cspell 8.3.0 → 8.3.2

package/dist/esm/application.d.mts

@@ -1,13 +1,13 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { CSpellReporter, RunResult } from '@cspell/cspell-types';
-import type { CheckTextInfo, FeatureFlags, TraceResult } from 'cspell-lib';
+import type { CheckTextInfo, FeatureFlags, TraceWordResult } from 'cspell-lib';
 import type { TimedSuggestionsForWordResult } from './emitters/suggestionsEmitter.mjs';
 import type { BaseOptions, LegacyOptions, LinterCliOptions, SuggestionOptions, TraceOptions } from './options.mjs';
 export type { TraceResult } from 'cspell-lib';
 export { IncludeExcludeFlag } from 'cspell-lib';
 export type AppError = NodeJS.ErrnoException;
 export declare function lint(fileGlobs: string[], options: LinterCliOptions, reporter?: CSpellReporter): Promise<RunResult>;
-export declare function trace(words: string[], options: TraceOptions): AsyncIterableIterator<TraceResult[]>;
+export declare function trace(words: string[], options: TraceOptions): AsyncIterableIterator<TraceWordResult>;
 export type CheckTextResult = CheckTextInfo;
 export declare function checkText(filename: string, options: BaseOptions & LegacyOptions): Promise<CheckTextResult>;
 export declare function suggestions(words: string[], options: SuggestionOptions): AsyncIterable<TimedSuggestionsForWordResult>;

package/dist/esm/application.d.ts

@@ -1,13 +1,13 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { CSpellReporter, RunResult } from '@cspell/cspell-types';
-import type { CheckTextInfo, FeatureFlags, TraceResult } from 'cspell-lib';
+import type { CheckTextInfo, FeatureFlags, TraceWordResult } from 'cspell-lib';
 import type { TimedSuggestionsForWordResult } from './emitters/suggestionsEmitter.js';
 import type { BaseOptions, LegacyOptions, LinterCliOptions, SuggestionOptions, TraceOptions } from './options.js';
 export type { TraceResult } from 'cspell-lib';
 export { IncludeExcludeFlag } from 'cspell-lib';
 export type AppError = NodeJS.ErrnoException;
 export declare function lint(fileGlobs: string[], options: LinterCliOptions, reporter?: CSpellReporter): Promise<RunResult>;
-export declare function trace(words: string[], options: TraceOptions): AsyncIterableIterator<TraceResult[]>;
+export declare function trace(words: string[], options: TraceOptions): AsyncIterableIterator<TraceWordResult>;
 export type CheckTextResult = CheckTextInfo;
 export declare function checkText(filename: string, options: BaseOptions & LegacyOptions): Promise<CheckTextResult>;
 export declare function suggestions(words: string[], options: SuggestionOptions): AsyncIterable<TimedSuggestionsForWordResult>;

package/dist/esm/commandTrace.js

@@ -33,14 +33,25 @@ export function commandTrace(prog) {
         const dictionaryPathFormat = isDictionaryPathFormat(options.dictionaryPath)
             ? options.dictionaryPath
             : 'long';
+        let prefix = '';
         for await (const results of App.trace(words, options)) {
-            const filtered = filterTraceResults(results, options);
-            emitTraceResults(filtered, { cwd: process.cwd(), dictionaryPathFormat });
-            numFound += results.reduce((n, r) => n + (r.found ? 1 : 0), 0);
-            const numErrors = results.map((r) => r.errors?.length || 0).reduce((n, r) => n + r, 0);
-            if (numErrors) {
-                console.error('Dictionary Errors.');
-                throw new CheckFailed('dictionary errors', 1);
+            const byWord = groupBy(results, (r) => r.word);
+            for (const split of results.splits) {
+                const splitResults = byWord.get(split.word) || [];
+                const filtered = filterTraceResults(splitResults, options);
+                emitTraceResults(split.word, split.found, filtered, {
+                    cwd: process.cwd(),
+                    dictionaryPathFormat,
+                    prefix,
+                    showWordFound: results.splits.length > 1,
+                });
+                prefix = '\n';
+                numFound += results.reduce((n, r) => n + (r.found ? 1 : 0), 0);
+                const numErrors = results.map((r) => r.errors?.length || 0).reduce((n, r) => n + r, 0);
+                if (numErrors) {
+                    console.error('Dictionary Errors.');
+                    throw new CheckFailed('dictionary errors', 1);
+                }
             }
         }
         if (!numFound) {
@@ -57,4 +68,14 @@ function filterTraceResults(results, options) {
 function filterTraceResult(result, onlyFound) {
     return result.found || result.forbidden || result.noSuggest || (!onlyFound && result.dictActive);
 }
+function groupBy(items, key) {
+    const map = new Map();
+    for (const item of items) {
+        const k = key(item);
+        const a = map.get(k) || [];
+        a.push(item);
+        map.set(k, a);
+    }
+    return map;
+}
 //# sourceMappingURL=commandTrace.js.map

package/dist/esm/commandTrace.mjs

@@ -33,14 +33,25 @@ export function commandTrace(prog) {
         const dictionaryPathFormat = isDictionaryPathFormat(options.dictionaryPath)
             ? options.dictionaryPath
             : 'long';
+        let prefix = '';
         for await (const results of App.trace(words, options)) {
-            const filtered = filterTraceResults(results, options);
-            emitTraceResults(filtered, { cwd: process.cwd(), dictionaryPathFormat });
-            numFound += results.reduce((n, r) => n + (r.found ? 1 : 0), 0);
-            const numErrors = results.map((r) => r.errors?.length || 0).reduce((n, r) => n + r, 0);
-            if (numErrors) {
-                console.error('Dictionary Errors.');
-                throw new CheckFailed('dictionary errors', 1);
+            const byWord = groupBy(results, (r) => r.word);
+            for (const split of results.splits) {
+                const splitResults = byWord.get(split.word) || [];
+                const filtered = filterTraceResults(splitResults, options);
+                emitTraceResults(split.word, split.found, filtered, {
+                    cwd: process.cwd(),
+                    dictionaryPathFormat,
+                    prefix,
+                    showWordFound: results.splits.length > 1,
+                });
+                prefix = '\n';
+                numFound += results.reduce((n, r) => n + (r.found ? 1 : 0), 0);
+                const numErrors = results.map((r) => r.errors?.length || 0).reduce((n, r) => n + r, 0);
+                if (numErrors) {
+                    console.error('Dictionary Errors.');
+                    throw new CheckFailed('dictionary errors', 1);
+                }
             }
         }
         if (!numFound) {
@@ -57,4 +68,14 @@ function filterTraceResults(results, options) {
 function filterTraceResult(result, onlyFound) {
     return result.found || result.forbidden || result.noSuggest || (!onlyFound && result.dictActive);
 }
+function groupBy(items, key) {
+    const map = new Map();
+    for (const item of items) {
+        const k = key(item);
+        const a = map.get(k) || [];
+        a.push(item);
+        map.set(k, a);
+    }
+    return map;
+}
 //# sourceMappingURL=commandTrace.mjs.map

package/dist/esm/emitters/traceEmitter.d.mts

@@ -11,8 +11,10 @@ export interface EmitTraceOptions {
     lineWidth?: number;
     dictionaryPathFormat: DictionaryPathFormat;
     iPath?: PathInterface;
+    prefix?: string;
+    showWordFound?: boolean;
 }
-export declare function emitTraceResults(results: TraceResult[], options: EmitTraceOptions): void;
+export declare function emitTraceResults(word: string, found: boolean, results: TraceResult[], options: EmitTraceOptions): void;
 declare function trimMidPath(s: string, w: number, sep: string): string;
 export declare const __testing__: {
     trimMidPath: typeof trimMidPath;

package/dist/esm/emitters/traceEmitter.d.ts

@@ -11,8 +11,10 @@ export interface EmitTraceOptions {
     lineWidth?: number;
     dictionaryPathFormat: DictionaryPathFormat;
     iPath?: PathInterface;
+    prefix?: string;
+    showWordFound?: boolean;
 }
-export declare function emitTraceResults(results: TraceResult[], options: EmitTraceOptions): void;
+export declare function emitTraceResults(word: string, found: boolean, results: TraceResult[], options: EmitTraceOptions): void;
 declare function trimMidPath(s: string, w: number, sep: string): string;
 export declare const __testing__: {
     trimMidPath: typeof trimMidPath;

package/dist/esm/emitters/traceEmitter.js

@@ -3,7 +3,7 @@ import * as iPath from 'path';
 import strip from 'strip-ansi';
 import { pad, width } from '../util/util.js';
 const colWidthDictionaryName = 20;
-export function emitTraceResults(results, options) {
+export function emitTraceResults(word, found, results, options) {
     const maxWordLength = results
         .map((r) => r.foundWord || r.word)
         .reduce((a, b) => Math.max(a, width(b)), 'Word'.length);
@@ -18,6 +18,7 @@ export function emitTraceResults(results, options) {
     };
     const col = new Intl.Collator();
     results.sort((a, b) => col.compare(a.dictName, b.dictName));
+    options.showWordFound && console.log(`${options.prefix || ''}${word}: ${found ? 'Found' : 'Not Found'}`);
     emitHeader(cols);
     results.forEach((r) => emitTraceResult(r, cols, options));
 }

package/dist/esm/emitters/traceEmitter.mjs

@@ -3,7 +3,7 @@ import * as iPath from 'path';
 import strip from 'strip-ansi';
 import { pad, width } from '../util/util.mjs';
 const colWidthDictionaryName = 20;
-export function emitTraceResults(results, options) {
+export function emitTraceResults(word, found, results, options) {
     const maxWordLength = results
         .map((r) => r.foundWord || r.word)
         .reduce((a, b) => Math.max(a, width(b)), 'Word'.length);
@@ -18,6 +18,7 @@ export function emitTraceResults(results, options) {
     };
     const col = new Intl.Collator();
     results.sort((a, b) => col.compare(a.dictName, b.dictName));
+    options.showWordFound && console.log(`${options.prefix || ''}${word}: ${found ? 'Found' : 'Not Found'}`);
     emitHeader(cols);
     results.forEach((r) => emitTraceResult(r, cols, options));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "8.3.0",
+  "version": "8.3.2",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "bin": {
@@ -81,17 +81,17 @@
   },
   "homepage": "https://streetsidesoftware.github.io/cspell/",
   "dependencies": {
-    "@cspell/cspell-json-reporter": "8.3.0",
-    "@cspell/cspell-pipe": "8.3.0",
-    "@cspell/cspell-types": "8.3.0",
-    "@cspell/dynamic-import": "8.3.0",
+    "@cspell/cspell-json-reporter": "8.3.2",
+    "@cspell/cspell-pipe": "8.3.2",
+    "@cspell/cspell-types": "8.3.2",
+    "@cspell/dynamic-import": "8.3.2",
     "chalk": "^5.3.0",
     "chalk-template": "^1.1.0",
     "commander": "^11.1.0",
-    "cspell-gitignore": "8.3.0",
-    "cspell-glob": "8.3.0",
-    "cspell-io": "8.3.0",
-    "cspell-lib": "8.3.0",
+    "cspell-gitignore": "8.3.2",
+    "cspell-glob": "8.3.2",
+    "cspell-io": "8.3.2",
+    "cspell-lib": "8.3.2",
     "fast-glob": "^3.3.2",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^8.0.0",
@@ -111,5 +111,5 @@
     "micromatch": "^4.0.5",
     "minimatch": "^9.0.3"
   },
-  "gitHead": "019c7ccd326b7fc9e106069ddf6008d5079bbd12"
+  "gitHead": "98f622b2b12529f2d1ccf0f3a57991e4c08b3e3a"
 }