cspell 9.1.2 → 9.1.5

package/dist/esm/options.d.ts

@@ -1,353 +0,0 @@
-import { CSpellSettings, ReporterConfiguration } from '@cspell/cspell-types';
-import type { CacheOptions } from './util/cache/index.js';
-export interface LinterOptions extends Omit<BaseOptions, 'config'>, Omit<CacheOptions, 'version'>, ReporterConfiguration {
-    /**
-     * Display verbose information
-     */
-    verbose?: boolean;
-    /**
-     * Show extensive output.
-     */
-    debug?: boolean;
-    /**
-     * a globs to exclude files from being checked.
-     */
-    exclude?: string[] | string;
-    /**
-     * Only report the words, no line numbers or file names.
-     */
-    wordsOnly?: boolean;
-    /**
-     * unique errors per file only.
-     */
-    unique?: boolean;
-    /**
-     * root directory, defaults to `cwd`
-     */
-    root?: string;
-    /**
-     * Determine if files / directories starting with `.` should be part
-     * of the glob search.
-     * @default false
-     */
-    dot?: boolean;
-    /**
-     * Show part of a line where an issue is found.
-     * - if true, it will show the default number of characters on either side.
-     * - if a number, the number of characters to show on either side of the issue.
-     */
-    showContext?: boolean | number;
-    /**
-     * Show suggestions for spelling errors.
-     */
-    showSuggestions?: boolean;
-    /**
-     * Enable filtering out files matching globs found in `.gitignore` files.
-     */
-    gitignore?: boolean;
-    /**
-     * Stop searching for a `.gitignore`s when a root is reached.
-     */
-    gitignoreRoot?: string | string[];
-    /**
-     * List of files that contains the paths to files to be spell checked.
-     * The files in the lists will be filtered against the glob patterns.
-     * - an entry of `stdin` means to read the file list from **`stdin`**
-     * The resulting files are filtered against the `files` globs found in the configuration.
-     */
-    fileList?: string[] | undefined;
-    /**
-     * List of file paths to spell check. These can be relative or absolute
-     * paths, but not Globs. Relative paths are relative to {@link LinterOptions.root}.
-     * The files are combined with the file paths read from {@link LinterOptions.fileList}.
-     * These files are filtered against the `files` globs found in the configuration.
-     */
-    files?: string[] | undefined;
-    /**
-     * Alias of {@link LinterOptions.files}.
-     */
-    file?: string[] | undefined;
-    /**
-     * Use the `files` configuration to filter the files found.
-     */
-    filterFiles?: boolean | undefined;
-    /**
-     * Files must be found and processed otherwise it is considered an error.
-     */
-    mustFindFiles?: boolean;
-    /**
-     * List of dictionary names to use.
-     */
-    dictionary?: string[] | undefined;
-    /**
-     * List of dictionary names to disable.
-     */
-    disableDictionary?: string[] | undefined;
-    /**
-     * Stop processing and exit if an issue or error is found.
-     */
-    failFast?: boolean;
-    /**
-     * Keep going even if an error is found.
-     */
-    continueOnError?: boolean;
-    /**
-     * Optional list of reporters to use, overriding any specified in the
-     * configuration.
-     */
-    reporter?: string[];
-    /**
-     * Load and parse documents, but do not spell check.
-     */
-    skipValidation?: boolean;
-    /**
-     * Path to configuration file.
-     */
-    config?: string | CSpellConfigFile;
-}
-export interface TraceOptions extends BaseOptions {
-    /**
-     * Use stdin for the input.
-     */
-    stdin?: boolean;
-    /**
-     * Enable the `allowCompoundWords` option.
-     */
-    allowCompoundWords?: boolean;
-    /**
-     * Ignore case and accents when searching for words.
-     */
-    ignoreCase?: boolean;
-    /**
-     * Show all dictionaries, not just the ones that contain the words or are enabled.
-     */
-    all?: boolean;
-    /**
-     * Show only dictionaries that contain the words.
-     * If `all` is set, this option is ignored.
-     */
-    onlyFound?: boolean;
-    /**
-     * Names of dictionaries to use.
-     */
-    dictionary?: string[] | undefined;
-    /**
-     * Configure how to display the dictionary path.
-     */
-    dictionaryPath?: 'hide' | 'long' | 'short' | 'full';
-}
-export interface SuggestionOptions extends BaseOptions {
-    /**
-     * Strict case and accent checking
-     * @default true
-     */
-    strict?: boolean;
-    /**
-     * List of dictionaries to use. If specified, only that list of dictionaries will be used.
-     */
-    dictionaries?: string[] | undefined;
-    /**
-     * The number of suggestions to make.
-     * @default 8
-     */
-    numSuggestions?: number;
-    /**
-     * Max number of changes / edits to the word to get to a suggestion matching suggestion.
-     * @default 4
-     */
-    numChanges?: number;
-    /**
-     * If multiple suggestions have the same edit / change "cost", then included them even if
-     * it causes more than `numSuggestions` to be returned.
-     * @default true
-     */
-    includeTies?: boolean;
-    /**
-     * Use stdin for the input
-     */
-    useStdin?: boolean | undefined;
-    /**
-     * Use REPL interface for making suggestions.
-     */
-    repl?: boolean;
-}
-export interface DictionariesOptions {
-    /**
-     * Path to configuration file.
-     */
-    config?: string;
-    /**
-     * Load the default configuration
-     * @default true
-     */
-    defaultConfiguration?: boolean;
-    /**
-     * Use color in the output.
-     * `true` to force color, `false` to turn off color.
-     * `undefined` to use color if the output is a TTY.
-     */
-    color?: boolean | undefined;
-    /**
-     * Show enabled:
-     * - `true` to show only enabled dictionaries.
-     * - `false` to show only disabled dictionaries.
-     * - `undefined` to show all dictionaries.
-     */
-    enabled?: boolean | undefined;
-    /**
-     * The locale to use when listing dictionaries.
-     */
-    locale?: string;
-    /**
-     * The file type to use when listing dictionaries.
-     */
-    fileType?: string;
-    /**
-     * show the language locales supported by the dictionary.
-     */
-    showLocales?: boolean;
-    /**
-     * show the file types supported by the dictionary.
-     */
-    showFileTypes?: boolean;
-    /**
-     * Dhow the location of the dictionary.
-     */
-    showLocation?: boolean;
-    pathFormat?: 'hide' | 'short' | 'long' | 'full';
-}
-export interface LegacyOptions {
-    local?: string;
-}
-export type LegacyFixes = Pick<BaseOptions, 'locale'>;
-export interface BaseOptions {
-    /**
-     * Path to configuration file.
-     */
-    config?: string;
-    /**
-     * Programming Language ID.
-     */
-    languageId?: string;
-    /**
-     * Locale to use.
-     */
-    locale?: string;
-    /**
-     * Load the default configuration
-     * @default true
-     */
-    defaultConfiguration?: boolean;
-    /**
-     * Check In-Document CSpell directives for correctness.
-     */
-    validateDirectives?: boolean;
-    /**
-     * Return an exit code if there are issues found.
-     * @default true
-     */
-    exitCode?: boolean;
-    /**
-     * Execution flags.
-     * Used primarily for releasing experimental features.
-     * Flags are of the form key:value
-     */
-    flag?: string[];
-    /**
-     * Use color in the output.
-     * `true` to force color, `false` to turn off color.
-     * `undefined` to use color if the output is a TTY.
-     */
-    color?: boolean | undefined;
-}
-export interface LinterCliOptions extends LinterOptions {
-    /**
-     * Show legacy output
-     */
-    legacy?: 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;
-    /**
-     * Files must be found or cli will exit with an error.
-     */
-    mustFindFiles?: boolean;
-    /**
-     * Generate a summary report of issues.
-     */
-    issuesSummaryReport?: boolean;
-    /**
-     * Generate a summary report of performance.
-     */
-    showPerfSummary?: boolean;
-    /**
-     * Set the template to use when reporting issues.
-     *
-     * The template is a string that can contain the following placeholders:
-     * - `$filename` - the file name
-     * - `$col` - the column number
-     * - `$row` - the row number
-     * - `$text` - the word that is misspelled
-     * - `$message` - the issues message: "unknown word", "word is misspelled", etc.
-     * - `$messageColored` - the issues message with color based upon the message type.
-     * - `$uri` - the URI of the file
-     * - `$suggestions` - suggestions for the misspelled word (if requested)
-     * - `$quickFix` - possible quick fixes for the misspelled word.
-     * - `$contextFull` - the full context of the misspelled word.
-     * - `$contextLeft` - the context to the left of the misspelled word.
-     * - `$contextRight` - the context to the right of the misspelled word.
-     *
-     * Color is supported using the following template pattern:
-     * - `{<style[.style]> <text>}` - where `<style>` is a style name and `<text>` is the text to style.
-     *
-     * Styles
-     * - `bold`, `italic`, `underline`, `strikethrough`, `dim`, `inverse`
-     * - `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`
-     *
-     * Example:
-     * @example "{green $filename}:{yellow $row}:{yellow $col} $message {red $text} $quickFix {dim $suggestions}"
-     * @since 8.12.0
-     */
-    issueTemplate?: string;
-    /**
-     * Prevents searching for local configuration files
-     *
-     * When `--no-config-search` is passed on the command line, this will be `true`.
-     * If the flag is not passed, it defaults to `false`.
-     */
-    configSearch?: boolean;
-    /**
-     * Directory paths at which CSpell should stop searching for configuration files.
-     *
-     * These are set via one or more `--stop-config-search-at <dir>` CLI options.
-     * If no flags are passed, this will be `undefined`.
-     */
-    stopConfigSearchAt?: string[];
-    report?: ReportChoices | undefined;
-}
-export type ReportChoices = 'all' | 'simple' | 'typos' | 'flagged';
-export declare const ReportChoicesAll: readonly ReportChoices[];
-export declare function fixLegacy<T extends LegacyFixes>(opts: T & LegacyOptions): Omit<T & LegacyOptions, 'local'>;
-export interface CSpellConfigFile {
-    url: URL;
-    settings: CSpellSettings;
-}
-//# sourceMappingURL=options.d.ts.map

package/dist/esm/options.js

@@ -1,9 +0,0 @@
-export const ReportChoicesAll = ['all', 'simple', 'typos', 'flagged'];
-export function fixLegacy(opts) {
-    const { local, ...rest } = opts;
-    if (local && !rest.locale) {
-        rest.locale = local;
-    }
-    return rest;
-}
-//# sourceMappingURL=options.js.map

package/dist/esm/pkgInfo.d.ts

@@ -1,14 +0,0 @@
-export { pkgDir } from './dirname.js';
-export declare const name = "cspell";
-export declare const version = "9.1.2";
-export declare const engines: {
-    node: string;
-};
-export declare const npmPackage: {
-    name: string;
-    version: string;
-    engines: {
-        node: string;
-    };
-};
-//# sourceMappingURL=pkgInfo.d.ts.map

package/dist/esm/pkgInfo.js

@@ -1,7 +0,0 @@
-// This file is generated by tools/patch-version.mjs
-export { pkgDir } from './dirname.js';
-export const name = 'cspell';
-export const version = '9.1.2';
-export const engines = { node: '>=20' };
-export const npmPackage = { name, version, engines };
-//# sourceMappingURL=pkgInfo.js.map

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

@@ -1,18 +0,0 @@
-export declare function simpleRepl(): AsyncIterable<string>;
-export type CompleterResult = [string[], string];
-export 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/esm/repl/index.js

@@ -1,52 +0,0 @@
-import * as readline from 'node:readline';
-export function simpleRepl() {
-    return new SimpleRepl();
-}
-export class SimpleRepl {
-    prompt;
-    beforeEach;
-    completer;
-    _history;
-    rl;
-    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 };
-    }
-}
-//# sourceMappingURL=index.js.map

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

@@ -1,31 +0,0 @@
-import type { CSpellReporter, Issue, ProgressItem, RunResult } from '@cspell/cspell-types';
-export interface InMemoryResult {
-    log: string[];
-    issues: Issue[];
-    runResult: RunResult | undefined;
-}
-/**
- * Simple reporter for test purposes
- */
-export declare class InMemoryReporter implements CSpellReporter, InMemoryResult {
-    log: string[];
-    errors: Error[];
-    issueCount: number;
-    errorCount: number;
-    debugCount: number;
-    infoCount: number;
-    progressCount: number;
-    issues: Issue[];
-    runResult: RunResult | undefined;
-    issue(issue: Issue): void;
-    error(message: string, error: Error): void;
-    info(message: string): void;
-    debug(message: string): void;
-    progress(p: ProgressItem): void;
-    result(r: RunResult): void;
-    dump(): InMemoryResult;
-    get features(): {
-        issueType: boolean;
-    };
-}
-//# sourceMappingURL=InMemoryReporter.d.ts.map

package/dist/esm/util/InMemoryReporter.js

@@ -1,49 +0,0 @@
-/**
- * Simple reporter for test purposes
- */
-export class InMemoryReporter {
-    log = [];
-    errors = [];
-    issueCount = 0;
-    errorCount = 0;
-    debugCount = 0;
-    infoCount = 0;
-    progressCount = 0;
-    issues = [];
-    runResult;
-    issue(issue) {
-        this.issues.push(issue);
-        this.issueCount += 1;
-        const { uri, row, col, text } = issue;
-        this.log.push(`Issue: ${uri}[${row}, ${col}]: Unknown word: ${text}`);
-    }
-    error(message, error) {
-        this.errorCount += 1;
-        this.errors.push(error);
-        this.log.push(`Error: ${message} ${error.toString()}`);
-    }
-    info(message) {
-        this.infoCount += 1;
-        this.log.push(`Info: ${message}`);
-    }
-    debug(message) {
-        this.debugCount += 1;
-        this.log.push(`Debug: ${message}`);
-    }
-    progress(p) {
-        this.progressCount += 1;
-        this.log.push(`Progress: ${p.type} ${p.fileNum} ${p.fileCount} ${p.filename}`);
-    }
-    result(r) {
-        this.runResult = r;
-    }
-    dump() {
-        return { log: this.log, issues: this.issues, runResult: this.runResult };
-    }
-    get features() {
-        return {
-            issueType: true,
-        };
-    }
-}
-//# sourceMappingURL=InMemoryReporter.js.map

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

@@ -1,14 +0,0 @@
-import { Issue, ReportIssueOptions } from '@cspell/cspell-types';
-import { FileInfo, Perf } from './fileHelper.js';
-export interface LintFileResult {
-    fileInfo: FileInfo;
-    processed: boolean;
-    issues: Issue[];
-    errors: number;
-    configErrors: number;
-    elapsedTimeMs: number | undefined;
-    perf?: Perf | undefined;
-    cached?: boolean;
-    reportIssueOptions?: ReportIssueOptions | undefined;
-}
-//# sourceMappingURL=LintFileResult.d.ts.map

package/dist/esm/util/LintFileResult.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=LintFileResult.js.map

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

@@ -1,3 +0,0 @@
-export { helpers as asyncHelpers, toArray as asyncIterableToArray, operators as asyncOperators, pipeAsync as asyncPipe, toAsyncIterable as mergeAsyncIterables, } from '@cspell/cspell-pipe';
-export declare const asyncMap: typeof import("@cspell/cspell-pipe/operators").opMapAsync, asyncFilter: typeof import("@cspell/cspell-pipe/operators").opFilterAsync, asyncAwait: typeof import("@cspell/cspell-pipe").opAwaitAsync, asyncFlatten: typeof import("@cspell/cspell-pipe/operators").opFlattenAsync;
-//# sourceMappingURL=async.d.ts.map

package/dist/esm/util/async.js

@@ -1,4 +0,0 @@
-import { operators } from '@cspell/cspell-pipe';
-export { helpers as asyncHelpers, toArray as asyncIterableToArray, operators as asyncOperators, pipeAsync as asyncPipe, toAsyncIterable as mergeAsyncIterables, } from '@cspell/cspell-pipe';
-export const { opMapAsync: asyncMap, opFilterAsync: asyncFilter, opAwaitAsync: asyncAwait, opFlattenAsync: asyncFlatten, } = operators;
-//# sourceMappingURL=async.js.map

package/dist/esm/util/cache/CSpellLintResultCache.d.ts

@@ -1,20 +0,0 @@
-import type { LintFileResult } from '../LintFileResult.js';
-export interface CSpellLintResultCache {
-    /**
-     * Retrieve cached lint results for a given file name, if present in the cache.
-     */
-    getCachedLintResults(filename: string): Promise<LintFileResult | undefined>;
-    /**
-     * Set the cached lint results.
-     */
-    setCachedLintResults(result: LintFileResult, dependsUponFiles: string[]): void;
-    /**
-     * Persists the in-memory cache to disk.
-     */
-    reconcile(): void;
-    /**
-     * Resets the cache.
-     */
-    reset(): void;
-}
-//# sourceMappingURL=CSpellLintResultCache.d.ts.map

package/dist/esm/util/cache/CSpellLintResultCache.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=CSpellLintResultCache.js.map

package/dist/esm/util/cache/CacheOptions.d.ts

@@ -1,34 +0,0 @@
-import type { CacheFormat, CacheStrategy } from '@cspell/cspell-types';
-export interface CacheOptions {
-    /**
-     * The version of `cspell` that made the cache entry.
-     * Cache entries must match the `major.minor` version.
-     */
-    version: string;
-    /**
-     * Store the info about processed files in order to only operate on the changed ones.
-     */
-    cache?: boolean;
-    /**
-     * Path to the cache location. Can be a file or a directory.
-     * If none specified .cspellcache will be used.
-     * The file will be created in the directory where the cspell command is executed.
-     */
-    cacheLocation?: string;
-    /**
-     * Strategy to use for detecting changed files, default: metadata
-     */
-    cacheStrategy?: CacheStrategy;
-    /**
-     * Resets the cache
-     */
-    cacheReset?: boolean;
-    /**
-     * Format of the cache file.
-     * - `legacy` - use absolute paths in the cache file
-     * - `universal` - use a sharable format.
-     * @default 'legacy'
-     */
-    cacheFormat?: CacheFormat;
-}
-//# sourceMappingURL=CacheOptions.d.ts.map

package/dist/esm/util/cache/CacheOptions.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=CacheOptions.js.map