cspell 7.0.0-alpha.1 → 7.0.1-alpha.0

package/dist/cjs/lint/lint.js

@@ -1,499 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.runLint = void 0;
-const cspell_pipe_1 = require("@cspell/cspell-pipe");
-const sync_1 = require("@cspell/cspell-pipe/sync");
-const cspell_types_1 = require("@cspell/cspell-types");
-const chalk_1 = __importDefault(require("chalk"));
-const cspell_gitignore_1 = require("cspell-gitignore");
-const cspell_glob_1 = require("cspell-glob");
-const cspell = __importStar(require("cspell-lib"));
-const path = __importStar(require("path"));
-const util_1 = require("util");
-const pkgInfo_cjs_1 = require("../../lib/pkgInfo.cjs");
-const uri_cjs_1 = require("../../lib/uri.cjs");
-const index_js_1 = require("../featureFlags/index.js");
-const index_js_2 = require("../util/cache/index.js");
-const errors_js_1 = require("../util/errors.js");
-const fileHelper_js_1 = require("../util/fileHelper.js");
-const glob_js_1 = require("../util/glob.js");
-const prefetch_js_1 = require("../util/prefetch.js");
-const reporters_js_1 = require("../util/reporters.js");
-const timer_js_1 = require("../util/timer.js");
-const util = __importStar(require("../util/util.js"));
-const version = pkgInfo_cjs_1.npmPackage.version;
-const BATCH_SIZE = 8;
-const { opFilterAsync } = cspell_pipe_1.operators;
-async function runLint(cfg) {
-    let { reporter } = cfg;
-    cspell.setLogger(getLoggerFromReporter(reporter));
-    const configErrors = new Set();
-    const timer = (0, timer_js_1.getTimeMeasurer)();
-    const lintResult = await run();
-    await reporter.result(lintResult);
-    const elapsed = timer();
-    if ((0, index_js_1.getFeatureFlags)().getFlag('timer')) {
-        console.log(`Elapsed Time: ${elapsed.toFixed(2)}ms`);
-    }
-    return lintResult;
-    function prefetch(filename, configInfo, cache) {
-        if ((0, fileHelper_js_1.isBinaryFile)(filename, cfg.root))
-            return { filename, result: Promise.resolve({ skip: true }) };
-        async function fetch() {
-            const getElapsedTimeMs = (0, timer_js_1.getTimeMeasurer)();
-            const cachedResult = await cache.getCachedLintResults(filename);
-            if (cachedResult) {
-                reporter.debug(`Filename: ${filename}, using cache`);
-                const fileResult = { ...cachedResult, elapsedTimeMs: getElapsedTimeMs() };
-                return { fileResult };
-            }
-            const uri = (0, fileHelper_js_1.filenameToUri)(filename, cfg.root);
-            const checkResult = await cspell.shouldCheckDocument({ uri }, {}, configInfo.config);
-            if (!checkResult.shouldCheck)
-                return { skip: true };
-            const fileInfo = await (0, fileHelper_js_1.readFileInfo)(filename, undefined, true);
-            return { fileInfo };
-        }
-        const result = fetch();
-        return { filename, result };
-    }
-    async function processFile(filename, configInfo, cache, prefetch) {
-        if (prefetch?.fileResult)
-            return prefetch.fileResult;
-        const getElapsedTimeMs = (0, timer_js_1.getTimeMeasurer)();
-        const cachedResult = await cache.getCachedLintResults(filename);
-        if (cachedResult) {
-            reporter.debug(`Filename: ${filename}, using cache`);
-            return { ...cachedResult, elapsedTimeMs: getElapsedTimeMs() };
-        }
-        const result = {
-            fileInfo: {
-                filename,
-            },
-            issues: [],
-            processed: false,
-            errors: 0,
-            configErrors: 0,
-            elapsedTimeMs: 0,
-        };
-        const fileInfo = prefetch?.fileInfo || (await (0, fileHelper_js_1.readFileInfo)(filename, undefined, true));
-        if (fileInfo.errorCode) {
-            if (fileInfo.errorCode !== 'EISDIR' && cfg.options.mustFindFiles) {
-                const err = (0, errors_js_1.toError)(`File not found: "${filename}"`);
-                reporter.error('Linter:', err);
-                result.errors += 1;
-            }
-            return result;
-        }
-        const doc = (0, fileHelper_js_1.fileInfoToDocument)(fileInfo, cfg.options.languageId, cfg.locale);
-        const { text } = fileInfo;
-        result.fileInfo = fileInfo;
-        let spellResult = {};
-        reporter.info(`Checking: ${filename}, File type: ${doc.languageId ?? 'auto'}, Language: ${doc.locale ?? 'default'}`, cspell_types_1.MessageTypes.Info);
-        try {
-            const { showSuggestions: generateSuggestions, validateDirectives } = cfg.options;
-            const numSuggestions = configInfo.config.numSuggestions ?? 5;
-            const validateOptions = util.clean({ generateSuggestions, numSuggestions, validateDirectives });
-            const r = await cspell.spellCheckDocument(doc, validateOptions, configInfo.config);
-            spellResult = r;
-            result.processed = r.checked;
-            result.issues = cspell.Text.calculateTextDocumentOffsets(doc.uri, text, r.issues).map(mapIssue);
-        }
-        catch (e) {
-            reporter.error(`Failed to process "${filename}"`, (0, errors_js_1.toError)(e));
-            result.errors += 1;
-        }
-        result.elapsedTimeMs = getElapsedTimeMs();
-        const config = spellResult.settingsUsed ?? {};
-        result.configErrors += await reportConfigurationErrors(config);
-        const elapsed = result.elapsedTimeMs / 1000.0;
-        const dictionaries = config.dictionaries || [];
-        reporter.info(`Checked: ${filename}, File type: ${config.languageId}, Language: ${config.language} ... Issues: ${result.issues.length} ${elapsed}S`, cspell_types_1.MessageTypes.Info);
-        reporter.info(`Config file Used: ${spellResult.localConfigFilepath || configInfo.source}`, cspell_types_1.MessageTypes.Info);
-        reporter.info(`Dictionaries Used: ${dictionaries.join(', ')}`, cspell_types_1.MessageTypes.Info);
-        if (cfg.options.debug) {
-            const { id: _id, name: _name, __imports, __importRef, ...cfg } = config;
-            const debugCfg = {
-                filename,
-                languageId: doc.languageId ?? cfg.languageId ?? 'default',
-                config: { ...cfg, source: null },
-                source: spellResult.localConfigFilepath,
-            };
-            reporter.debug(JSON.stringify(debugCfg, undefined, 2));
-        }
-        const dep = calcDependencies(config);
-        cache.setCachedLintResults(result, dep.files);
-        return result;
-    }
-    function mapIssue({ doc: _, ...tdo }) {
-        const context = cfg.showContext
-            ? extractContext(tdo, cfg.showContext)
-            : { text: tdo.line.text.trimEnd(), offset: tdo.line.offset };
-        return util.clean({ ...tdo, context });
-    }
-    async function processFiles(files, configInfo, cacheSettings) {
-        const fileCount = files instanceof Array ? files.length : undefined;
-        const status = runResult();
-        const cache = (0, index_js_2.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,
-        }));
-        function* prefetchFiles(files) {
-            const iter = (0, prefetch_js_1.prefetchIterable)((0, sync_1.pipe)(files, (0, sync_1.opMap)((filename) => prefetch(filename, configInfo, cache))), BATCH_SIZE);
-            for (const v of iter) {
-                yield v;
-            }
-        }
-        async function* prefetchFilesAsync(files) {
-            for await (const filename of files) {
-                yield prefetch(filename, configInfo, cache);
-            }
-        }
-        const emptyResult = {
-            fileInfo: { filename: '' },
-            issues: [],
-            processed: false,
-            errors: 0,
-            configErrors: 0,
-            elapsedTimeMs: 1,
-        };
-        async function processPrefetchFileResult(pf, index) {
-            const { filename, result: pFetchResult } = pf;
-            const getElapsedTimeMs = (0, timer_js_1.getTimeMeasurer)();
-            const fetchResult = await pFetchResult;
-            emitProgressBegin(filename, index, fileCount ?? index);
-            if (fetchResult?.skip) {
-                return {
-                    filename,
-                    fileNum: index,
-                    result: { ...emptyResult, fileInfo: { filename }, elapsedTimeMs: getElapsedTimeMs() },
-                };
-            }
-            const result = await processFile(filename, configInfo, cache, fetchResult);
-            return { filename, fileNum: index, result };
-        }
-        async function* loadAndProcessFiles() {
-            let i = 0;
-            if ((0, cspell_pipe_1.isAsyncIterable)(files)) {
-                for await (const pf of prefetchFilesAsync(files)) {
-                    yield processPrefetchFileResult(pf, ++i);
-                }
-            }
-            else {
-                for (const pf of prefetchFiles(files)) {
-                    await pf.result;
-                    yield await processPrefetchFileResult(pf, ++i);
-                }
-            }
-        }
-        for await (const fileP of loadAndProcessFiles()) {
-            const { filename, fileNum, result } = await 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;
-                status.errors += result.errors;
-                if (failFast) {
-                    return status;
-                }
-            }
-            status.errors += result.configErrors;
-        }
-        cache.reconcile();
-        return status;
-    }
-    function calcDependencies(config) {
-        const { configFiles, dictionaryFiles } = cspell.extractDependencies(config);
-        return { files: configFiles.concat(dictionaryFiles) };
-    }
-    async function reportConfigurationErrors(config) {
-        const errors = cspell.extractImportErrors(config);
-        let count = 0;
-        errors.forEach((ref) => {
-            const key = ref.error.toString();
-            if (configErrors.has(key))
-                return;
-            configErrors.add(key);
-            count += 1;
-            reporter.error('Configuration', ref.error);
-        });
-        const dictCollection = await cspell.getDictionary(config);
-        dictCollection.dictionaries.forEach((dict) => {
-            const dictErrors = dict.getErrors?.() || [];
-            const msg = `Dictionary Error with (${dict.name})`;
-            dictErrors.forEach((error) => {
-                const key = msg + error.toString();
-                if (configErrors.has(key))
-                    return;
-                configErrors.add(key);
-                count += 1;
-                reporter.error(msg, error);
-            });
-        });
-        return count;
-    }
-    function countConfigErrors(configInfo) {
-        return reportConfigurationErrors(configInfo.config);
-    }
-    async function run() {
-        if (cfg.options.root) {
-            process.env[cspell.ENV_CSPELL_GLOB_ROOT] = cfg.root;
-        }
-        const configInfo = await (0, fileHelper_js_1.readConfig)(cfg.configFile, cfg.root);
-        if (cfg.options.defaultConfiguration !== undefined) {
-            configInfo.config.loadDefaultConfiguration = cfg.options.defaultConfiguration;
-        }
-        const reporterConfig = util.clean({
-            maxNumberOfProblems: configInfo.config.maxNumberOfProblems,
-            maxDuplicateProblems: configInfo.config.maxDuplicateProblems,
-            minWordLength: configInfo.config.minWordLength,
-            ...cfg.options,
-        });
-        const reporters = cfg.options.reporter ?? configInfo.config.reporters;
-        reporter = (0, reporters_js_1.mergeReporters)(...(await (0, reporters_js_1.loadReporters)(reporters, cfg.reporter, reporterConfig)));
-        cspell.setLogger(getLoggerFromReporter(reporter));
-        const globInfo = await determineGlobs(configInfo, cfg);
-        const { fileGlobs, excludeGlobs } = globInfo;
-        const hasFileLists = !!cfg.fileLists.length;
-        if (!fileGlobs.length && !hasFileLists) {
-            // Nothing to do.
-            return runResult();
-        }
-        header(fileGlobs, excludeGlobs);
-        checkGlobs(fileGlobs, reporter);
-        reporter.info(`Config Files Found:\n    ${configInfo.source}\n`, cspell_types_1.MessageTypes.Info);
-        const configErrors = await countConfigErrors(configInfo);
-        if (configErrors)
-            return runResult({ errors: configErrors });
-        // Get Exclusions from the config files.
-        const { root } = cfg;
-        try {
-            const cacheSettings = await (0, index_js_2.calcCacheSettings)(configInfo.config, { ...cfg.options, version }, root);
-            const files = await determineFilesToCheck(configInfo, cfg, reporter, globInfo);
-            return await processFiles(files, configInfo, cacheSettings);
-        }
-        catch (e) {
-            const err = (0, errors_js_1.toApplicationError)(e);
-            reporter.error('Linter', err);
-            return runResult({ errors: 1 });
-        }
-    }
-    function header(files, cliExcludes) {
-        const formattedFiles = files.length > 100 ? files.slice(0, 100).concat(['...']) : files;
-        reporter.info(`
-cspell;
-Date: ${new Date().toUTCString()}
-Options:
-    verbose:   ${yesNo(!!cfg.options.verbose)}
-    config:    ${cfg.configFile || 'default'}
-    exclude:   ${cliExcludes.join('\n               ')}
-    files:     ${formattedFiles}
-    wordsOnly: ${yesNo(!!cfg.options.wordsOnly)}
-    unique:    ${yesNo(!!cfg.options.unique)}
-`, cspell_types_1.MessageTypes.Info);
-    }
-}
-exports.runLint = runLint;
-function checkGlobs(globs, reporter) {
-    globs
-        .filter((g) => g.startsWith("'") || g.endsWith("'"))
-        .map((glob) => chalk_1.default.yellow(glob))
-        .forEach((glob) => reporter.error('Linter', new errors_js_1.CheckFailed(`Glob starting or ending with ' (single quote) is not likely to match any files: ${glob}.`)));
-}
-async function determineGlobs(configInfo, cfg) {
-    const useGitignore = cfg.options.gitignore ?? configInfo.config.useGitignore ?? false;
-    const gitignoreRoots = cfg.options.gitignoreRoot ?? configInfo.config.gitignoreRoot;
-    const gitIgnore = useGitignore ? await generateGitIgnore(gitignoreRoots) : undefined;
-    const cliGlobs = cfg.fileGlobs;
-    const allGlobs = cliGlobs.length ? cliGlobs : configInfo.config.files || [];
-    const combinedGlobs = await (0, glob_js_1.normalizeFileOrGlobsToRoot)(allGlobs, cfg.root);
-    const cliExcludeGlobs = (0, glob_js_1.extractPatterns)(cfg.excludes).map((p) => p.glob);
-    const normalizedExcludes = (0, glob_js_1.normalizeGlobsToRoot)(cliExcludeGlobs, cfg.root, true);
-    const includeGlobs = combinedGlobs.filter((g) => !g.startsWith('!'));
-    const excludeGlobs = combinedGlobs.filter((g) => g.startsWith('!')).concat(normalizedExcludes);
-    const fileGlobs = includeGlobs;
-    const appGlobs = { allGlobs, gitIgnore, fileGlobs, excludeGlobs, normalizedExcludes };
-    return appGlobs;
-}
-async function determineFilesToCheck(configInfo, cfg, reporter, globInfo) {
-    async function _determineFilesToCheck() {
-        const { fileLists } = cfg;
-        const hasFileLists = !!fileLists.length;
-        const { allGlobs, gitIgnore, fileGlobs, excludeGlobs, normalizedExcludes } = globInfo;
-        // Get Exclusions from the config files.
-        const { root } = cfg;
-        const globsToExclude = (configInfo.config.ignorePaths || []).concat(excludeGlobs);
-        const globMatcher = (0, glob_js_1.buildGlobMatcher)(globsToExclude, root, true);
-        const ignoreGlobs = (0, glob_js_1.extractGlobsFromMatcher)(globMatcher);
-        // cspell:word nodir
-        const globOptions = {
-            root,
-            cwd: root,
-            ignore: ignoreGlobs.concat(normalizedExcludes),
-            nodir: true,
-        };
-        const enableGlobDot = cfg.enableGlobDot ?? configInfo.config.enableGlobDot;
-        if (enableGlobDot !== undefined) {
-            globOptions.dot = enableGlobDot;
-        }
-        const filterFiles = (0, cspell_pipe_1.opFilter)(filterFilesFn(globMatcher));
-        const foundFiles = await (hasFileLists
-            ? useFileLists(fileLists, allGlobs, root, enableGlobDot)
-            : (0, fileHelper_js_1.findFiles)(fileGlobs, globOptions));
-        const filtered = gitIgnore ? await gitIgnore.filterOutIgnored(foundFiles) : foundFiles;
-        const files = (0, cspell_pipe_1.isAsyncIterable)(filtered)
-            ? (0, cspell_pipe_1.pipeAsync)(filtered, filterFiles)
-            : [...(0, cspell_pipe_1.pipeSync)(filtered, filterFiles)];
-        return files;
-    }
-    function isExcluded(filename, globMatcherExclude) {
-        if (cspell.isBinaryFile(uri_cjs_1.URI.file(filename))) {
-            return true;
-        }
-        const { root } = cfg;
-        const absFilename = path.resolve(root, filename);
-        const r = globMatcherExclude.matchEx(absFilename);
-        if (r.matched) {
-            const { glob, source } = extractGlobSource(r.pattern);
-            reporter.info(`Excluded File: ${path.relative(root, absFilename)}; Excluded by ${glob} from ${source}`, cspell_types_1.MessageTypes.Info);
-        }
-        return r.matched;
-    }
-    function filterFilesFn(globMatcherExclude) {
-        const patterns = globMatcherExclude.patterns;
-        const excludeInfo = patterns
-            .map(extractGlobSource)
-            .map(({ glob, source }) => `Glob: ${glob} from ${source}`)
-            .filter(util.uniqueFn());
-        reporter.info(`Exclusion Globs: \n    ${excludeInfo.join('\n    ')}\n`, cspell_types_1.MessageTypes.Info);
-        return (filename) => !isExcluded(filename, globMatcherExclude);
-    }
-    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 {
-        glob: rawGlob || glob,
-        source,
-    };
-}
-function runResult(init = {}) {
-    const { files = 0, filesWithIssues = new Set(), issues = 0, errors = 0, cachedFiles = 0 } = init;
-    return { files, filesWithIssues, issues, errors, cachedFiles };
-}
-function yesNo(value) {
-    return value ? 'Yes' : 'No';
-}
-function getLoggerFromReporter(reporter) {
-    const log = (...params) => {
-        const msg = (0, util_1.format)(...params);
-        reporter.info(msg, 'Info');
-    };
-    const error = (...params) => {
-        const msg = (0, util_1.format)(...params);
-        const err = { message: '', name: 'error', toString: () => '' };
-        reporter.error(msg, err);
-    };
-    const warn = (...params) => {
-        const msg = (0, util_1.format)(...params);
-        reporter.info(msg, 'Warning');
-    };
-    return {
-        log,
-        warn,
-        error,
-    };
-}
-async function generateGitIgnore(roots) {
-    const root = (typeof roots === 'string' ? [roots].filter((r) => !!r) : roots) || [];
-    if (!root?.length) {
-        const cwd = process.cwd();
-        const repo = (await (0, cspell_gitignore_1.findRepoRoot)(cwd)) || cwd;
-        root.push(repo);
-    }
-    return new cspell_gitignore_1.GitIgnore(root?.map((p) => path.resolve(p)));
-}
-async function useFileLists(fileListFiles, includeGlobPatterns, root, dot) {
-    includeGlobPatterns = includeGlobPatterns.length ? includeGlobPatterns : ['**'];
-    const options = { root, mode: 'include' };
-    if (dot !== undefined) {
-        options.dot = dot;
-    }
-    const globMatcher = new cspell_glob_1.GlobMatcher(includeGlobPatterns, options);
-    const filterFiles = (file) => globMatcher.match(file);
-    const files = (0, fileHelper_js_1.readFileListFiles)(fileListFiles);
-    return (0, cspell_pipe_1.pipeAsync)(files, (0, cspell_pipe_1.opFilter)(filterFiles), opFilterAsync(fileHelper_js_1.isNotDir));
-}
-//# sourceMappingURL=lint.js.map

package/dist/cjs/options.d.ts

@@ -1,178 +0,0 @@
-import type { CacheOptions } from './util/cache/index.js';
-export interface LinterOptions extends BaseOptions, Omit<CacheOptions, 'version'> {
-    /**
-     * 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, it will shat number of characters on either side.
-     */
-    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`**
-     */
-    fileList?: string[] | undefined;
-    /**
-     * Files must be found and processed otherwise it is considered an error.
-     */
-    mustFindFiles?: boolean;
-    /**
-     * Stop processing and exit if an issue or error is found.
-     */
-    failFast?: boolean;
-    /**
-     * Optional list of reporters to use, overriding any specified in the
-     * configuration.
-     */
-    reporter?: string[];
-}
-export interface TraceOptions extends BaseOptions {
-    stdin?: boolean;
-    allowCompoundWords?: boolean;
-    ignoreCase?: boolean;
-    all?: boolean;
-    onlyFound?: boolean;
-    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 LegacyOptions {
-    local?: string;
-}
-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;
-    /**
-     * Execution flags.
-     * Used primarily for releasing experimental features.
-     * Flags are of the form key:value
-     */
-    flag?: string[];
-}
-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;
-}
-export declare function fixLegacy<T extends BaseOptions>(opts: T & LegacyOptions): Omit<T & LegacyOptions, 'local'>;
-//# sourceMappingURL=options.d.ts.map

package/dist/cjs/options.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fixLegacy = void 0;
-function fixLegacy(opts) {
-    const { local, ...rest } = opts;
-    if (local && !rest.locale) {
-        rest.locale = local;
-    }
-    return rest;
-}
-exports.fixLegacy = fixLegacy;
-//# sourceMappingURL=options.js.map