cspell 9.1.3 → 9.2.0

package/dist/esm/util/pad.d.ts

@@ -1,45 +0,0 @@
-export declare function pad(s: string, w: number): string;
-export declare function padWidth(s: string, target: number): number;
-export declare function padLeft(s: string, w: number): string;
-export declare function isAnsiString(s: string): boolean;
-export declare function width(s: string): number;
-export declare function ansiWidth(s: string): number;
-/**
- * Prune the end of a string to fit within a specified width, adding an ellipsis if necessary.
- * @param str - the text to prune - ANSI is not supported
- * @param maxWidth - the maximum width of the text
- * @param pad - the string to use for padding, default is '…'
- * @returns the pruned text
- */
-export declare function pruneTextEnd(str: string, maxWidth: number | undefined, pad?: string): string;
-/**
- * Prune the start of a string to fit within a specified width, adding an ellipsis if necessary.
- * @param str - the text to prune - ANSI is not supported
- * @param maxWidth - the maximum width of the text
- * @param pad - the string to use for padding, default is '…'
- * @returns the pruned text
- */
-export declare function pruneTextStart(str: string, maxWidth: number | undefined, pad?: string): string;
-interface AnsiStrFragment {
-    type: 'text' | 'ansi';
-    text: string;
-}
-export declare function parseAnsiStr(str: string): AnsiStrFragment[];
-/**
- * Prune the end of a string to fit within a specified width, adding an ellipsis if necessary.
- * @param str - the text to prune - ANSI is supported
- * @param maxWidth - the maximum width of the text
- * @param pad - the string to use for padding, default is '…'
- * @returns the pruned text
- */
-export declare function pruneAnsiTextEnd(str: string, maxWidth: number | undefined, pad?: string): string;
-/**
- * Prune the start of a string to fit within a specified width, adding an ellipsis if necessary.
- * @param str - the text to prune - ANSI is supported
- * @param maxWidth - the maximum width of the text
- * @param pad - the string to use for padding, default is '…'
- * @returns the pruned text
- */
-export declare function pruneAnsiTextStart(str: string, maxWidth: number | undefined, pad?: string): string;
-export {};
-//# sourceMappingURL=pad.d.ts.map

package/dist/esm/util/pad.js

@@ -1,191 +0,0 @@
-import assert from 'node:assert';
-import { stripVTControlCharacters } from 'node:util';
-export function pad(s, w) {
-    const p = padWidth(s, w);
-    if (!p)
-        return s;
-    return s.padEnd(p + s.length);
-}
-export function padWidth(s, target) {
-    const sWidth = ansiWidth(s);
-    return Math.max(target - sWidth, 0);
-}
-export function padLeft(s, w) {
-    const p = padWidth(s, w);
-    if (!p)
-        return s;
-    return s.padStart(p + s.length);
-}
-export function isAnsiString(s) {
-    // Check if the string contains ANSI control characters.
-    return s.includes('\u001B') || s.includes('\u009B');
-}
-export function width(s) {
-    // Remove control codes and high surrogates to get the approximate width.
-    assert(!s.includes('\u001B'), 'String contains ANSI control characters');
-    return (s
-        // eslint-disable-next-line no-control-regex, no-misleading-character-class
-        .replaceAll(/[\u0000-\u001F\u0300-\u036F]/g, '')
-        .replaceAll(/[\uD800-\uDBFF][\uDC00-\uDFFF]/g, '.')
-        .replaceAll('…', '.')
-        .replaceAll(/\p{M}/gu, '').length);
-}
-export function ansiWidth(s) {
-    return width(stripVTControlCharacters(s));
-}
-/**
- * Prune the end of a string to fit within a specified width, adding an ellipsis if necessary.
- * @param str - the text to prune - ANSI is not supported
- * @param maxWidth - the maximum width of the text
- * @param pad - the string to use for padding, default is '…'
- * @returns the pruned text
- */
-export function pruneTextEnd(str, maxWidth, pad = '…') {
-    if (!maxWidth || maxWidth <= 0)
-        return str;
-    if (str.length <= maxWidth)
-        return str;
-    if (isAnsiString(str))
-        return pruneAnsiTextEnd(str, maxWidth, pad);
-    const padWidth = width(pad);
-    const maxWidthWithPad = maxWidth - padWidth;
-    const letters = [...str];
-    let len = 0;
-    for (let i = 0; i < letters.length; i++) {
-        const c = letters[i];
-        len += width(c);
-        if (len > maxWidthWithPad) {
-            let j = i + 1;
-            while (j < letters.length && width(letters[j]) === 0) {
-                ++j;
-            }
-            return j === letters.length ? str : letters.slice(0, i).join('') + pad;
-        }
-    }
-    return str;
-}
-/**
- * Prune the start of a string to fit within a specified width, adding an ellipsis if necessary.
- * @param str - the text to prune - ANSI is not supported
- * @param maxWidth - the maximum width of the text
- * @param pad - the string to use for padding, default is '…'
- * @returns the pruned text
- */
-export function pruneTextStart(str, maxWidth, pad = '…') {
-    if (!maxWidth || maxWidth <= 0)
-        return str;
-    if (str.length <= maxWidth)
-        return str;
-    const padWidth = width(pad);
-    const maxWidthWithPad = maxWidth - padWidth;
-    const letters = [...str];
-    let len = 0;
-    for (let i = letters.length - 1; i >= 1; i--) {
-        const c = letters[i];
-        len += width(c);
-        if (len > maxWidthWithPad) {
-            i += 1;
-            while (i < letters.length && width(letters[i]) === 0) {
-                ++i;
-            }
-            return pad + letters.slice(i).join('');
-        }
-    }
-    return str;
-}
-// https://github.com/nodejs/node/blob/0ab50c2768453e932b5402eaea3df813e725e330/lib/internal/util/inspect.js#L283
-const ansi = new RegExp('[\\u001B\\u009B][[\\]()#;?]*' +
-    '(?:(?:(?:(?:;[-a-zA-Z\\d\\/\\#&.:=?%@~_]+)*' +
-    '|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/\\#&.:=?%@~_]*)*)?' +
-    '(?:\\u0007|\\u001B\\u005C|\\u009C))' +
-    '|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?' +
-    '[\\dA-PR-TZcf-nq-uy=><~]))', 'g');
-export function parseAnsiStr(str) {
-    const fragments = [];
-    let lastIndex = 0;
-    for (const match of str.matchAll(ansi)) {
-        if (match.index > lastIndex) {
-            fragments.push({ type: 'text', text: str.slice(lastIndex, match.index) });
-        }
-        fragments.push({ type: 'ansi', text: match[0] });
-        lastIndex = match.index + match[0].length;
-    }
-    if (lastIndex < str.length) {
-        fragments.push({ type: 'text', text: str.slice(lastIndex) });
-    }
-    return fragments;
-}
-/**
- * Prune the end of a string to fit within a specified width, adding an ellipsis if necessary.
- * @param str - the text to prune - ANSI is supported
- * @param maxWidth - the maximum width of the text
- * @param pad - the string to use for padding, default is '…'
- * @returns the pruned text
- */
-export function pruneAnsiTextEnd(str, maxWidth, pad = '…') {
-    if (!maxWidth || maxWidth <= 0)
-        return str;
-    if (str.length <= maxWidth)
-        return str;
-    if (ansiWidth(str) <= maxWidth)
-        return str;
-    const padWidth = ansiWidth(pad);
-    const fragments = parseAnsiStr(str);
-    const maxWidthWithPad = maxWidth - padWidth;
-    let remaining = maxWidthWithPad;
-    for (const frag of fragments) {
-        if (frag.type !== 'text')
-            continue;
-        if (remaining <= 0) {
-            frag.text = '';
-            continue;
-        }
-        const pruned = pruneTextEnd(frag.text, remaining, pad);
-        if (pruned !== frag.text) {
-            frag.text = pruned;
-            remaining = 0; // Stop processing further fragments
-            continue;
-        }
-        remaining -= width(frag.text);
-    }
-    return fragments.map((frag) => frag.text).join('');
-}
-/**
- * Prune the start of a string to fit within a specified width, adding an ellipsis if necessary.
- * @param str - the text to prune - ANSI is supported
- * @param maxWidth - the maximum width of the text
- * @param pad - the string to use for padding, default is '…'
- * @returns the pruned text
- */
-export function pruneAnsiTextStart(str, maxWidth, pad = '…') {
-    if (!maxWidth || maxWidth <= 0)
-        return str;
-    if (str.length <= maxWidth)
-        return str;
-    if (ansiWidth(str) <= maxWidth)
-        return str;
-    const padWidth = ansiWidth(pad);
-    const fragments = parseAnsiStr(str);
-    const maxWidthWithPad = maxWidth - padWidth;
-    let remaining = maxWidthWithPad;
-    for (const frag of fragments.reverse()) {
-        if (frag.type !== 'text')
-            continue;
-        if (remaining <= 0) {
-            frag.text = '';
-            continue;
-        }
-        const pruned = pruneTextStart(frag.text, remaining, pad);
-        if (pruned !== frag.text) {
-            frag.text = pruned;
-            remaining = 0; // Stop processing further fragments
-            continue;
-        }
-        remaining -= width(frag.text);
-    }
-    return fragments
-        .reverse()
-        .map((frag) => frag.text)
-        .join('');
-}
-//# sourceMappingURL=pad.js.map

package/dist/esm/util/prefetch.d.ts

@@ -1,2 +0,0 @@
-export declare function prefetchIterable<T>(iterable: Iterable<T>, size: number): Iterable<T>;
-//# sourceMappingURL=prefetch.d.ts.map

package/dist/esm/util/prefetch.js

@@ -1,15 +0,0 @@
-import assert from 'node:assert';
-export function* prefetchIterable(iterable, size) {
-    assert(size >= 0);
-    const buffer = [];
-    for (const value of iterable) {
-        buffer.push(value);
-        if (buffer.length >= size - 1) {
-            const value = buffer[0];
-            buffer.shift();
-            yield value;
-        }
-    }
-    yield* buffer;
-}
-//# sourceMappingURL=prefetch.js.map

package/dist/esm/util/reporters.d.ts

@@ -1,30 +0,0 @@
-import { type CSpellReporter, type CSpellSettings, type FeaturesSupportedByReporter, type FileSettings, type Issue, type ReporterConfiguration, type ReportIssueOptions, type RunResult } from '@cspell/cspell-types';
-import { LintFileResult } from './LintFileResult.js';
-export type FinalizedReporter = Required<CSpellReporter>;
-/**
- * Loads reporter modules configured in cspell config file
- */
-export declare function loadReporters(reporters: FileSettings['reporters'], defaultReporter: CSpellReporter, config: ReporterConfiguration): Promise<ReadonlyArray<CSpellReporter>>;
-export declare function finalizeReporter(reporter: undefined): undefined;
-export declare function finalizeReporter(reporter: CSpellReporter): FinalizedReporter;
-export declare function finalizeReporter(reporter: CSpellReporter | undefined): FinalizedReporter | undefined;
-export declare function extractReporterIssueOptions(settings: CSpellSettings | ReportIssueOptions): ReportIssueOptions;
-export declare function mergeReportIssueOptions(a: ReportIssueOptions | CSpellSettings, b: ReportIssueOptions | undefined): ReportIssueOptions;
-export declare class LintReporter {
-    #private;
-    readonly defaultReporter: CSpellReporter;
-    constructor(defaultReporter: CSpellReporter, config: ReporterConfiguration);
-    get config(): ReporterConfiguration;
-    set config(config: ReporterConfiguration);
-    issue(issue: Issue, reportOptions?: ReportIssueOptions): void;
-    info(...params: Parameters<FinalizedReporter['info']>): void;
-    debug(...params: Parameters<FinalizedReporter['debug']>): void;
-    error(...params: Parameters<FinalizedReporter['error']>): void;
-    progress(...params: Parameters<FinalizedReporter['progress']>): void;
-    result(result: RunResult): Promise<void>;
-    get features(): FeaturesSupportedByReporter;
-    loadReportersAndFinalize(reporters: FileSettings['reporters']): Promise<void>;
-    emitProgressBegin(filename: string, fileNum: number, fileCount: number): void;
-    emitProgressComplete(filename: string, fileNum: number, fileCount: number, result: LintFileResult): number;
-}
-//# sourceMappingURL=reporters.d.ts.map

package/dist/esm/util/reporters.js

@@ -1,209 +0,0 @@
-import assert from 'node:assert';
-import { IssueType, unknownWordsChoices, } from '@cspell/cspell-types';
-import { dynamicImport } from '@cspell/dynamic-import';
-import { pkgDir } from '../pkgInfo.js';
-import { ApplicationError, toError } from './errors.js';
-import { clean } from './util.js';
-function filterFeatureIssues(features, issue, reportOptions) {
-    if (issue.issueType === IssueType.directive) {
-        return (features?.issueType && reportOptions?.validateDirectives) || false;
-    }
-    if (features?.unknownWords) {
-        return true;
-    }
-    if (!reportOptions) {
-        // If no options are provided, report the issue.
-        return true;
-    }
-    // The reporter doesn't support the `unknownWords` feature. Handle the logic here.
-    let reportIssue = issue.isFlagged;
-    reportIssue ||= !reportOptions.unknownWords || reportOptions.unknownWords === unknownWordsChoices.ReportAll;
-    reportIssue ||= reportOptions.unknownWords === unknownWordsChoices.ReportSimple && issue.hasSimpleSuggestions;
-    reportIssue ||=
-        reportOptions.unknownWords === unknownWordsChoices.ReportCommonTypos && issue.hasPreferredSuggestions;
-    return reportIssue || false;
-}
-function handleIssue(reporter, issue, reportOptions) {
-    if (!reporter.issue)
-        return;
-    if (!filterFeatureIssues(reporter.features, issue, reportOptions)) {
-        // The reporter does not want to handle this issue.
-        return;
-    }
-    if (!reporter.features?.contextGeneration && !issue.context) {
-        issue = { ...issue };
-        issue.context = issue.line; // Ensure context is always set if the reporter does not support context generation.
-    }
-    return reporter.issue(issue, reportOptions);
-}
-/**
- * Loads reporter modules configured in cspell config file
- */
-export async function loadReporters(reporters, defaultReporter, config) {
-    async function loadReporter(reporterSettings) {
-        if (reporterSettings === 'default')
-            return defaultReporter;
-        if (!Array.isArray(reporterSettings)) {
-            reporterSettings = [reporterSettings];
-        }
-        const [moduleName, settings] = reporterSettings;
-        try {
-            const { getReporter } = await dynamicImport(moduleName, [process.cwd(), pkgDir]);
-            return getReporter(settings, config);
-        }
-        catch (e) {
-            throw new ApplicationError(`Failed to load reporter ${moduleName}: ${toError(e).message}`);
-        }
-    }
-    reporters = !reporters || !reporters.length ? ['default'] : [...reporters];
-    const loadedReporters = await Promise.all(reporters.map(loadReporter));
-    return loadedReporters.filter((v) => v !== undefined);
-}
-export function finalizeReporter(reporter) {
-    if (!reporter)
-        return undefined;
-    if (reporterIsFinalized(reporter)) {
-        return reporter;
-    }
-    const final = {
-        issue: (...params) => reporter.issue?.(...params),
-        info: (...params) => reporter.info?.(...params),
-        debug: (...params) => reporter.debug?.(...params),
-        progress: (...params) => reporter.progress?.(...params),
-        error: (...params) => reporter.error?.(...params),
-        result: (...params) => reporter.result?.(...params),
-        features: reporter.features,
-    };
-    return final;
-}
-function reporterIsFinalized(reporter) {
-    return ((!!reporter &&
-        reporter.features &&
-        typeof reporter.issue === 'function' &&
-        typeof reporter.info === 'function' &&
-        typeof reporter.debug === 'function' &&
-        typeof reporter.error === 'function' &&
-        typeof reporter.progress === 'function' &&
-        typeof reporter.result === 'function') ||
-        false);
-}
-const reportIssueOptionsKeyMap = {
-    unknownWords: 'unknownWords',
-    validateDirectives: 'validateDirectives',
-    showContext: 'showContext',
-};
-function setValue(options, key, value) {
-    if (value !== undefined) {
-        options[key] = value;
-    }
-}
-export function extractReporterIssueOptions(settings) {
-    const src = settings;
-    const options = {};
-    for (const key in reportIssueOptionsKeyMap) {
-        const k = key;
-        setValue(options, k, src[k]);
-    }
-    return options;
-}
-export function mergeReportIssueOptions(a, b) {
-    const options = extractReporterIssueOptions(a);
-    if (!b)
-        return options;
-    for (const key in reportIssueOptionsKeyMap) {
-        const k = key;
-        setValue(options, k, b[k]);
-    }
-    return options;
-}
-export class LintReporter {
-    defaultReporter;
-    #reporters = [];
-    #config;
-    #finalized = false;
-    constructor(defaultReporter, config) {
-        this.defaultReporter = defaultReporter;
-        this.#config = config;
-        if (defaultReporter) {
-            this.#reporters.push(finalizeReporter(defaultReporter));
-        }
-    }
-    get config() {
-        return this.#config;
-    }
-    set config(config) {
-        assert(!this.#finalized, 'Cannot change the configuration of a finalized reporter');
-        this.#config = config;
-    }
-    issue(issue, reportOptions) {
-        for (const reporter of this.#reporters) {
-            handleIssue(reporter, issue, reportOptions);
-        }
-    }
-    info(...params) {
-        for (const reporter of this.#reporters) {
-            reporter.info(...params);
-        }
-    }
-    debug(...params) {
-        for (const reporter of this.#reporters) {
-            reporter.debug(...params);
-        }
-    }
-    error(...params) {
-        for (const reporter of this.#reporters) {
-            reporter.error(...params);
-        }
-    }
-    progress(...params) {
-        for (const reporter of this.#reporters) {
-            reporter.progress(...params);
-        }
-    }
-    async result(result) {
-        await Promise.all(this.#reporters.map((reporter) => reporter.result?.(result)));
-    }
-    get features() {
-        return {
-            unknownWords: true,
-            issueType: true,
-        };
-    }
-    async loadReportersAndFinalize(reporters) {
-        assert(!this.#finalized, 'Cannot change the configuration of a finalized reporter');
-        const loaded = await loadReporters(reporters, this.defaultReporter, this.config);
-        this.#reporters = [...new Set(loaded)].map((reporter) => finalizeReporter(reporter));
-    }
-    emitProgressBegin(filename, fileNum, fileCount) {
-        this.progress({
-            type: 'ProgressFileBegin',
-            fileNum,
-            fileCount,
-            filename,
-        });
-    }
-    emitProgressComplete(filename, fileNum, fileCount, result) {
-        const filteredIssues = result.issues.filter((issue) => filterFeatureIssues({}, issue, result.reportIssueOptions));
-        const numIssues = filteredIssues.length;
-        for (const reporter of this.#reporters) {
-            const progress = clean({
-                type: 'ProgressFileComplete',
-                fileNum,
-                fileCount,
-                filename,
-                elapsedTimeMs: result.elapsedTimeMs,
-                processed: result.processed,
-                numErrors: numIssues || result.errors,
-                cached: result.cached,
-                perf: result.perf,
-                issues: reporter.features && result.issues,
-                reportIssueOptions: reporter.features && result.reportIssueOptions,
-            });
-            reporter.progress(progress);
-        }
-        // Show the spelling errors after emitting the progress.
-        result.issues.forEach((issue) => this.issue(issue, result.reportIssueOptions));
-        return numIssues;
-    }
-}
-//# sourceMappingURL=reporters.js.map

package/dist/esm/util/stdin.d.ts

@@ -1,2 +0,0 @@
-export declare function readStdin(): AsyncIterable<string>;
-//# sourceMappingURL=stdin.d.ts.map

package/dist/esm/util/stdin.js

@@ -1,5 +0,0 @@
-import * as readline from 'node:readline';
-export function readStdin() {
-    return readline.createInterface(process.stdin);
-}
-//# sourceMappingURL=stdin.js.map

package/dist/esm/util/stdinUrl.d.ts

@@ -1,9 +0,0 @@
-export declare function isStdinUrl(url: string | URL): boolean;
-/**
- * Normalize and resolve a stdin url.
- * @param url - stdin url to resolve.
- * @param cwd - file path to resolve relative paths against.
- * @returns
- */
-export declare function resolveStdinUrl(url: string, cwd: string): string;
-//# sourceMappingURL=stdinUrl.d.ts.map

package/dist/esm/util/stdinUrl.js

@@ -1,26 +0,0 @@
-import assert from 'node:assert';
-import { toFileURL } from '@cspell/url';
-import { STDINProtocol } from './constants.js';
-export function isStdinUrl(url) {
-    if (url instanceof URL) {
-        return url.protocol === STDINProtocol;
-    }
-    return url.startsWith(STDINProtocol);
-}
-/**
- * Normalize and resolve a stdin url.
- * @param url - stdin url to resolve.
- * @param cwd - file path to resolve relative paths against.
- * @returns
- */
-export function resolveStdinUrl(url, cwd) {
-    assert(url.startsWith(STDINProtocol), `Expected url to start with ${STDINProtocol}`);
-    const path = decodeURIComponent(url)
-        .slice(STDINProtocol.length)
-        .replace(/^\/\//, '')
-        .replace(/^\/([a-z]:)/i, '$1');
-    const fileUrl = toFileURL(path, cwd);
-    // If the path is empty,
-    return fileUrl.toString().replace(/^file:/, STDINProtocol) + (path ? '' : '/');
-}
-//# sourceMappingURL=stdinUrl.js.map

package/dist/esm/util/table.d.ts

@@ -1,41 +0,0 @@
-export type RowTextFn = (maxWidth: number | undefined) => string;
-export type TableCell = string | RowTextFn;
-export type TableRow = TableCell[] | Record<string, TableCell>;
-export type TableHeaderColumnFieldTitle = [field: string, title: string];
-export type TableHeader = string[] | TableHeaderColumnFieldTitle[];
-export type TextDecorator = (t: string, columnIndex: number) => string;
-export interface MaxColumnWidths {
-    /**
-     * [field name or column index]: number of characters
-     */
-    [column: string | number]: number | undefined;
-}
-export interface Table {
-    /**
-     * The header of the table.
-     * Can be an array of strings or an array of tuples with field name and title.
-     */
-    header: TableHeader;
-    /**
-     * The rows of the table.
-     * Can be an array of arrays or an array of objects with field names as keys.
-     */
-    rows: TableRow[];
-    /**
-     * The width of the terminal, used to adjust column widths.
-     */
-    terminalWidth?: number;
-    /**
-     * The deliminator used to separate columns in the table.
-     * Defaults to ' | ' if not provided.
-     */
-    deliminator?: string;
-    /**
-     * The maximum widths for each column.
-     * If provided, it will override the calculated widths.
-     */
-    maxColumnWidths?: MaxColumnWidths;
-}
-export declare function tableToLines(table: Table, deliminator?: string): string[];
-export declare function decorateRowWith(row: string[], ...decorators: TextDecorator[]): string[];
-//# sourceMappingURL=table.d.ts.map