@typespec/compiler/dist/src/testing/test-utils.js

TypeSpec compiler and standard library

import { fail, ok } from "assert";
import { fileURLToPath } from "url";
import { getTypeName } from "../core/helpers/type-name-utils.js";
import { NodeHost } from "../core/node-host.js";
import { resolvePath } from "../core/path-utils.js";
import { findProjectRoot } from "../utils/io.js";
export function resolveVirtualPath(path, ...paths) {
    // NB: We should always resolve an absolute path, and there is no absolute
    // path that works across OSes. This ensures that we can still rely on API
    // like pathToFileURL in tests.
    const rootDir = process.platform === "win32" ? "Z:/test" : "/test";
    return resolvePath(rootDir, path, ...paths);
}
/** Find the package root from the provided file
 * @deprecated Use {@link createTester} instead
 */
export function findTestPackageRoot(fileUrl) {
    return findProjectRoot(NodeHost.stat, fileURLToPath(fileUrl));
}
/**
 * Define a test library defaulting to the most common library structure.
 * @param init Library configuration.
 * @returns TypeSpec Test library.
 * @deprecated Use {@link createTester} instead
 */
// eslint-disable-next-line @typescript-eslint/no-deprecated
export function createTestLibrary(init) {
    const { name } = init;
    const typespecFileFolder = init.typespecFileFolder ?? "lib";
    const jsFileFolder = init.jsFileFolder ?? "dist/src";
    return {
        name,
        packageRoot: init.packageRoot,
        files: [
            { realDir: "", pattern: "package.json", virtualPath: `./node_modules/${name}` },
            {
                realDir: typespecFileFolder,
                pattern: "**/*.tsp",
                virtualPath: resolvePath(`./node_modules/${name}`, typespecFileFolder),
            },
            {
                realDir: jsFileFolder,
                pattern: "**/*.js",
                virtualPath: resolvePath(`./node_modules/${name}`, jsFileFolder),
            },
        ],
    };
}
/** @deprecated Use {@link createTester} instead */
/* eslint-disable @typescript-eslint/no-deprecated -- implementing deprecated API for backward compatibility */
export function createTestWrapper(host, testWrapperOptions = {}) {
    const { autoImports, autoUsings, wrapper, compilerOptions: defaultCompilerOptions, } = testWrapperOptions;
    const autoCode = [
        ...(autoImports ??
            host.libraries.filter((x) => x.name !== "@typespec/compiler").map((x) => x.name)).map((x) => `import "${x}";`),
        ...(autoUsings ?? []).map((x) => `using ${x};`),
    ].join("\n");
    const wrap = (code) => {
        return `${autoCode}${wrapper ? wrapper(code) : code}`;
    };
    return {
        get program() {
            return host.program;
        },
        fs: host.fs,
        autoCodeOffset: autoCode.length,
        compile: (code, options) => {
            host.addTypeSpecFile("./main.tsp", wrap(code));
            return host.compile("./main.tsp", { ...defaultCompilerOptions, ...options });
        },
        diagnose: (code, options) => {
            host.addTypeSpecFile("./main.tsp", wrap(code));
            return host.diagnose("./main.tsp", { ...defaultCompilerOptions, ...options });
        },
        compileAndDiagnose: (code, options) => {
            host.addTypeSpecFile("./main.tsp", wrap(code));
            return host.compileAndDiagnose("./main.tsp", { ...defaultCompilerOptions, ...options });
        },
    };
}
/* eslint-enable @typescript-eslint/no-deprecated */
export function trimBlankLines(code) {
    let start = 0;
    for (let i = 0; i < code.length; i++) {
        if (code[i] === " ") {
            start++;
        }
        else if (code[i] === "\n") {
            break;
        }
        else {
            start = 0;
            break;
        }
    }
    let end = 0;
    for (let i = code.length - 1; i >= 0; i--) {
        if (code[i] === " ") {
            end--;
        }
        else if (code[i] === "\n") {
            break;
        }
        else {
            end = 0;
            break;
        }
    }
    return code.slice(start, end);
}
/**
 * Compare 2 TypeSpec type and make sure they are the exact same(a === b).
 * Show a better diff than just having ok(a===b) while not crashing like strictEqual/expect.toEqual
 */
export function expectTypeEquals(actual, expected) {
    if (actual === expected)
        return;
    ok(actual, "Expected value to be defined");
    const message = [`Expected type ${getTypeName(actual)} to be ${getTypeName(expected)}:`];
    if (actual.kind !== expected.kind) {
        message.push(`kind: ${actual.kind} !== ${expected.kind}`);
    }
    if ("symbol" in actual && "symbol" in expected) {
        message.push(`symbol: ${expected && actual.symbol === expected.symbol}`);
    }
    fail(message.join("\n"));
}
//# sourceMappingURL=test-utils.js.map