cspell 9.0.1 → 9.1.0

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

@@ -0,0 +1,14 @@
+import type { DictionaryPathFormat } from './DictionaryPathFormat.js';
+export interface PathInterface {
+    relative(from: string, to: string): string;
+    basename(path: string): string;
+    sep: string;
+}
+export declare function trimMidPath(s: string, w: number, sep: string): string;
+export declare function trimMid(s: string, w: number): string;
+export declare function formatDictionaryLocation(dictSource: string, maxWidth: number, { cwd, dictionaryPathFormat: format, iPath, }: {
+    cwd: string;
+    dictionaryPathFormat: DictionaryPathFormat;
+    iPath: PathInterface;
+}): string;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/esm/emitters/helpers.js

@@ -0,0 +1,67 @@
+export function trimMidPath(s, w, sep) {
+    if (s.length <= w)
+        return s;
+    const parts = s.split(sep);
+    if (parts[parts.length - 1].length > w)
+        return trimMid(s, w);
+    function join(left, right) {
+        // if (left === right) return parts.join(sep);
+        return [...parts.slice(0, left), '…', ...parts.slice(right)].join(sep);
+    }
+    let left = 0, right = parts.length, last = '';
+    for (let i = 0; i < parts.length; ++i) {
+        const incLeft = i & 1 ? 1 : 0;
+        const incRight = incLeft ? 0 : -1;
+        const next = join(left + incLeft, right + incRight);
+        if (next.length > w)
+            break;
+        left += incLeft;
+        right += incRight;
+        last = next;
+    }
+    for (let i = left + 1; i < right; ++i) {
+        const next = join(i, right);
+        if (next.length > w)
+            break;
+        last = next;
+    }
+    for (let i = right - 1; i > left; --i) {
+        const next = join(left, i);
+        if (next.length > w)
+            break;
+        last = next;
+    }
+    return last || trimMid(s, w);
+}
+export function trimMid(s, w) {
+    s = s.trim();
+    if (s.length <= w) {
+        return s;
+    }
+    const l = Math.floor((w - 1) / 2);
+    const r = Math.ceil((w - 1) / 2);
+    return s.slice(0, l) + '…' + s.slice(-r);
+}
+export function formatDictionaryLocation(dictSource, maxWidth, { cwd, dictionaryPathFormat: format, iPath, }) {
+    let relPath = cwd ? iPath.relative(cwd, dictSource) : dictSource;
+    const idxNodeModule = relPath.lastIndexOf('node_modules');
+    const isNodeModule = idxNodeModule >= 0;
+    if (format === 'hide')
+        return '';
+    if (format === 'short') {
+        const prefix = isNodeModule
+            ? '[node_modules]/'
+            : relPath.startsWith('..' + iPath.sep + '..')
+                ? '…/'
+                : relPath.startsWith('..' + iPath.sep)
+                    ? '../'
+                    : '';
+        return prefix + iPath.basename(dictSource);
+    }
+    if (format === 'full')
+        return dictSource;
+    relPath = isNodeModule ? relPath.slice(idxNodeModule) : relPath;
+    const usePath = relPath.length < dictSource.length ? relPath : dictSource;
+    return trimMidPath(usePath, maxWidth, iPath.sep);
+}
+//# sourceMappingURL=helpers.js.map

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

@@ -1,10 +1,6 @@
 import type { TraceResult } from '../application.mjs';
 import type { DictionaryPathFormat } from './DictionaryPathFormat.js';
-interface PathInterface {
-    relative(from: string, to: string): string;
-    basename(path: string): string;
-    sep: string;
-}
+import { type PathInterface } from './helpers.js';
 export interface EmitTraceOptions {
     /** current working directory */
     cwd: string;
@@ -20,9 +16,4 @@ export declare function calcTraceResultsReport(word: string, found: boolean, res
     table: string;
     errors: string;
 };
-declare function trimMidPath(s: string, w: number, sep: string): string;
-export declare const __testing__: {
-    trimMidPath: typeof trimMidPath;
-};
-export {};
 //# sourceMappingURL=traceEmitter.d.ts.map

package/dist/esm/emitters/traceEmitter.js

@@ -2,6 +2,7 @@ import * as iPath from 'node:path';
 import chalk from 'chalk';
 import { console } from '../console.js';
 import { tableToLines } from '../util/table.js';
+import { formatDictionaryLocation } from './helpers.js';
 const maxWidth = 120;
 const colWidthDictionaryName = 20;
 export function emitTraceResults(word, found, results, options) {
@@ -66,15 +67,6 @@ function emitErrors(results) {
         return chalk.bold(r.dictName) + '\n\t' + chalk.red(errors);
     });
 }
-function trimMid(s, w) {
-    s = s.trim();
-    if (s.length <= w) {
-        return s;
-    }
-    const l = Math.floor((w - 3) / 2);
-    const r = Math.ceil((w - 3) / 2);
-    return s.slice(0, l) + '...' + s.slice(-r);
-}
 function calcFoundChar(r) {
     const errors = r.errors?.map((e) => e.message)?.join('\n\t') || '';
     let color = chalk.dim;
@@ -89,67 +81,7 @@ function calcFoundChar(r) {
     char = errors ? 'X' : char;
     return color(char);
 }
-function formatDictionaryLocation(dictSource, maxWidth, { cwd, dictionaryPathFormat: format, iPath, }) {
-    let relPath = cwd ? iPath.relative(cwd, dictSource) : dictSource;
-    const idxNodeModule = relPath.lastIndexOf('node_modules');
-    const isNodeModule = idxNodeModule >= 0;
-    if (format === 'hide')
-        return '';
-    if (format === 'short') {
-        const prefix = isNodeModule
-            ? '[node_modules]/'
-            : relPath.startsWith('..' + iPath.sep + '..')
-                ? '.../'
-                : relPath.startsWith('..' + iPath.sep)
-                    ? '../'
-                    : '';
-        return prefix + iPath.basename(dictSource);
-    }
-    if (format === 'full')
-        return dictSource;
-    relPath = isNodeModule ? relPath.slice(idxNodeModule) : relPath;
-    const usePath = relPath.length < dictSource.length ? relPath : dictSource;
-    return trimMidPath(usePath, maxWidth, iPath.sep);
-}
 function colorize(fn) {
     return (s) => (s ? fn(s) : '');
 }
-function trimMidPath(s, w, sep) {
-    if (s.length <= w)
-        return s;
-    const parts = s.split(sep);
-    if (parts[parts.length - 1].length > w)
-        return trimMid(s, w);
-    function join(left, right) {
-        // if (left === right) return parts.join(sep);
-        return [...parts.slice(0, left), '...', ...parts.slice(right)].join(sep);
-    }
-    let left = 0, right = parts.length, last = '';
-    for (let i = 0; i < parts.length; ++i) {
-        const incLeft = i & 1 ? 1 : 0;
-        const incRight = incLeft ? 0 : -1;
-        const next = join(left + incLeft, right + incRight);
-        if (next.length > w)
-            break;
-        left += incLeft;
-        right += incRight;
-        last = next;
-    }
-    for (let i = left + 1; i < right; ++i) {
-        const next = join(i, right);
-        if (next.length > w)
-            break;
-        last = next;
-    }
-    for (let i = right - 1; i > left; --i) {
-        const next = join(left, i);
-        if (next.length > w)
-            break;
-        last = next;
-    }
-    return last || trimMid(s, w);
-}
-export const __testing__ = {
-    trimMidPath,
-};
 //# sourceMappingURL=traceEmitter.js.map

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

@@ -1,4 +1,4 @@
-import type { Issue } from '@cspell/cspell-types';
+import { type CSpellUserSettings, type UnknownWordsConfiguration } from '@cspell/cspell-types';
 import type { CSpellConfigFile, LinterCliOptions, LinterOptions } from '../options.js';
 import type { GlobSrcInfo } from '../util/glob.js';
 import type { FinalizedReporter } from '../util/reporters.js';
@@ -10,7 +10,6 @@ export declare class LintRequest {
     readonly fileGlobs: string[];
     readonly options: LinterCliOptions & Deprecated;
     readonly reporter: FinalizedReporter;
-    readonly uniqueFilter: (issue: Issue) => boolean;
     readonly locale: string;
     readonly configFile: string | CSpellConfigFile | undefined;
     readonly excludes: GlobSrcInfo[];
@@ -19,7 +18,9 @@ export declare class LintRequest {
     readonly enableGlobDot: boolean | undefined;
     readonly fileLists: string[];
     readonly files: string[] | undefined;
+    readonly cspellSettingsFromCliOptions: CSpellUserSettings;
     constructor(fileGlobs: string[], options: LinterCliOptions & Deprecated, reporter: FinalizedReporter);
 }
+export declare function extractUnknownWordsConfig(options: LinterCliOptions): UnknownWordsConfiguration;
 export {};
 //# sourceMappingURL=LintRequest.d.ts.map

package/dist/esm/lint/LintRequest.js

@@ -1,11 +1,11 @@
 import * as path from 'node:path';
+import { unknownWordsChoices } from '@cspell/cspell-types';
 import { calcExcludeGlobInfo } from '../util/glob.js';
 const defaultContextRange = 20;
 export class LintRequest {
     fileGlobs;
     options;
     reporter;
-    uniqueFilter;
     locale;
     configFile;
     excludes;
@@ -14,6 +14,7 @@ export class LintRequest {
     enableGlobDot;
     fileLists;
     files;
+    cspellSettingsFromCliOptions;
     constructor(fileGlobs, options, reporter) {
         this.fileGlobs = fileGlobs;
         this.options = options;
@@ -23,12 +24,23 @@ export class LintRequest {
         this.excludes = calcExcludeGlobInfo(this.root, options.exclude);
         this.locale = options.locale ?? options.local ?? '';
         this.enableGlobDot = options.dot;
-        // this.uniqueFilter = options.unique ? util.uniqueFilterFnGenerator((issue: Issue) => issue.text) : () => true;
-        this.uniqueFilter = () => true;
-        this.showContext =
-            options.showContext === true ? defaultContextRange : options.showContext ? options.showContext : 0;
+        this.showContext = Math.max(options.showContext === true ? defaultContextRange : options.showContext ? options.showContext : 0, 0);
         this.fileLists = (options.fileList ?? options.fileLists) || [];
         this.files = mergeFiles(options.file, options.files);
+        const noConfigSearch = options.configSearch === false ? true : options.configSearch === true ? false : undefined;
+        const dictionaries = [
+            ...(options.disableDictionary ?? []).map((d) => `!${d}`), // first disable dictionaries
+            ...(options.dictionary ?? []).map((d) => `!!${d}`), // Use `!!` to ensure dictionaries are enabled
+        ];
+        const languageSettings = [
+            // Use `*` to match all languages and locales
+            { languageId: '*', locale: '*', dictionaries },
+        ];
+        this.cspellSettingsFromCliOptions = {
+            ...(noConfigSearch !== undefined ? { noConfigSearch } : {}),
+            ...extractUnknownWordsConfig(options),
+            languageSettings,
+        };
     }
 }
 function mergeFiles(a, b) {
@@ -44,4 +56,28 @@ function merge(a, b) {
         return a;
     return [...a, ...b];
 }
+export function extractUnknownWordsConfig(options) {
+    const config = {};
+    if (!options.report)
+        return config;
+    switch (options.report) {
+        case 'all': {
+            config.unknownWords = unknownWordsChoices.ReportAll;
+            break;
+        }
+        case 'simple': {
+            config.unknownWords = unknownWordsChoices.ReportSimple;
+            break;
+        }
+        case 'typos': {
+            config.unknownWords = unknownWordsChoices.ReportCommonTypos;
+            break;
+        }
+        case 'flagged': {
+            config.unknownWords = unknownWordsChoices.ReportFlagged;
+            break;
+        }
+    }
+    return config;
+}
 //# sourceMappingURL=LintRequest.js.map

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

@@ -1,3 +1,3 @@
 export { runLint } from './lint.js';
-export { LintRequest } from './LintRequest.js';
+export { extractUnknownWordsConfig, LintRequest } from './LintRequest.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/lint/index.js

@@ -1,3 +1,3 @@
 export { runLint } from './lint.js';
-export { LintRequest } from './LintRequest.js';
+export { extractUnknownWordsConfig, LintRequest } from './LintRequest.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/lint/lint.js

@@ -8,7 +8,7 @@ import chalk from 'chalk';
 import { _debug as cspellDictionaryDebug } from 'cspell-dictionary';
 import { findRepoRoot, GitIgnore } from 'cspell-gitignore';
 import { GlobMatcher } from 'cspell-glob';
-import { ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, getDefaultConfigLoader, getDictionary, isBinaryFile as cspellIsBinaryFile, setLogger, shouldCheckDocument, spellCheckDocument, Text as cspellText, } from 'cspell-lib';
+import { ENV_CSPELL_GLOB_ROOT, extractDependencies, extractImportErrors, getDefaultConfigLoader, getDictionary, isBinaryFile as cspellIsBinaryFile, mergeSettings, setLogger, shouldCheckDocument, spellCheckDocument, Text as cspellText, } from 'cspell-lib';
 import { console } from '../console.js';
 import { getEnvironmentVariable, setEnvironmentVariable, truthy } from '../environment.js';
 import { getFeatureFlags } from '../featureFlags/index.js';
@@ -16,10 +16,11 @@ import { npmPackage } from '../pkgInfo.js';
 import { calcCacheSettings, createCache } from '../util/cache/index.js';
 import { readConfig } from '../util/configFileHelper.js';
 import { CheckFailed, toApplicationError, toError } from '../util/errors.js';
-import { fileInfoToDocument, filenameToUri, findFiles, isBinaryFile, isFile, isNotDir, readFileInfo, readFileListFiles, resolveFilename, } from '../util/fileHelper.js';
+import { extractContext } from '../util/extractContext.js';
+import { fileInfoToDocument, filenameToUri, findFiles, isBinaryFile, isFile, isNotDir, readFileInfo, readFileListFiles, relativeToCwd, resolveFilename, } from '../util/fileHelper.js';
 import { buildGlobMatcher, extractGlobsFromMatcher, extractPatterns, normalizeFileOrGlobsToRoot, normalizeGlobsToRoot, } from '../util/glob.js';
 import { prefetchIterable } from '../util/prefetch.js';
-import { loadReporters, mergeReporters } from '../util/reporters.js';
+import { extractReporterIssueOptions, LintReporter, mergeReportIssueOptions } from '../util/reporters.js';
 import { getTimeMeasurer } from '../util/timer.js';
 import * as util from '../util/util.js';
 import { writeFileOrStream } from '../util/writeFile.js';
@@ -28,8 +29,7 @@ const BATCH_SIZE = 8;
 const debugStats = false;
 const { opFilterAsync } = operators;
 export async function runLint(cfg) {
-    let { reporter } = cfg;
-    setLogger(getLoggerFromReporter(reporter));
+    const reporter = new LintReporter(cfg.reporter, cfg.options);
     const configErrors = new Set();
     const timer = getTimeMeasurer();
     const logDictRequests = truthy(getEnvironmentVariable('CSPELL_ENABLE_DICTIONARY_LOGGING'));
@@ -49,6 +49,7 @@ export async function runLint(cfg) {
     function prefetch(filename, configInfo, cache) {
         if (isBinaryFile(filename, cfg.root))
             return { filename, result: Promise.resolve({ skip: true }) };
+        const reportIssueOptions = extractReporterIssueOptions(configInfo.config);
         async function fetch() {
             const getElapsedTimeMs = getTimeMeasurer();
             const cachedResult = await cache.getCachedLintResults(filename);
@@ -62,7 +63,7 @@ export async function runLint(cfg) {
             if (!checkResult.shouldCheck)
                 return { skip: true };
             const fileInfo = await readFileInfo(filename, undefined, true);
-            return { fileInfo };
+            return { fileInfo, reportIssueOptions };
         }
         const result = fetch();
         return { filename, result };
@@ -71,10 +72,11 @@ export async function runLint(cfg) {
         if (prefetch?.fileResult)
             return prefetch.fileResult;
         const getElapsedTimeMs = getTimeMeasurer();
+        const reportIssueOptions = prefetch?.reportIssueOptions;
         const cachedResult = await cache.getCachedLintResults(filename);
         if (cachedResult) {
             reporter.debug(`Filename: ${filename}, using cache`);
-            return { ...cachedResult, elapsedTimeMs: getElapsedTimeMs() };
+            return { ...cachedResult, elapsedTimeMs: getElapsedTimeMs(), reportIssueOptions };
         }
         const result = {
             fileInfo: {
@@ -85,6 +87,7 @@ export async function runLint(cfg) {
             errors: 0,
             configErrors: 0,
             elapsedTimeMs: 0,
+            reportIssueOptions,
         };
         const fileInfo = prefetch?.fileInfo || (await readFileInfo(filename, undefined, true));
         if (fileInfo.errorCode) {
@@ -122,6 +125,7 @@ export async function runLint(cfg) {
         }
         result.elapsedTimeMs = getElapsedTimeMs();
         const config = spellResult.settingsUsed ?? {};
+        result.reportIssueOptions = mergeReportIssueOptions(spellResult.settingsUsed || configInfo.config, reportIssueOptions);
         result.configErrors += await reportConfigurationErrors(config);
         const elapsed = result.elapsedTimeMs;
         const dictionaries = config.dictionaries || [];
@@ -144,9 +148,7 @@ export async function runLint(cfg) {
         return result;
     }
     function mapIssue({ doc: _, ...tdo }) {
-        const context = cfg.showContext
-            ? extractContext(tdo, cfg.showContext)
-            : { text: tdo.line.text.trimEnd(), offset: tdo.line.offset };
+        const context = cfg.showContext ? extractContext(tdo, cfg.showContext) : undefined;
         return util.clean({ ...tdo, context });
     }
     async function processFiles(files, configInfo, cacheSettings) {
@@ -154,23 +156,6 @@ export async function runLint(cfg) {
         const status = runResult();
         const cache = createCache(cacheSettings);
         const failFast = cfg.options.failFast ?? configInfo.config.failFast ?? false;
-        const emitProgressBegin = (filename, fileNum, fileCount) => reporter.progress({
-            type: 'ProgressFileBegin',
-            fileNum,
-            fileCount,
-            filename,
-        });
-        const emitProgressComplete = (filename, fileNum, fileCount, result) => reporter.progress(util.clean({
-            type: 'ProgressFileComplete',
-            fileNum,
-            fileCount,
-            filename,
-            elapsedTimeMs: result?.elapsedTimeMs,
-            processed: result?.processed,
-            numErrors: result?.issues.length || result?.errors,
-            cached: result?.cached,
-            perf: result?.perf,
-        }));
         function* prefetchFiles(files) {
             const iter = prefetchIterable(pipe(files, opMap((filename) => prefetch(filename, configInfo, cache))), BATCH_SIZE);
             for (const v of iter) {
@@ -189,12 +174,13 @@ export async function runLint(cfg) {
             errors: 0,
             configErrors: 0,
             elapsedTimeMs: 1,
+            reportIssueOptions: undefined,
         };
         async function processPrefetchFileResult(pf, index) {
             const { filename, result: pFetchResult } = pf;
             const getElapsedTimeMs = getTimeMeasurer();
             const fetchResult = await pFetchResult;
-            emitProgressBegin(filename, index, fileCount ?? index);
+            reporter.emitProgressBegin(filename, index, fileCount ?? index);
             if (fetchResult?.skip) {
                 return {
                     filename,
@@ -230,15 +216,13 @@ export async function runLint(cfg) {
             }
         }
         for await (const fileP of loadAndProcessFiles()) {
-            const { filename, fileNum, result } = await fileP;
+            const { filename, fileNum, result } = fileP;
             status.files += 1;
             status.cachedFiles = (status.cachedFiles || 0) + (result.cached ? 1 : 0);
-            emitProgressComplete(filename, fileNum, 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) {
-                status.filesWithIssues.add(filename);
-                status.issues += result.issues.length;
+            const numIssues = reporter.emitProgressComplete(filename, fileNum, fileCount ?? fileNum, result);
+            if (numIssues || result.errors) {
+                status.filesWithIssues.add(relativeToCwd(filename, cfg.root));
+                status.issues += numIssues;
                 status.errors += result.errors;
                 if (failFast) {
                     return status;
@@ -286,10 +270,11 @@ export async function runLint(cfg) {
         if (cfg.options.root) {
             setEnvironmentVariable(ENV_CSPELL_GLOB_ROOT, cfg.root);
         }
-        const configInfo = await readConfig(cfg.configFile, cfg.root);
+        const configInfo = await readConfig(cfg.configFile, cfg.root, cfg.options.stopConfigSearchAt);
         if (cfg.options.defaultConfiguration !== undefined) {
             configInfo.config.loadDefaultConfiguration = cfg.options.defaultConfiguration;
         }
+        configInfo.config = mergeSettings(configInfo.config, cfg.cspellSettingsFromCliOptions);
         const reporterConfig = util.clean({
             maxNumberOfProblems: configInfo.config.maxNumberOfProblems,
             maxDuplicateProblems: configInfo.config.maxDuplicateProblems,
@@ -298,7 +283,8 @@ export async function runLint(cfg) {
             console,
         });
         const reporters = cfg.options.reporter ?? configInfo.config.reporters;
-        reporter = mergeReporters(...(await loadReporters(reporters, cfg.reporter, reporterConfig)));
+        reporter.config = reporterConfig;
+        await reporter.loadReportersAndFinalize(reporters);
         setLogger(getLoggerFromReporter(reporter));
         const globInfo = await determineGlobs(configInfo, cfg);
         const { fileGlobs, excludeGlobs } = globInfo;
@@ -311,14 +297,18 @@ export async function runLint(cfg) {
         checkGlobs(fileGlobs, reporter);
         reporter.info(`Config Files Found:\n    ${configInfo.source}\n`, MessageTypes.Info);
         const configErrors = await countConfigErrors(configInfo);
-        if (configErrors && cfg.options.exitCode !== false)
+        if (configErrors && cfg.options.exitCode !== false && !cfg.options.continueOnError) {
             return runResult({ errors: configErrors });
+        }
         // Get Exclusions from the config files.
         const { root } = cfg;
         try {
             const cacheSettings = await calcCacheSettings(configInfo.config, { ...cfg.options, version }, root);
             const files = await determineFilesToCheck(configInfo, cfg, reporter, globInfo);
             const result = await processFiles(files, configInfo, cacheSettings);
+            if (configErrors && cfg.options.exitCode !== false) {
+                result.errors ||= configErrors;
+            }
             debugStats && console.error('stats: %o', getDefaultConfigLoader().getStats());
             return result;
         }
@@ -433,34 +423,6 @@ async function determineFilesToCheck(configInfo, cfg, reporter, globInfo) {
     }
     return _determineFilesToCheck();
 }
-function extractContext(tdo, contextRange) {
-    const { line, offset } = tdo;
-    const textOffsetInLine = offset - line.offset;
-    let left = Math.max(textOffsetInLine - contextRange, 0);
-    let right = Math.min(line.text.length, textOffsetInLine + contextRange + tdo.text.length);
-    const lineText = line.text;
-    const isLetter = /^[a-z]$/i;
-    const isSpace = /^\s$/;
-    for (let n = contextRange / 2; n > 0 && left > 0; n--, left--) {
-        if (!isLetter.test(lineText[left - 1])) {
-            break;
-        }
-    }
-    for (let n = contextRange / 2; n > 0 && right < lineText.length; n--, right++) {
-        if (!isLetter.test(lineText[right])) {
-            break;
-        }
-    }
-    // remove leading space
-    for (; left < textOffsetInLine && isSpace.test(lineText[left]); left++) {
-        /* do nothing */
-    }
-    const context = {
-        text: line.text.slice(left, right).trimEnd(),
-        offset: left + line.offset,
-    };
-    return context;
-}
 function extractGlobSource(g) {
     const { glob, rawGlob, source } = g;
     return {