@cspell/cspell-tools 9.5.0 → 9.6.0

package/dist/test/TestHelper.d.ts

@@ -1,53 +0,0 @@
-export interface TestHelper {
-    /** path to `.../cspell/package/cspell-tools/` */
-    readonly packageRoot: string;
-    /** path to `...cspell/` */
-    readonly repoRoot: string;
-    readonly tempDir: string;
-    /**
-     * delete the contents of the temp directory for the current test.
-     */
-    clearTempDir(): void;
-    /**
-     * Resolves the parts to be an absolute path in the temp directory
-     * for a given test.
-     * @param parts
-     */
-    resolveTemp(...parts: string[]): string;
-    createTempDir(...parts: string[]): void;
-    /**
-     * Resolves a fixture path to an absolute path
-     * @param parts - relative path to fixture
-     */
-    resolveFixture(...parts: string[]): string;
-    /**
-     * Resolves a path to an absolute path in Samples
-     * @param parts - relative path to sample
-     */
-    resolveSample(...parts: string[]): string;
-    /**
-     * Make the temp directory
-     * @param parts
-     */
-    mkdir(...parts: string[]): void;
-    /**
-     * copy file
-     * @param from
-     * @param to
-     */
-    cpFileSync(from: string, to: string): void;
-    packageTemp(...parts: string[]): string;
-    /**
-     * Signal the start of a test.
-     * Use to make test.each unique.
-     * @param name
-     */
-    beginTest(name?: string): void;
-    getCurrentTestName(): string;
-    fileExists(path: string): Promise<boolean>;
-}
-export declare function createTestHelper(testFilenameUrl: string): TestHelper;
-export declare function resolvePathToFixture(...segments: string[]): string;
-export declare function test_dirname(importMetaUrl: string): string;
-export declare function test_filename(importMetaUrl: string): string;
-//# sourceMappingURL=TestHelper.d.ts.map

package/dist/test/TestHelper.js

@@ -1,121 +0,0 @@
-import assert from 'node:assert';
-import { mkdirSync, promises as fs, readFileSync, rmSync, statSync, writeFileSync } from 'node:fs';
-import * as path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { expect } from 'vitest';
-const _dirname = test_dirname(import.meta.url);
-const packageRoot = path.join(_dirname, '../..');
-const repoRoot = path.join(packageRoot, '../..');
-const tempDirBase = path.join(packageRoot, 'temp');
-const repoSamples = path.join(repoRoot, 'packages/Samples');
-export function createTestHelper(testFilenameUrl) {
-    testFilenameUrl && assert(testFilenameUrl.startsWith('file:'));
-    const testFilename = testFilenameUrl && test_filename(testFilenameUrl);
-    return new TestHelperImpl(testFilename || expect.getState().testPath || 'test');
-}
-const fixtureDir = path.join(packageRoot, 'fixtures');
-class TestHelperImpl {
-    packageRoot = packageRoot;
-    repoRoot = repoRoot;
-    tempDir;
-    fixtureDir;
-    testCounter = new Map();
-    constructor(testFilename) {
-        this.tempDir = path.join(tempDirBase, path.relative(packageRoot, testFilename));
-        this.fixtureDir = fixtureDir;
-    }
-    beginTest() {
-        const currentTestName = this.getRawTestName();
-        const prev = this.testCounter.get(currentTestName) || 0;
-        this.testCounter.set(currentTestName, prev + 1);
-    }
-    getRawTestName() {
-        return expect.getState().currentTestName || '';
-    }
-    getCurrentTestName() {
-        const currentTestName = this.getRawTestName();
-        const counter = this.testCounter.get(currentTestName);
-        return `${currentTestName}${counter ? ' ' + counter : ''}`;
-    }
-    /**
-     * delete the contents of the temp directory for the current test.
-     */
-    clearTempDir() {
-        rmSync(this.resolveTemp(), { force: true, recursive: true });
-    }
-    /**
-     * resolve a path relative to the
-     * @param parts
-     * @returns
-     */
-    resolveTemp(...parts) {
-        const currentTestName = this.getCurrentTestName();
-        const testName = currentTestName.replaceAll(/[^\w_.-]/g, '_');
-        return path.resolve(this.tempDir, testName, ...parts);
-    }
-    /**
-     * make a directory. It is ok to make the same directory multiple times.
-     * @param parts
-     */
-    mkdir(...parts) {
-        const pTemp = this.resolveTemp(...parts);
-        mkdirSync(pTemp, { recursive: true });
-    }
-    /**
-     * Copy files from src to dest
-     * @param src - glob
-     * @param dest - directory or file
-     */
-    cpFileSync(src, dest) {
-        const srcT = this.resolveTemp(src);
-        const dstT = this.resolveTemp(dest);
-        cpFileSync(srcT, dstT);
-    }
-    /**
-     * resolve a path to the fixtures.
-     * @param parts
-     * @returns
-     */
-    resolveFixture(...parts) {
-        return path.resolve(this.fixtureDir, ...parts);
-    }
-    resolveSample(...parts) {
-        return path.resolve(repoSamples, ...parts);
-    }
-    /**
-     * calc a path relative to the package temp directory.
-     * @param parts - optional path segments
-     * @returns
-     */
-    packageTemp(...parts) {
-        return path.resolve(tempDirBase, ...parts);
-    }
-    createTempDir = this.mkdir;
-    async fileExists(path) {
-        try {
-            await fs.stat(path);
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-}
-export function resolvePathToFixture(...segments) {
-    return path.resolve(fixtureDir, ...segments);
-}
-export function test_dirname(importMetaUrl) {
-    return fileURLToPath(new URL('.', importMetaUrl));
-}
-export function test_filename(importMetaUrl) {
-    return fileURLToPath(importMetaUrl);
-}
-function cpFileSync(srcFile, dst) {
-    const statDst = statSync(dst, { throwIfNoEntry: false });
-    if (statDst && statDst.isDirectory()) {
-        dst = path.join(dst, path.basename(srcFile));
-    }
-    const buf = readFileSync(srcFile);
-    writeFileSync(dst, buf);
-}
-//# sourceMappingURL=TestHelper.js.map

package/dist/test/console.d.ts

@@ -1,9 +0,0 @@
-export declare function spyOnConsole(): {
-    consoleOutput: () => {
-        log: string;
-        error: string;
-    };
-    attach: () => void;
-    reset: () => void;
-};
-//# sourceMappingURL=console.d.ts.map

package/dist/test/console.js

@@ -1,34 +0,0 @@
-import { vi } from 'vitest';
-import { normalizeOutput } from './normalizeOutput.js';
-export function spyOnConsole() {
-    const con = {
-        log: vi.spyOn(console, 'log').mockImplementation(() => undefined),
-        error: vi.spyOn(console, 'error').mockImplementation(() => undefined),
-        consoleOutput,
-        attach,
-        reset,
-    };
-    function consoleOutput() {
-        const _error = con.error.mock.calls.map((c) => c.join(',')).join('\n');
-        const _log = con.log.mock.calls.map((c) => c.join(',')).join('\n');
-        return {
-            log: normalizeOutput(_log),
-            error: normalizeOutput(_error),
-        };
-    }
-    function attach() {
-        reset();
-        con.log = vi.spyOn(console, 'log').mockImplementation(() => undefined);
-        con.error = vi.spyOn(console, 'error').mockImplementation(() => undefined);
-    }
-    function reset() {
-        con.log.mockRestore();
-        con.error.mockRestore();
-    }
-    return {
-        consoleOutput,
-        attach,
-        reset,
-    };
-}
-//# sourceMappingURL=console.js.map

package/dist/test/escapeRegEx.d.ts

@@ -1,7 +0,0 @@
-/**
- * Escape a string so it can be used as an exact match within a RegExp.
- * @param s - string to escape
- * @returns - the escaped string.
- */
-export declare function escapeRegEx(s: string): string;
-//# sourceMappingURL=escapeRegEx.d.ts.map

package/dist/test/escapeRegEx.js

@@ -1,9 +0,0 @@
-/**
- * Escape a string so it can be used as an exact match within a RegExp.
- * @param s - string to escape
- * @returns - the escaped string.
- */
-export function escapeRegEx(s) {
-    return s.replaceAll(/[|\\{}()[\]^$+*?.]/g, '\\$&').replaceAll('-', '\\x2d');
-}
-//# sourceMappingURL=escapeRegEx.js.map

package/dist/test/normalizeOutput.d.ts

@@ -1,3 +0,0 @@
-export declare function normalizeOutput(output: string, cwd?: string): string;
-export declare function normalizeDirectorySeparator(path: string): string;
-//# sourceMappingURL=normalizeOutput.d.ts.map

package/dist/test/normalizeOutput.js

@@ -1,20 +0,0 @@
-import * as path from 'node:path';
-import { escapeRegEx } from './escapeRegEx.js';
-import { test_dirname } from './TestHelper.js';
-const _dirname = test_dirname(import.meta.url);
-const rootCspellTools = path.join(_dirname, '../..');
-const rootRepo = path.join(rootCspellTools, '../..');
-/**
- * Example: `2022-10-02T17:10:04.681Z`
- */
-const regexpDate = /\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(\.\d+)?Z/gi;
-const rxRootRepo = new RegExp(escapeRegEx(rootRepo) + '|' + escapeRegEx(normalizeDirectorySeparator(rootRepo)), 'gi');
-export function normalizeOutput(output, cwd = process.cwd()) {
-    const rxCwd = new RegExp(escapeRegEx(cwd) + '|' + escapeRegEx(normalizeDirectorySeparator(cwd)), 'gi');
-    const normalizeDirs = normalizeDirectorySeparator(output.replace(rxCwd, '{cwd}').replace(rxRootRepo, '{repo-root}'));
-    return normalizeDirs.replaceAll(regexpDate, '2022-01-01T00:00:00.000Z');
-}
-export function normalizeDirectorySeparator(path) {
-    return path.replaceAll('\\', '/');
-}
-//# sourceMappingURL=normalizeOutput.js.map

package/dist/types.d.ts

@@ -1,7 +0,0 @@
-/**
- * Make all properties in T required, but keep the original optionality of the properties.
- */
-export type RequireFields<T> = {
-    [P in keyof Required<T>]: T[P];
-};
-//# sourceMappingURL=types.d.ts.map

package/dist/types.js

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

package/dist/util/errors.d.ts

@@ -1,6 +0,0 @@
-export interface NodeError extends Error {
-    code?: string;
-}
-export declare function toError(err: unknown): NodeError;
-export declare function isError(err: unknown): err is Error;
-//# sourceMappingURL=errors.d.ts.map

package/dist/util/errors.js

@@ -1,11 +0,0 @@
-export function toError(err) {
-    if (isError(err))
-        return err;
-    return new Error(`${err}`);
-}
-export function isError(err) {
-    if (err instanceof Error)
-        return true;
-    return false;
-}
-//# sourceMappingURL=errors.js.map

package/dist/util/globP.d.ts

@@ -1,7 +0,0 @@
-interface Options {
-    cwd?: string | URL;
-    nodir?: boolean;
-}
-export declare function globP(pattern: string | string[], options?: Options): Promise<string[]>;
-export {};
-//# sourceMappingURL=globP.d.ts.map

package/dist/util/globP.js

@@ -1,7 +0,0 @@
-import { glob } from 'glob';
-export function globP(pattern, options) {
-    // Convert windows separators.
-    const globs = (Array.isArray(pattern) ? pattern : [pattern]).map((pattern) => pattern.replaceAll('\\', '/'));
-    return glob(globs, options);
-}
-//# sourceMappingURL=globP.js.map

package/dist/util/index.d.ts

@@ -1,2 +0,0 @@
-export declare function isDefined<T>(a: T | undefined | null): a is T;
-//# sourceMappingURL=index.d.ts.map

package/dist/util/index.js

@@ -1,4 +0,0 @@
-export function isDefined(a) {
-    return !!a || (a !== null && a !== undefined);
-}
-//# sourceMappingURL=index.js.map

package/dist/util/textRegex.d.ts

@@ -1,3 +0,0 @@
-export declare const regExMatchRegExParts: RegExp;
-export declare function stringToRegExp(pattern: string | RegExp, defaultFlags?: string, forceFlags?: string): RegExp | undefined;
-//# sourceMappingURL=textRegex.d.ts.map

package/dist/util/textRegex.js

@@ -1,109 +0,0 @@
-// cspell:ignore gimuxy
-export const regExMatchRegExParts = /^\s*\/([\s\S]*?)\/([gimuxy]*)\s*$/;
-export function stringToRegExp(pattern, defaultFlags = '', forceFlags = '') {
-    if (pattern instanceof RegExp) {
-        return pattern;
-    }
-    try {
-        const [, pat, flag] = [
-            ...(pattern.match(regExMatchRegExParts) || ['', pattern.trim(), defaultFlags]),
-            forceFlags,
-        ];
-        if (pat) {
-            const regPattern = flag.includes('x') ? removeVerboseFromRegExp(pat) : pat;
-            // Make sure the flags are unique.
-            const flags = [...new Set(forceFlags + flag)].join('').replaceAll(/[^gimuy]/g, '');
-            const regex = new RegExp(regPattern, flags);
-            return regex;
-        }
-    }
-    catch {
-        /* empty */
-    }
-    return undefined;
-}
-const SPACES = {
-    ' ': true,
-    '\n': true,
-    '\r': true,
-    '\t': true,
-};
-/**
- * Remove all whitespace and comments from a regexp string. The format follows Pythons Verbose.
- * Note: this is a best attempt. Special cases for comments: `#` and spaces should be proceeded with a `\`
- *
- * All space must be proceeded by a `\` or in a character class `[]`
- *
- * @param pattern - the pattern to clean
- */
-function removeVerboseFromRegExp(pattern) {
-    function escape(acc) {
-        const char = pattern[acc.idx];
-        if (char !== '\\')
-            return undefined;
-        const next = pattern[++acc.idx];
-        acc.idx++;
-        if (next === '#') {
-            acc.result += '#';
-            return acc;
-        }
-        if (!(next in SPACES)) {
-            acc.result += '\\' + next;
-            return acc;
-        }
-        acc.result += next;
-        if (next === '\r' && pattern[acc.idx] === '\n') {
-            acc.result += '\n';
-            acc.idx++;
-        }
-        return acc;
-    }
-    function braces(acc) {
-        const char = pattern[acc.idx];
-        if (char !== '[')
-            return undefined;
-        acc.result += char;
-        acc.idx++;
-        let escCount = 0;
-        while (acc.idx < pattern.length) {
-            const char = pattern[acc.idx];
-            acc.result += char;
-            acc.idx++;
-            if (char === ']' && !(escCount & 1))
-                break;
-            escCount = char === '\\' ? escCount + 1 : 0;
-        }
-        return acc;
-    }
-    function spaces(acc) {
-        const char = pattern[acc.idx];
-        if (!(char in SPACES))
-            return undefined;
-        acc.idx++;
-        return acc;
-    }
-    function comments(acc) {
-        const char = pattern[acc.idx];
-        if (char !== '#')
-            return undefined;
-        while (acc.idx < pattern.length && pattern[acc.idx] !== '\n') {
-            acc.idx++;
-        }
-        return acc;
-    }
-    function copy(acc) {
-        const char = pattern[acc.idx++];
-        acc.result += char;
-        return acc;
-    }
-    const reducers = [escape, braces, spaces, comments, copy];
-    const result = { idx: 0, result: '' };
-    while (result.idx < pattern.length) {
-        for (const r of reducers) {
-            if (r(result))
-                break;
-        }
-    }
-    return result.result;
-}
-//# sourceMappingURL=textRegex.js.map