@cspell/cspell-tools 9.4.0 → 9.6.0

package/dist/compiler/writeTextToFile.js

@@ -1,15 +0,0 @@
-import { Buffer } from 'node:buffer';
-import { promises as fs } from 'node:fs';
-import { compress } from '../gzip/index.js';
-const isGzFile = /\.gz$/;
-export async function writeTextToFile(filename, data) {
-    const useGz = isGzFile.test(filename);
-    const buf = Buffer.from(data, 'utf8');
-    const buffer = useGz ? await compress(buf) : buf;
-    await fs.writeFile(filename, buffer);
-}
-export function writeTextLinesToFile(filename, lines) {
-    const data = Array.isArray(lines) ? lines.join('') : [...lines].join('');
-    return writeTextToFile(filename, data);
-}
-//# sourceMappingURL=writeTextToFile.js.map

package/dist/config/config.d.ts

@@ -1,194 +0,0 @@
-export interface RunConfig extends Partial<Omit<CompileRequest, 'targets'>> {
-    /**
-     * Url to JSON Schema
-     * @default "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-tools/cspell-tools.config.schema.json"
-     */
-    $schema?: string | undefined;
-    /**
-     * Optional Target Dictionaries to create.
-     */
-    targets?: Target[] | undefined;
-    /**
-     * Specify the directory where all relative paths will resolved against.
-     * By default, all relative paths are relative to the location of the
-     * config file.
-     */
-    rootDir?: string | undefined;
-}
-export interface CompileRequest extends CompileTargetOptions, CompileSourceOptions {
-    /**
-     * Specify the directory where all relative paths will resolved against.
-     * By default, all relative paths are relative to the current directory.
-     */
-    rootDir?: string | undefined;
-    /**
-     * Target Dictionaries to create.
-     */
-    targets: Target[];
-    /**
-     * Path to checksum file. `true` - defaults to `./checksum.txt`.
-     */
-    checksumFile?: string | boolean | undefined;
-}
-export interface Experimental {
-    /**
-     * Experimental flags
-     */
-    experimental?: string[] | undefined;
-}
-export interface CompileTargetOptions {
-    /**
-     * Generate lower case / accent free versions of words.
-     * @default false
-     */
-    generateNonStrict?: boolean | undefined;
-    /**
-     * Sort the words in the resulting dictionary.
-     * Does not apply to `trie` based formats.
-     * @default true
-     */
-    sort?: boolean | undefined;
-    /**
-     * Words in the `allowedSplitWords` are considered correct and can be used
-     * as a basis for splitting compound words.
-     *
-     * If entries can be split so that all the words in the entry are allowed,
-     * then only the individual words are added, otherwise the entire entry is added.
-     * This is to prevent misspellings in CamelCase words from being introduced into the
-     * dictionary.
-     */
-    allowedSplitWords?: FilePath | FilePath[] | undefined;
-    /**
-     * Injects `cspell-dictionary` directives into the dictionary header.
-     *
-     * Example:
-     *
-     * ```ini
-     * # cspell-dictionary: no-generate-alternatives
-     * ```
-     *
-     * Known Directives:
-     * ```yaml
-     * - split # Tell the dictionary loader to split words
-     * - no-split # Tell the dictionary loader to not split words (default)
-     * - generate-alternatives # Tell the dictionary loader to generate alternate spellings (default)
-     * - no-generate-alternatives # Tell the dictionary loader to not generate alternate spellings
-     * ```
-     */
-    dictionaryDirectives?: string[] | undefined;
-    /**
-     * Remove duplicate words, favor lower case words over mixed case words.
-     * Combine compound prefixes where possible.
-     * @default false
-     */
-    removeDuplicates?: boolean | undefined;
-}
-export interface Target extends CompileTargetOptions {
-    /**
-     * Name of target, used as the basis of target file name.
-     */
-    name: string;
-    /**
-     * The target directory
-     * @default current directory
-     */
-    targetDirectory?: FilePath | undefined;
-    /**
-     * gzip the file?
-     * @default: false
-     */
-    compress?: boolean | undefined;
-    /**
-     * Format of the dictionary.
-     */
-    format: DictionaryFormats;
-    /**
-     * File sources used to build the dictionary.
-     */
-    sources: DictionarySource[];
-    /**
-     * Words from the sources that are found in `excludeWordsFrom` files
-     * will NOT be added to the dictionary.
-     *
-     * @since 8.3.2
-     */
-    excludeWordsFrom?: FilePath[] | undefined;
-    /**
-     * Words from the sources that are NOT found in `excludeWordsNotFoundIn` files
-     * will NOT be added to the dictionary.
-     *
-     * @since 8.19.4
-     */
-    excludeWordsNotFoundIn?: FilePath[] | undefined;
-    /**
-     * Words from the sources that match the regex in `excludeWordsMatchingRegex`
-     * will NOT be added to the dictionary.
-     *
-     * Note: The regex must be a valid JavaScript literal regex expression including the `/` delimiters.
-     *
-     * @since 8.19.4
-     */
-    excludeWordsMatchingRegex?: string[] | undefined;
-    /**
-     * Advanced: Set the trie base number. A value between 10 and 36
-     * Set numeric base to use.
-     * 10 is the easiest to read.
-     * 16 is common hex format.
-     * 36 is the most compact.
-     */
-    trieBase?: number | undefined;
-}
-export type DictionaryFormats = 'plaintext' | 'trie' | 'trie3' | 'trie4';
-/**
- * Note: All relative paths are relative to the config file location.
- */
-export type FilePath = string;
-export type DictionarySource = FilePath | FileSource | FileListSource;
-export interface FileSource extends CompileSourceOptions {
-    filename: FilePath;
-}
-export interface FileListSource extends CompileSourceOptions {
-    listFile: FilePath;
-}
-export interface CompileSourceOptions {
-    /**
-     * Maximum number of nested Hunspell Rules to apply.
-     * This is needed for recursive dictionaries like Hebrew.
-     */
-    maxDepth?: number | undefined;
-    /**
-     * Split lines into words.
-     * @default false
-     */
-    split?: boolean | 'legacy' | undefined;
-    /**
-     * Do not generate lower case / accent free versions of words.
-     * @default false
-     */
-    keepRawCase?: boolean | undefined;
-    /**
-     * Words in the `allowedSplitWords` are considered correct and can be used
-     * as a basis for splitting compound words.
-     *
-     * If entries can be split so that all the words in the entry are allowed,
-     * then only the individual words are added, otherwise the entire entry is added.
-     * This is to prevent misspellings in CamelCase words from being introduced into the
-     * dictionary.
-     */
-    allowedSplitWords?: FilePath | FilePath[] | undefined;
-    /**
-     * Camel case words that have been split using the `allowedSplitWords` are added to the dictionary as compoundable words.
-     * These words are prefixed / suffixed with `*`.
-     * @default false
-     */
-    storeSplitWordsAsCompounds?: boolean | undefined;
-    /**
-     * Controls the minimum length of a compound word when storing words using `storeSplitWordsAsCompounds`.
-     * The compound words are prefixed / suffixed with `*`, to allow them to be combined with other compound words.
-     * If the length is too low, then the dictionary will consider many misspelled words as correct.
-     * @default 4
-     */
-    minCompoundLength?: number | undefined;
-}
-export declare const configFileSchemaURL = "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-tools/cspell-tools.config.schema.json";
-//# sourceMappingURL=config.d.ts.map

package/dist/config/config.js

@@ -1,2 +0,0 @@
-export const configFileSchemaURL = 'https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-tools/cspell-tools.config.schema.json';
-//# sourceMappingURL=config.js.map

package/dist/config/configDefaults.d.ts

@@ -1,9 +0,0 @@
-export declare const defaultCompileSourceOptions: {
-    readonly maxDepth: undefined;
-    readonly split: false;
-    readonly keepRawCase: false;
-    readonly allowedSplitWords: undefined;
-    readonly storeSplitWordsAsCompounds: false;
-    readonly minCompoundLength: 4;
-};
-//# sourceMappingURL=configDefaults.d.ts.map

package/dist/config/configDefaults.js

@@ -1,9 +0,0 @@
-export const defaultCompileSourceOptions = {
-    maxDepth: undefined,
-    split: false,
-    keepRawCase: false,
-    allowedSplitWords: undefined,
-    storeSplitWordsAsCompounds: false,
-    minCompoundLength: 4,
-};
-//# sourceMappingURL=configDefaults.js.map

package/dist/config/configUtils.d.ts

@@ -1,5 +0,0 @@
-import type { DictionarySource, FileListSource, FilePath, FileSource } from '../config/index.js';
-export declare function isFilePath(source: DictionarySource): source is FilePath;
-export declare function isFileSource(source: DictionarySource): source is FileSource;
-export declare function isFileListSource(source: DictionarySource): source is FileListSource;
-//# sourceMappingURL=configUtils.d.ts.map

package/dist/config/configUtils.js

@@ -1,14 +0,0 @@
-export function isFilePath(source) {
-    return typeof source === 'string';
-}
-export function isFileSource(source) {
-    if (!source || isFilePath(source))
-        return false;
-    return source.filename !== undefined;
-}
-export function isFileListSource(source) {
-    if (!source || isFilePath(source))
-        return false;
-    return source.listFile !== undefined;
-}
-//# sourceMappingURL=configUtils.js.map

package/dist/config/index.d.ts

@@ -1,4 +0,0 @@
-export type { CompileRequest, CompileSourceOptions, CompileTargetOptions, DictionaryFormats, DictionarySource, FileListSource, FilePath, FileSource, RunConfig, Target, } from './config.js';
-export { isFileListSource, isFilePath, isFileSource } from './configUtils.js';
-export { normalizeConfig } from './normalizeConfig.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/config/index.js

@@ -1,3 +0,0 @@
-export { isFileListSource, isFilePath, isFileSource } from './configUtils.js';
-export { normalizeConfig } from './normalizeConfig.js';
-//# sourceMappingURL=index.js.map

package/dist/config/normalizeConfig.d.ts

@@ -1,8 +0,0 @@
-type CosmiconfigResult = {
-    config: any;
-    filepath: string;
-    isEmpty?: boolean | undefined;
-} | null;
-export declare function normalizeConfig(cfg: CosmiconfigResult): CosmiconfigResult;
-export {};
-//# sourceMappingURL=normalizeConfig.d.ts.map

package/dist/config/normalizeConfig.js

@@ -1,13 +0,0 @@
-import * as path from 'node:path';
-export function normalizeConfig(cfg) {
-    if (!cfg)
-        return cfg;
-    const dir = path.dirname(cfg.filepath);
-    const config = cfg.config;
-    const result = { ...config, rootDir: path.resolve(dir, config.rootDir || '.') };
-    return {
-        config: result,
-        filepath: cfg.filepath,
-    };
-}
-//# sourceMappingURL=normalizeConfig.js.map

package/dist/gzip/compressFiles.d.ts

@@ -1,16 +0,0 @@
-import type { Buffer } from 'node:buffer';
-export declare enum OSFlags {
-    auto = -1,
-    FAT = 0,
-    Unix = 3,
-    HPFS = 6,// cspell:ignore hpfs
-    MACOS = 7,
-    NTFS = 11
-}
-export declare function compressFile(file: string, os?: OSFlags): Promise<string>;
-export declare function compress(buf: string | Uint8Array | Buffer, os?: OSFlags): Promise<Uint8Array>;
-export declare function compressSync(buf: string | Uint8Array | Buffer, os?: OSFlags): Uint8Array;
-export declare function decompress(buf: Uint8Array | Buffer, encoding?: undefined): Promise<Uint8Array>;
-export declare function decompress(buf: Uint8Array | Buffer, encoding: 'utf8'): Promise<string>;
-export declare function decompress(buf: Uint8Array | Buffer, encoding: 'utf8' | undefined): Promise<string | Uint8Array>;
-//# sourceMappingURL=compressFiles.d.ts.map

package/dist/gzip/compressFiles.js

@@ -1,42 +0,0 @@
-import { readFile, writeFile } from 'node:fs/promises';
-import { promisify } from 'node:util';
-import { gunzip as gunzipCB, gzip as gz, gzipSync } from 'node:zlib';
-const gzip = promisify(gz);
-const gunzip = promisify(gunzipCB);
-export var OSFlags;
-(function (OSFlags) {
-    OSFlags[OSFlags["auto"] = -1] = "auto";
-    OSFlags[OSFlags["FAT"] = 0] = "FAT";
-    OSFlags[OSFlags["Unix"] = 3] = "Unix";
-    OSFlags[OSFlags["HPFS"] = 6] = "HPFS";
-    OSFlags[OSFlags["MACOS"] = 7] = "MACOS";
-    OSFlags[OSFlags["NTFS"] = 11] = "NTFS";
-})(OSFlags || (OSFlags = {}));
-// https://docs.fileformat.com/compression/gz/#:~:text=A%20GZ%20file%20is%20a,compression%20formats%20on%20UNIX%20systems.
-const OSSystemIDOffset = 9;
-export async function compressFile(file, os) {
-    if (file.endsWith('.gz'))
-        return file;
-    const targetFile = file + '.gz';
-    const zBuf = await compress(await readFile(file), os);
-    await writeFile(targetFile, zBuf);
-    return targetFile;
-}
-export async function compress(buf, os) {
-    return fixOSSystemID(await gzip(buf), os);
-}
-export function compressSync(buf, os) {
-    return fixOSSystemID(gzipSync(buf), os);
-}
-function fixOSSystemID(zBuf, os = OSFlags.Unix) {
-    const osFlag = os == OSFlags.auto ? zBuf[OSSystemIDOffset] : os;
-    zBuf[OSSystemIDOffset] = osFlag;
-    return zBuf;
-}
-export async function decompress(buf, encoding) {
-    const dBuf = gunzip(buf);
-    if (!encoding)
-        return dBuf;
-    return (await dBuf).toString(encoding);
-}
-//# sourceMappingURL=compressFiles.js.map

package/dist/gzip/gzip.d.ts

@@ -1,3 +0,0 @@
-import type { OSFlags } from './compressFiles.js';
-export declare function gzip(globs: string[], os?: OSFlags): Promise<void>;
-//# sourceMappingURL=gzip.d.ts.map

package/dist/gzip/gzip.js

@@ -1,10 +0,0 @@
-import { globP } from '../util/globP.js';
-import { compressFile } from './compressFiles.js';
-// cspell:ignore nodir
-export async function gzip(globs, os) {
-    const files = await globP(globs, { nodir: true });
-    for (const fileName of files) {
-        await compressFile(fileName, os);
-    }
-}
-//# sourceMappingURL=gzip.js.map

package/dist/gzip/index.d.ts

@@ -1,3 +0,0 @@
-export { compress, compressFile, decompress, OSFlags } from './compressFiles.js';
-export { gzip } from './gzip.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/gzip/index.js

@@ -1,3 +0,0 @@
-export { compress, compressFile, decompress, OSFlags } from './compressFiles.js';
-export { gzip } from './gzip.js';
-//# sourceMappingURL=index.js.map

package/dist/shasum/checksum.d.ts

@@ -1,7 +0,0 @@
-type HashAlgorithm = 'SHA1';
-export declare function calcChecksum(buf: Buffer, alg?: HashAlgorithm): string;
-export declare function checkChecksum(checksum: string, buf: Buffer, alg?: HashAlgorithm): boolean;
-export declare function calcFileChecksum(filename: string, alg?: HashAlgorithm): Promise<string>;
-export declare function checkFile(checksum: string, filename: string, alg?: HashAlgorithm): Promise<boolean>;
-export {};
-//# sourceMappingURL=checksum.d.ts.map

package/dist/shasum/checksum.js

@@ -1,19 +0,0 @@
-import { createHash } from 'node:crypto';
-import { readFile } from 'node:fs/promises';
-export function calcChecksum(buf, alg = 'SHA1') {
-    const hash = createHash(alg);
-    hash.update(buf);
-    return hash.digest('hex');
-}
-export function checkChecksum(checksum, buf, alg) {
-    const value = calcChecksum(buf, alg);
-    return value === checksum;
-}
-export async function calcFileChecksum(filename, alg) {
-    const buf = await readFile(filename);
-    return calcChecksum(buf, alg);
-}
-export async function checkFile(checksum, filename, alg) {
-    return (await calcFileChecksum(filename, alg)) === checksum;
-}
-//# sourceMappingURL=checksum.js.map

package/dist/shasum/index.d.ts

@@ -1,3 +0,0 @@
-export { calcFileChecksum } from './checksum.js';
-export { checkShasumFile, updateChecksumForFiles } from './shasum.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/shasum/index.js

@@ -1,3 +0,0 @@
-export { calcFileChecksum } from './checksum.js';
-export { checkShasumFile, updateChecksumForFiles } from './shasum.js';
-//# sourceMappingURL=index.js.map

package/dist/shasum/shasum.d.ts

@@ -1,38 +0,0 @@
-export interface CheckShasumFileResult {
-    passed: boolean;
-    results: CheckFileResult[];
-}
-export interface CheckFileResult {
-    filename: string;
-    passed: boolean;
-    error?: Error;
-}
-export declare function shasumFile(filename: string, root: string | undefined): Promise<string>;
-/**
- *
- * @param filename - name of checksum file
- * @param files - optional list of files to check
- * @param root - optional root, default cwd.
- */
-export declare function checkShasumFile(filename: string, files: string[] | undefined, root?: string): Promise<CheckShasumFileResult>;
-export interface ChecksumEntry {
-    filename: string;
-    checksum: string;
-    lineNumber: number;
-}
-export declare function readAndParseShasumFile(filename: string): Promise<ChecksumEntry[]>;
-export declare function parseShasumFile(content: string): ChecksumEntry[];
-interface ReportResult {
-    report: string;
-    passed: boolean;
-}
-interface ReportOptions {
-    root?: string | undefined;
-    listFile?: string[] | undefined;
-}
-export declare function reportChecksumForFiles(files: string[], options: ReportOptions): Promise<ReportResult>;
-export declare function reportCheckChecksumFile(filename: string, files: string[] | undefined, options: ReportOptions): Promise<ReportResult>;
-export declare function calcUpdateChecksumForFiles(filename: string, files: string[], options: ReportOptions): Promise<string>;
-export declare function updateChecksumForFiles(filename: string, files: string[], options: ReportOptions): Promise<ReportResult>;
-export {};
-//# sourceMappingURL=shasum.d.ts.map

package/dist/shasum/shasum.js

@@ -1,150 +0,0 @@
-import { readFile, writeFile } from 'node:fs/promises';
-import { resolve, sep as pathSep } from 'node:path';
-import { toError } from '../util/errors.js';
-import { isDefined } from '../util/index.js';
-import { calcFileChecksum, checkFile } from './checksum.js';
-export async function shasumFile(filename, root) {
-    try {
-        const file = resolve(root || '.', filename);
-        const checksum = await calcFileChecksum(file);
-        return `${checksum}  ${filename}`;
-    }
-    catch {
-        // const err = toError(error);
-        // Reject with a string.
-        // eslint-disable-next-line unicorn/no-useless-promise-resolve-reject
-        return Promise.reject(`shasum: ${filename}: Unable to read file.`);
-    }
-}
-/**
- *
- * @param filename - name of checksum file
- * @param files - optional list of files to check
- * @param root - optional root, default cwd.
- */
-export async function checkShasumFile(filename, files, root) {
-    files = !files ? files : files.length ? files : undefined;
-    const shaFiles = await readAndParseShasumFile(filename);
-    const filesToCheck = !files ? shaFiles.map(({ filename }) => filename) : files;
-    const mapNameToChecksum = new Map(shaFiles.map((r) => [normalizeFilename(r.filename), r.checksum]));
-    const resolvedRoot = resolve(root || '.');
-    const results = await Promise.all(filesToCheck.map(normalizeFilename).map((filename) => {
-        return tryToCheckFile(filename, resolvedRoot, mapNameToChecksum.get(filename));
-    }));
-    const passed = !results.some((v) => !v.passed);
-    return { passed, results };
-}
-async function tryToCheckFile(filename, root, checksum) {
-    if (!checksum) {
-        return { filename, passed: false, error: new Error('Missing Checksum.') };
-    }
-    const file = resolve(root, filename);
-    try {
-        const passed = await checkFile(checksum, file);
-        return { filename, passed };
-    }
-    catch {
-        return { filename, passed: false, error: new Error('Failed to read file.') };
-    }
-}
-const regLine = /([a-f0-9]{40,}) {2}(.*)/;
-export async function readAndParseShasumFile(filename) {
-    const content = await readFile(resolve(filename), 'utf8');
-    const shaFiles = parseShasumFile(content);
-    return shaFiles;
-}
-export function parseShasumFile(content) {
-    const lines = content.split(/\r?\n|\r/g);
-    return lines.map(parseLine).filter(isDefined);
-    function parseLine(line, index) {
-        const m = line.match(regLine);
-        const lineNumber = index + 1;
-        if (!m) {
-            if (line.trim()) {
-                throw new Error(`Failed to parse line ${lineNumber} of checksum file.`);
-            }
-            return undefined;
-        }
-        const checksum = m[1];
-        const filename = m[2];
-        return { checksum, filename, lineNumber };
-    }
-}
-export async function reportChecksumForFiles(files, options) {
-    const root = options.root;
-    const filesToCheck = await resolveFileList(files, options.listFile);
-    let numFailed = 0;
-    const result = await Promise.all(filesToCheck.map((file) => shasumFile(file, root).catch((e) => {
-        ++numFailed;
-        if (typeof e !== 'string')
-            throw e;
-        return e;
-    })));
-    const report = result.join('\n');
-    const passed = !numFailed;
-    return { report, passed };
-}
-export async function reportCheckChecksumFile(filename, files, options) {
-    const root = options.root;
-    const filesToCheck = await resolveFileList(files, options.listFile);
-    const checkResult = await checkShasumFile(filename, filesToCheck, root);
-    const results = checkResult.results;
-    const lines = results.map(({ filename, passed, error }) => `${filename}: ${passed ? 'OK' : 'FAILED'} ${error ? '- ' + error.message : ''}`.trim());
-    const withErrors = results.filter((a) => !a.passed);
-    const passed = !withErrors.length;
-    if (!passed) {
-        lines.push(`shasum: WARNING: ${withErrors.length} computed checksum${withErrors.length > 1 ? 's' : ''} did NOT match`);
-    }
-    return { report: lines.join('\n'), passed };
-}
-async function resolveFileList(files, listFile) {
-    files = files || [];
-    listFile = listFile || [];
-    const setOfFiles = new Set(files);
-    const pending = listFile.map((filename) => readFile(filename, 'utf8'));
-    for await (const content of pending) {
-        content
-            .split('\n')
-            .map((a) => a.trim())
-            .filter((a) => a)
-            .forEach((file) => setOfFiles.add(file));
-    }
-    return [...setOfFiles].map(normalizeFilename);
-}
-export async function calcUpdateChecksumForFiles(filename, files, options) {
-    const root = options.root || '.';
-    const filesToCheck = await resolveFileList(files, options.listFile);
-    const currentEntries = (await readAndParseShasumFile(filename).catch((err) => {
-        const e = toError(err);
-        if (e.code !== 'ENOENT')
-            throw e;
-        return [];
-    })).map((entry) => ({ ...entry, filename: normalizeFilename(entry.filename) }));
-    const entriesToUpdate = new Set([...filesToCheck, ...currentEntries.map((e) => e.filename)]);
-    const mustExist = new Set(filesToCheck);
-    const checksumMap = new Map(currentEntries.map(({ filename, checksum }) => [filename, checksum]));
-    for (const file of entriesToUpdate) {
-        try {
-            const checksum = await calcFileChecksum(resolve(root, file));
-            checksumMap.set(file, checksum);
-        }
-        catch (e) {
-            if (mustExist.has(file) || toError(e).code !== 'ENOENT')
-                throw e;
-            checksumMap.delete(file);
-        }
-    }
-    const updatedEntries = [...checksumMap]
-        .map(([filename, checksum]) => ({ filename, checksum }))
-        .sort((a, b) => (a.filename < b.filename ? -1 : 1));
-    return updatedEntries.map((e) => `${e.checksum}  ${e.filename}`).join('\n') + '\n';
-}
-export async function updateChecksumForFiles(filename, files, options) {
-    const content = await calcUpdateChecksumForFiles(filename, files, options);
-    await writeFile(filename, content);
-    return { passed: true, report: content };
-}
-function normalizeFilename(filename) {
-    return filename.split(pathSep).join('/');
-}
-//# sourceMappingURL=shasum.js.map

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