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

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

@@ -1,136 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/no-explicit-any */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Collection = exports.ShallowObjectCollection = void 0;
-const compare = Intl.Collator().compare;
-class ShallowObjectCollection {
-    constructor() {
-        this.tree = {};
-    }
-    get(v) {
-        if (typeof v !== 'object' || v === null) {
-            return v;
-        }
-        const keys = Object.entries(v)
-            .filter((entry) => entry[1] !== undefined)
-            .sort((a, b) => compare(a[0], b[0]));
-        let t = this.tree;
-        for (const [key, obj] of keys) {
-            if (!t.c) {
-                t.c = new Map();
-            }
-            const c0 = t.c.get(key);
-            const cc = c0 || new Map();
-            if (!c0) {
-                t.c.set(key, cc);
-            }
-            const c1 = cc.get(obj);
-            const ccc = c1 || {};
-            if (!c1) {
-                cc.set(obj, ccc);
-            }
-            t = ccc;
-        }
-        if (t.v)
-            return t.v;
-        t.v = v;
-        return v;
-    }
-}
-exports.ShallowObjectCollection = ShallowObjectCollection;
-class Collection {
-    constructor() {
-        this.col = { contains: new Map() };
-    }
-    /**
-     * 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(v) {
-        return addToCollection(this.col, v);
-    }
-}
-exports.Collection = Collection;
-// const objectLike: TypeMask = {
-//     array: true,
-//     object: true,
-// };
-function addToCollection(root, v) {
-    const known = root.contains;
-    function addValToCol(c, v) {
-        const t = toValueType(v);
-        const val = c.v || Object.create(null);
-        const r = val[t] ?? v;
-        val[t] = r;
-        c.v = val;
-        return val[t];
-    }
-    function walk(col, path) {
-        path = path.filter((entry) => entry[1] !== undefined).sort((a, b) => compare(a[0], b[0]));
-        for (const [k, v] of path) {
-            const c = col.c || Object.create(null);
-            col.c = c;
-            const m = c[k] || new Map();
-            c[k] = m;
-            const has = m.get(v);
-            col = has || Object.create(null);
-            if (!has) {
-                m.set(v, col);
-            }
-        }
-        return col;
-    }
-    function normalizeObjectEntries(entries) {
-        for (const entry of entries) {
-            entry[1] = add(entry[1]);
-        }
-        return entries;
-    }
-    function normalizeToPath(v) {
-        if (typeof v !== 'object' || !v) {
-            return [['', v]];
-        }
-        const entries = normalizeObjectEntries(Object.entries(v));
-        const obj = v;
-        if (!Object.isFrozen(v)) {
-            for (const [k, v] of entries) {
-                obj[k] = v;
-            }
-            Object.freeze(obj);
-        }
-        return entries;
-    }
-    function add(v) {
-        const isObjectLike = typeof v === 'object' && !!v;
-        if (isObjectLike) {
-            const cached = known.get(v);
-            if (cached !== undefined) {
-                return cached;
-            }
-            known.set(v, v);
-        }
-        const path = normalizeToPath(v);
-        const c = walk(root, path);
-        const r = addValToCol(c, v);
-        if (isObjectLike) {
-            known.set(v, r);
-        }
-        return r;
-    }
-    return add(v);
-}
-function toValueType(v) {
-    const t = typeof v;
-    if (t !== 'object')
-        return t;
-    if (v instanceof Array)
-        return 'array';
-    if (v === null)
-        return 'null';
-    return t;
-}
-//# sourceMappingURL=ObjectCollection.js.map

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

@@ -1,31 +0,0 @@
-import type { CacheSettings, CSpellSettings } from '@cspell/cspell-types';
-import type { CacheOptions } from './CacheOptions.js';
-import type { CSpellLintResultCache } from './CSpellLintResultCache.js';
-export declare const DEFAULT_CACHE_LOCATION = ".cspellcache";
-export interface CreateCacheSettings extends Required<CacheSettings> {
-    /**
-     * cspell version used to validate cache entries.
-     */
-    version: string;
-    /**
-     * When true, causes the cache to be reset, removing any entries
-     * or cache files.
-     */
-    reset?: true;
-}
-/**
- * Creates CSpellLintResultCache (disk cache if caching is enabled in config or dummy otherwise)
- */
-export declare function createCache(options: CreateCacheSettings): CSpellLintResultCache;
-export declare function calcCacheSettings(config: CSpellSettings, cacheOptions: CacheOptions, root: string): Promise<CreateCacheSettings>;
-/**
- * Normalizes the version and return only `major.minor + versionSuffix`
- * @param version The cspell semantic version.
- */
-declare function normalizeVersion(version: string): string;
-export declare const __testing__: {
-    normalizeVersion: typeof normalizeVersion;
-    versionSuffix: string;
-};
-export {};
-//# sourceMappingURL=createCache.d.ts.map

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

@@ -1,77 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.__testing__ = exports.calcCacheSettings = exports.createCache = exports.DEFAULT_CACHE_LOCATION = void 0;
-const assert_1 = __importDefault(require("assert"));
-const promises_1 = require("fs/promises");
-const path_1 = __importDefault(require("path"));
-const errors_js_1 = require("../errors.js");
-const DiskCache_js_1 = require("./DiskCache.js");
-const DummyCache_js_1 = require("./DummyCache.js");
-// cspell:word cspellcache
-exports.DEFAULT_CACHE_LOCATION = '.cspellcache';
-const versionSuffix = '';
-/**
- * Creates CSpellLintResultCache (disk cache if caching is enabled in config or dummy otherwise)
- */
-function createCache(options) {
-    const { useCache, cacheLocation, cacheStrategy, reset } = options;
-    const location = path_1.default.resolve(cacheLocation);
-    const useChecksum = cacheStrategy === 'content';
-    const version = normalizeVersion(options.version);
-    const useUniversal = options.cacheFormat === 'universal';
-    const cache = useCache ? new DiskCache_js_1.DiskCache(location, useChecksum, version, useUniversal) : new DummyCache_js_1.DummyCache();
-    reset && cache.reset();
-    return cache;
-}
-exports.createCache = createCache;
-async function calcCacheSettings(config, cacheOptions, root) {
-    const cs = config.cache ?? {};
-    const useCache = cacheOptions.cache ?? cs.useCache ?? false;
-    const cacheLocation = await resolveCacheLocation(path_1.default.resolve(root, cacheOptions.cacheLocation ?? cs.cacheLocation ?? exports.DEFAULT_CACHE_LOCATION));
-    const cacheStrategy = cacheOptions.cacheStrategy ?? cs.cacheStrategy ?? 'metadata';
-    const cacheFormat = cacheOptions.cacheFormat ?? cs.cacheFormat ?? 'legacy';
-    const optionals = {};
-    if (cacheOptions.cacheReset) {
-        optionals.reset = true;
-    }
-    return {
-        ...optionals,
-        useCache,
-        cacheLocation,
-        cacheStrategy,
-        version: cacheOptions.version,
-        cacheFormat,
-    };
-}
-exports.calcCacheSettings = calcCacheSettings;
-async function resolveCacheLocation(cacheLocation) {
-    try {
-        const s = await (0, promises_1.stat)(cacheLocation);
-        if (s.isFile())
-            return cacheLocation;
-        return path_1.default.join(cacheLocation, exports.DEFAULT_CACHE_LOCATION);
-    }
-    catch (err) {
-        if ((0, errors_js_1.isError)(err) && err.code === 'ENOENT') {
-            return cacheLocation;
-        }
-        throw err;
-    }
-}
-/**
- * Normalizes the version and return only `major.minor + versionSuffix`
- * @param version The cspell semantic version.
- */
-function normalizeVersion(version) {
-    const parts = version.split('.').slice(0, 2);
-    (0, assert_1.default)(parts.length === 2);
-    return parts.join('.') + versionSuffix;
-}
-exports.__testing__ = {
-    normalizeVersion,
-    versionSuffix,
-};
-//# sourceMappingURL=createCache.js.map

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

@@ -1,9 +0,0 @@
-/**
- * This is a wrapper for 'file-entry-cache'
- */
-export type { FileDescriptor } from '../../../lib/file-entry-cache.cjs';
-import type { FileEntryCache as FecFileEntryCache } from '../../../lib/file-entry-cache.cjs';
-export type FileEntryCache = FecFileEntryCache;
-export declare function createFromFile(pathToCache: string, useCheckSum: boolean, useRelative: boolean): FileEntryCache;
-export declare function normalizePath(filePath: string): string;
-//# sourceMappingURL=fileEntryCache.d.ts.map

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

@@ -1,107 +0,0 @@
-"use strict";
-/**
- * This is a wrapper for 'file-entry-cache'
- */
-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.normalizePath = exports.createFromFile = void 0;
-const fs_1 = require("fs");
-const path = __importStar(require("path"));
-const worker_threads_1 = require("worker_threads");
-const fec = __importStar(require("../../../lib/file-entry-cache.cjs"));
-function createFromFile(pathToCache, useCheckSum, useRelative) {
-    const absPathToCache = path.resolve(pathToCache);
-    const relDir = path.dirname(absPathToCache);
-    (0, fs_1.mkdirSync)(relDir, { recursive: true });
-    const create = wrap(() => fec.createFromFile(absPathToCache, useCheckSum));
-    const feCache = create();
-    const cacheWrapper = {
-        get cache() {
-            return feCache.cache;
-        },
-        getHash(buffer) {
-            return feCache.getHash(buffer);
-        },
-        hasFileChanged: wrap((cwd, file) => {
-            console.log(file);
-            return feCache.hasFileChanged(resolveFile(cwd, file));
-        }),
-        analyzeFiles: wrap((cwd, files) => {
-            return feCache.analyzeFiles(resolveFiles(cwd, files));
-        }),
-        getFileDescriptor: wrap((cwd, file) => {
-            return feCache.getFileDescriptor(resolveFile(cwd, file));
-        }),
-        getUpdatedFiles: wrap((cwd, files) => {
-            return feCache.getUpdatedFiles(resolveFiles(cwd, files));
-        }),
-        normalizeEntries: wrap((cwd, files) => {
-            return feCache.normalizeEntries(resolveFiles(cwd, files));
-        }),
-        removeEntry: wrap((cwd, file) => {
-            console.log(file);
-            return feCache.removeEntry(resolveFile(cwd, file));
-        }),
-        deleteCacheFile() {
-            feCache.deleteCacheFile();
-        },
-        destroy() {
-            feCache.destroy();
-        },
-        reconcile: wrap((_cwd, noPrune) => {
-            feCache.reconcile(noPrune);
-        }),
-    };
-    return cacheWrapper;
-    function resolveFile(cwd, file) {
-        if (!useRelative)
-            return file;
-        const r = path.relative(relDir, path.resolve(cwd, file));
-        return normalizePath(r);
-    }
-    function resolveFiles(cwd, files) {
-        return files?.map((file) => resolveFile(cwd, file));
-    }
-    function wrap(fn) {
-        return (...params) => {
-            const cwd = process.cwd();
-            try {
-                worker_threads_1.isMainThread && process.chdir(relDir);
-                return fn(cwd, ...params);
-            }
-            finally {
-                worker_threads_1.isMainThread && process.chdir(cwd);
-            }
-        };
-    }
-}
-exports.createFromFile = createFromFile;
-function normalizePath(filePath) {
-    return filePath;
-    // if (path.sep !== '\\') return filePath;
-    // return filePath.replace(/\\/g, '/');
-}
-exports.normalizePath = normalizePath;
-//# sourceMappingURL=fileEntryCache.js.map

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

@@ -1,4 +0,0 @@
-export type { CacheOptions } from './CacheOptions.js';
-export { calcCacheSettings, createCache, type CreateCacheSettings, DEFAULT_CACHE_LOCATION } from './createCache.js';
-export type { CSpellLintResultCache } from './CSpellLintResultCache.js';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_CACHE_LOCATION = exports.createCache = exports.calcCacheSettings = void 0;
-var createCache_js_1 = require("./createCache.js");
-Object.defineProperty(exports, "calcCacheSettings", { enumerable: true, get: function () { return createCache_js_1.calcCacheSettings; } });
-Object.defineProperty(exports, "createCache", { enumerable: true, get: function () { return createCache_js_1.createCache; } });
-Object.defineProperty(exports, "DEFAULT_CACHE_LOCATION", { enumerable: true, get: function () { return createCache_js_1.DEFAULT_CACHE_LOCATION; } });
-//# sourceMappingURL=index.js.map

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

@@ -1,6 +0,0 @@
-/// <reference types="node" />
-export declare const UTF8: BufferEncoding;
-export declare const STDIN = "stdin";
-export declare const STDINProtocol = "stdin://";
-export declare const FileProtocol = "file://";
-//# sourceMappingURL=constants.d.ts.map

package/dist/cjs/util/constants.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileProtocol = exports.STDINProtocol = exports.STDIN = exports.UTF8 = void 0;
-exports.UTF8 = 'utf8';
-exports.STDIN = 'stdin';
-exports.STDINProtocol = 'stdin://';
-exports.FileProtocol = 'file://';
-//# sourceMappingURL=constants.js.map

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

@@ -1,23 +0,0 @@
-export declare class CheckFailed extends Error {
-    readonly exitCode: number;
-    constructor(message: string, exitCode?: number);
-}
-export declare class ApplicationError extends Error {
-    readonly exitCode: number;
-    readonly cause?: Error | undefined;
-    constructor(message: string, exitCode?: number, cause?: Error | undefined);
-}
-export declare class IOError extends ApplicationError {
-    readonly cause: NodeError;
-    constructor(message: string, cause: NodeError);
-    get code(): string | undefined;
-    isNotFound(): boolean;
-}
-export declare function toError(e: unknown): NodeError;
-export declare function isError(e: unknown): e is NodeError;
-export declare function toApplicationError(e: unknown, message?: string): ApplicationError;
-export interface NodeError extends Error {
-    code?: string;
-    toString?: () => string;
-}
-//# sourceMappingURL=errors.d.ts.map

package/dist/cjs/util/errors.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toApplicationError = exports.isError = exports.toError = exports.IOError = exports.ApplicationError = exports.CheckFailed = void 0;
-const util_1 = require("util");
-class CheckFailed extends Error {
-    constructor(message, exitCode = 1) {
-        super(message);
-        this.exitCode = exitCode;
-    }
-}
-exports.CheckFailed = CheckFailed;
-class ApplicationError extends Error {
-    constructor(message, exitCode = 1, cause) {
-        super(message);
-        this.exitCode = exitCode;
-        this.cause = cause;
-    }
-}
-exports.ApplicationError = ApplicationError;
-class IOError extends ApplicationError {
-    constructor(message, cause) {
-        super(message, undefined, cause);
-        this.cause = cause;
-    }
-    get code() {
-        return this.cause.code;
-    }
-    isNotFound() {
-        return this.cause.code === 'ENOENT';
-    }
-}
-exports.IOError = IOError;
-function toError(e) {
-    if (isError(e))
-        return e;
-    const message = (0, util_1.format)(e);
-    return {
-        name: 'error',
-        message,
-        toString: () => message,
-    };
-}
-exports.toError = toError;
-function isError(e) {
-    if (e instanceof Error)
-        return true;
-    if (!e || typeof e !== 'object')
-        return false;
-    const ex = e;
-    return typeof ex.message === 'string';
-}
-exports.isError = isError;
-function toApplicationError(e, message) {
-    if (e instanceof ApplicationError && !message)
-        return e;
-    const err = toError(e);
-    return new ApplicationError(message ?? err.message, undefined, err);
-}
-exports.toApplicationError = toApplicationError;
-//# sourceMappingURL=errors.js.map

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

@@ -1,63 +0,0 @@
-/// <reference types="node" />
-import type { CSpellUserSettings, Document, Issue } from 'cspell-lib';
-import { URI } from '../../lib/uri.cjs';
-import type { GlobOptions } from './glob.js';
-export interface ConfigInfo {
-    source: string;
-    config: CSpellUserSettings;
-}
-export interface FileConfigInfo {
-    configInfo: ConfigInfo;
-    filename: string;
-    text: string;
-    languageIds: string[];
-}
-export declare function readConfig(configFile: string | undefined, root: string | undefined): Promise<ConfigInfo>;
-export interface FileInfo {
-    filename: string;
-    text?: string;
-    errorCode?: string;
-}
-export interface FileResult {
-    fileInfo: FileInfo;
-    processed: boolean;
-    issues: Issue[];
-    errors: number;
-    configErrors: number;
-    elapsedTimeMs: number | undefined;
-    cached?: boolean;
-}
-export declare function fileInfoToDocument(fileInfo: FileInfo, languageId: string | undefined, locale: string | undefined): Document;
-export declare function filenameToUrlString(filename: string, cwd?: string): string;
-export declare function filenameToUri(filename: string, cwd?: string): URI;
-export declare function isBinaryFile(filename: string, cwd?: string): boolean;
-export interface ReadFileInfoResult extends FileInfo {
-    text: string;
-}
-export declare function resolveFilename(filename: string, cwd?: string): string;
-export declare function readFileInfo(filename: string, encoding?: BufferEncoding, handleNotFound?: boolean): Promise<ReadFileInfoResult>;
-export declare function readFile(filename: string, encoding?: BufferEncoding): Promise<string>;
-/**
- * Looks for matching glob patterns or stdin
- * @param globPatterns patterns or stdin
- */
-export declare function findFiles(globPatterns: string[], options: GlobOptions): Promise<string[]>;
-export declare function calcFinalConfigInfo(configInfo: ConfigInfo, settingsFromCommandLine: CSpellUserSettings, filename: string, text: string): FileConfigInfo;
-/**
- * Read
- * @param listFiles - array of file paths to read that will contain a list of files. Paths contained in each
- *   file will be resolved relative to the containing file.
- * @returns - a list of files to be processed.
- */
-export declare function readFileListFiles(listFiles: string[]): AsyncIterable<string>;
-/**
- * Read a `listFile` and return the containing file paths resolved relative to the `listFile`.
- * @param listFiles - array of file paths to read that will contain a list of files. Paths contained in each
- *   file will be resolved relative to the containing file.
- * @returns - a list of files to be processed.
- */
-export declare function readFileListFile(listFile: string): Promise<string[]>;
-export declare function isFile(filename: string): Promise<boolean>;
-export declare function isDir(filename: string): Promise<boolean>;
-export declare function isNotDir(filename: string): Promise<boolean>;
-//# sourceMappingURL=fileHelper.d.ts.map