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

package/dist/cjs/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/cjs/repl/index.js

@@ -1,75 +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;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SimpleRepl = exports.simpleRepl = void 0;
-const readline = __importStar(require("readline"));
-function simpleRepl() {
-    return new SimpleRepl();
-}
-exports.simpleRepl = simpleRepl;
-class SimpleRepl {
-    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 };
-    }
-}
-exports.SimpleRepl = SimpleRepl;
-//# sourceMappingURL=index.js.map

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

@@ -1,28 +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;
-}
-//# sourceMappingURL=InMemoryReporter.d.ts.map

package/dist/cjs/util/InMemoryReporter.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InMemoryReporter = void 0;
-/**
- * Simple reporter for test purposes
- */
-class InMemoryReporter {
-    constructor() {
-        this.log = [];
-        this.errors = [];
-        this.issueCount = 0;
-        this.errorCount = 0;
-        this.debugCount = 0;
-        this.infoCount = 0;
-        this.progressCount = 0;
-        this.issues = [];
-        this.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}`);
-        };
-        this.error = (message, error) => {
-            this.errorCount += 1;
-            this.errors.push(error);
-            this.log.push(`Error: ${message} ${error.toString()}`);
-        };
-        this.info = (message) => {
-            this.infoCount += 1;
-            this.log.push(`Info: ${message}`);
-        };
-        this.debug = (message) => {
-            this.debugCount += 1;
-            this.log.push(`Debug: ${message}`);
-        };
-        this.progress = (p) => {
-            this.progressCount += 1;
-            this.log.push(`Progress: ${p.type} ${p.fileNum} ${p.fileCount} ${p.filename}`);
-        };
-        this.result = (r) => {
-            this.runResult = r;
-        };
-        this.dump = () => ({ log: this.log, issues: this.issues, runResult: this.runResult });
-    }
-}
-exports.InMemoryReporter = InMemoryReporter;
-//# sourceMappingURL=InMemoryReporter.js.map

package/dist/cjs/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/cjs/util/async.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.asyncFlatten = exports.asyncAwait = exports.asyncFilter = exports.asyncMap = exports.mergeAsyncIterables = exports.asyncPipe = exports.asyncOperators = exports.asyncIterableToArray = exports.asyncHelpers = void 0;
-const cspell_pipe_1 = require("@cspell/cspell-pipe");
-var cspell_pipe_2 = require("@cspell/cspell-pipe");
-Object.defineProperty(exports, "asyncHelpers", { enumerable: true, get: function () { return cspell_pipe_2.helpers; } });
-Object.defineProperty(exports, "asyncIterableToArray", { enumerable: true, get: function () { return cspell_pipe_2.toArray; } });
-Object.defineProperty(exports, "asyncOperators", { enumerable: true, get: function () { return cspell_pipe_2.operators; } });
-Object.defineProperty(exports, "asyncPipe", { enumerable: true, get: function () { return cspell_pipe_2.pipeAsync; } });
-Object.defineProperty(exports, "mergeAsyncIterables", { enumerable: true, get: function () { return cspell_pipe_2.toAsyncIterable; } });
-exports.asyncMap = cspell_pipe_1.operators.opMapAsync, exports.asyncFilter = cspell_pipe_1.operators.opFilterAsync, exports.asyncAwait = cspell_pipe_1.operators.opAwaitAsync, exports.asyncFlatten = cspell_pipe_1.operators.opFlattenAsync;
-//# sourceMappingURL=async.js.map

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

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

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

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=CSpellLintResultCache.js.map

package/dist/cjs/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/cjs/util/cache/CacheOptions.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=CacheOptions.js.map

package/dist/cjs/util/cache/DiskCache.d.ts

@@ -1,63 +0,0 @@
-import type { FileResult } from '../../util/fileHelper.js';
-import type { CSpellLintResultCache } from './CSpellLintResultCache.js';
-import type { FileDescriptor } from './fileEntryCache.js';
-export type CachedFileResult = Omit<FileResult, 'fileInfo' | 'elapsedTimeMs' | 'cached'>;
-/**
- * This is the data cached.
- * Property names are short to help keep the cache file size small.
- */
-interface CachedData {
-    /** meta version + suffix */
-    v?: string | undefined;
-    /** results */
-    r?: CachedFileResult | undefined;
-    /** dependencies */
-    d?: Dependency[] | undefined;
-}
-interface Dependency {
-    /** filename */
-    f: string;
-    /** hash of file contents */
-    h?: string | undefined;
-}
-interface CSpellCachedMetaData {
-    data?: CachedData;
-}
-type Meta = FileDescriptor['meta'];
-export type CSpellCacheMeta = (Meta & CSpellCachedMetaData) | undefined;
-/**
- * Caches cspell results on disk
- */
-export declare class DiskCache implements CSpellLintResultCache {
-    readonly useCheckSum: boolean;
-    readonly cspellVersion: string;
-    readonly useUniversalCache: boolean;
-    readonly cacheFileLocation: string;
-    private cacheDir;
-    private fileEntryCache;
-    private dependencyCache;
-    private dependencyCacheTree;
-    private objectCollection;
-    private ocCacheFileResult;
-    readonly version: string;
-    constructor(cacheFileLocation: string, useCheckSum: boolean, cspellVersion: string, useUniversalCache: boolean);
-    getCachedLintResults(filename: string): Promise<FileResult | undefined>;
-    setCachedLintResults({ fileInfo, elapsedTimeMs, cached, ...result }: FileResult, dependsUponFiles: string[]): void;
-    reconcile(): void;
-    reset(): void;
-    private normalizeResult;
-    private calcDependencyHashes;
-    private checkDependency;
-    private getDependency;
-    private getFileDep;
-    private checkDependencies;
-    private getHash;
-    private resolveFile;
-    private toRelFile;
-}
-declare function calcVersion(version: string): string;
-export declare const __testing__: {
-    calcVersion: typeof calcVersion;
-};
-export {};
-//# sourceMappingURL=DiskCache.d.ts.map

package/dist/cjs/util/cache/DiskCache.js

@@ -1,237 +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.__testing__ = exports.DiskCache = void 0;
-const assert_1 = __importDefault(require("assert"));
-const crypto = __importStar(require("crypto"));
-const fs = __importStar(require("fs"));
-const path_1 = require("path");
-const fileHelper_js_1 = require("../../util/fileHelper.js");
-const fileEntryCache_js_1 = require("./fileEntryCache.js");
-const ObjectCollection_js_1 = require("./ObjectCollection.js");
-const cacheDataKeys = {
-    v: 'v',
-    r: 'r',
-    d: 'd',
-};
-/**
- * Meta Data Version is used to detect if the structure of the meta data has changed.
- * This is used in combination with the Suffix and the version of CSpell.
- */
-const META_DATA_BASE_VERSION = '1';
-const META_DATA_VERSION_SUFFIX = '-' + META_DATA_BASE_VERSION + '-' + Object.keys(cacheDataKeys).join('|');
-/**
- * Caches cspell results on disk
- */
-class DiskCache {
-    constructor(cacheFileLocation, useCheckSum, cspellVersion, useUniversalCache) {
-        this.useCheckSum = useCheckSum;
-        this.cspellVersion = cspellVersion;
-        this.useUniversalCache = useUniversalCache;
-        this.dependencyCache = new Map();
-        this.dependencyCacheTree = {};
-        this.objectCollection = new ObjectCollection_js_1.ShallowObjectCollection();
-        this.ocCacheFileResult = new ObjectCollection_js_1.ShallowObjectCollection();
-        this.cacheFileLocation = (0, path_1.resolve)(cacheFileLocation);
-        this.cacheDir = (0, path_1.dirname)(this.cacheFileLocation);
-        this.fileEntryCache = (0, fileEntryCache_js_1.createFromFile)(this.cacheFileLocation, useCheckSum, useUniversalCache);
-        this.version = calcVersion(cspellVersion);
-    }
-    async getCachedLintResults(filename) {
-        filename = (0, fileEntryCache_js_1.normalizePath)(filename);
-        const fileDescriptor = this.fileEntryCache.getFileDescriptor(filename);
-        const meta = fileDescriptor.meta;
-        const data = meta?.data;
-        const result = data?.r;
-        const versionMatches = this.version === data?.v;
-        // Cached lint results are valid if and only if:
-        // 1. The file is present in the filesystem
-        // 2. The file has not changed since the time it was previously linted
-        // 3. The CSpell configuration has not changed since the time the file was previously linted
-        // If any of these are not true, we will not reuse the lint results.
-        if (fileDescriptor.notFound ||
-            fileDescriptor.changed ||
-            !meta ||
-            !result ||
-            !versionMatches ||
-            !this.checkDependencies(data.d)) {
-            return undefined;
-        }
-        const dd = { ...data };
-        if (dd.d) {
-            dd.d = setTreeEntry(this.dependencyCacheTree, dd.d);
-        }
-        dd.r = dd.r && this.normalizeResult(dd.r);
-        meta.data = this.objectCollection.get(dd);
-        // Skip reading empty files and files without lint error
-        const hasErrors = !!result && (result.errors > 0 || result.configErrors > 0 || result.issues.length > 0);
-        const cached = true;
-        const shouldReadFile = cached && hasErrors;
-        return {
-            ...result,
-            elapsedTimeMs: undefined,
-            fileInfo: shouldReadFile ? await (0, fileHelper_js_1.readFileInfo)(filename) : { filename },
-            cached,
-        };
-    }
-    setCachedLintResults({ fileInfo, elapsedTimeMs: _, cached: __, ...result }, dependsUponFiles) {
-        const fileDescriptor = this.fileEntryCache.getFileDescriptor(fileInfo.filename);
-        const meta = fileDescriptor.meta;
-        if (fileDescriptor.notFound || !meta) {
-            return;
-        }
-        const data = this.objectCollection.get({
-            v: this.version,
-            r: this.normalizeResult(result),
-            d: this.calcDependencyHashes(dependsUponFiles),
-        });
-        meta.data = data;
-    }
-    reconcile() {
-        this.fileEntryCache.reconcile();
-    }
-    reset() {
-        this.fileEntryCache.destroy();
-        this.dependencyCache.clear();
-        this.dependencyCacheTree = {};
-        this.objectCollection = new ObjectCollection_js_1.ShallowObjectCollection();
-        this.ocCacheFileResult = new ObjectCollection_js_1.ShallowObjectCollection();
-    }
-    normalizeResult(result) {
-        const { issues, processed, errors, configErrors, ...rest } = result;
-        if (!Object.keys(rest).length) {
-            return this.ocCacheFileResult.get(result);
-        }
-        return this.ocCacheFileResult.get({ issues, processed, errors, configErrors });
-    }
-    calcDependencyHashes(dependsUponFiles) {
-        dependsUponFiles.sort();
-        const c = getTreeEntry(this.dependencyCacheTree, dependsUponFiles);
-        if (c?.d) {
-            return c.d;
-        }
-        const dependencies = dependsUponFiles.map((f) => this.getDependency(f));
-        return setTreeEntry(this.dependencyCacheTree, dependencies);
-    }
-    checkDependency(dep) {
-        const depFile = this.resolveFile(dep.f);
-        const cDep = this.dependencyCache.get(depFile);
-        if (cDep && compDep(dep, cDep))
-            return true;
-        if (cDep)
-            return false;
-        const d = this.getFileDep(depFile);
-        if (compDep(dep, d)) {
-            this.dependencyCache.set(depFile, dep);
-            return true;
-        }
-        this.dependencyCache.set(depFile, d);
-        return false;
-    }
-    getDependency(file) {
-        const dep = this.dependencyCache.get(file);
-        if (dep)
-            return dep;
-        const d = this.getFileDep(file);
-        this.dependencyCache.set(file, d);
-        return d;
-    }
-    getFileDep(file) {
-        (0, assert_1.default)((0, path_1.isAbsolute)(file), `Dependency must be absolute "${file}"`);
-        const f = this.toRelFile(file);
-        let h;
-        try {
-            const buffer = fs.readFileSync(file);
-            h = this.getHash(buffer);
-        }
-        catch (e) {
-            return { f };
-        }
-        return { f, h };
-    }
-    checkDependencies(dependencies) {
-        if (!dependencies)
-            return false;
-        for (const dep of dependencies) {
-            if (!this.checkDependency(dep)) {
-                return false;
-            }
-        }
-        return true;
-    }
-    getHash(buffer) {
-        return crypto.createHash('md5').update(buffer).digest('hex');
-    }
-    resolveFile(file) {
-        return (0, fileEntryCache_js_1.normalizePath)((0, path_1.resolve)(this.cacheDir, file));
-    }
-    toRelFile(file) {
-        return (0, fileEntryCache_js_1.normalizePath)(this.useUniversalCache ? (0, path_1.relative)(this.cacheDir, file) : file);
-    }
-}
-exports.DiskCache = DiskCache;
-function getTreeEntry(tree, keys) {
-    let r = tree;
-    for (const k of keys) {
-        r = r.c?.get(k);
-        if (!r)
-            return r;
-    }
-    return r;
-}
-function setTreeEntry(tree, deps, update = false) {
-    let r = tree;
-    for (const d of deps) {
-        const k = d.f;
-        if (!r.c) {
-            r.c = new Map();
-        }
-        const cn = r.c.get(k);
-        const n = cn ?? {};
-        if (!cn) {
-            r.c.set(k, n);
-        }
-        r = n;
-    }
-    let d = r.d;
-    if (!d || (r.d && update)) {
-        r.d = deps;
-        d = deps;
-    }
-    return d;
-}
-function compDep(a, b) {
-    return a.f === b.f && a.h === b.h;
-}
-function calcVersion(version) {
-    return version + META_DATA_VERSION_SUFFIX;
-}
-exports.__testing__ = {
-    calcVersion,
-};
-//# sourceMappingURL=DiskCache.js.map

package/dist/cjs/util/cache/DummyCache.d.ts

@@ -1,11 +0,0 @@
-import type { CSpellLintResultCache } from './CSpellLintResultCache.js';
-/**
- * Dummy cache implementation that should be usd if caching option is disabled.
- */
-export declare class DummyCache implements CSpellLintResultCache {
-    getCachedLintResults(): Promise<undefined>;
-    setCachedLintResults(): void;
-    reconcile(): void;
-    reset(): void;
-}
-//# sourceMappingURL=DummyCache.d.ts.map

package/dist/cjs/util/cache/DummyCache.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DummyCache = void 0;
-/**
- * Dummy cache implementation that should be usd if caching option is disabled.
- */
-class DummyCache {
-    getCachedLintResults() {
-        return Promise.resolve(undefined);
-    }
-    setCachedLintResults() {
-        return;
-    }
-    reconcile() {
-        return;
-    }
-    reset() {
-        return;
-    }
-}
-exports.DummyCache = DummyCache;
-//# sourceMappingURL=DummyCache.js.map

package/dist/cjs/util/cache/ObjectCollection.d.ts

@@ -1,17 +0,0 @@
-export declare class ShallowObjectCollection<T extends object> {
-    private tree;
-    get(v: T): T;
-}
-export declare class Collection {
-    private col;
-    /**
-     * Add a plain object to the collection.
-     * The actual object used is returned.
-     * By adding the object to the collection, it is now owned by the collection.
-     * Do not add class objects.
-     * @param v any object or primitive
-     * @returns v or the matching object.
-     */
-    add<T>(v: T): T;
-}
-//# sourceMappingURL=ObjectCollection.d.ts.map