@cspell/cspell-tools/dist/test/TestHelper.d.ts

Tools to assist with the development of cSpell

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