entry-point.test.ts

import { tempdirProject } from "@typestrong/fs-fixture-builder";
import { deepStrictEqual as equal, ok } from "assert";
import { join } from "path";
import { tmpdir } from "os";
import { Application, EntryPointStrategy, TSConfigReader } from "../..";

const fixture = tempdirProject();
fixture.addJsonFile("tsconfig.json", {
    include: ["."],
});
fixture.addJsonFile("package.json", {
    main: "index.ts",
});
fixture.addFile("index.ts", "export function fromIndex() {}");
fixture.addFile("extra.ts", "export function extra() {}");

describe("Entry Points", () => {
    beforeEach(() => {
        fixture.write();
    });

    afterEach(() => {
        fixture.rm();
    });

    const app = new Application();
    const tsconfig = join(fixture.cwd, "tsconfig.json");
    app.options.addReader(new TSConfigReader());

    it("Supports expanding existing paths", () => {
        app.bootstrap({
            tsconfig,
            entryPoints: [fixture.cwd],
            entryPointStrategy: EntryPointStrategy.Expand,
        });

        const entryPoints = app.getEntryPoints();
        ok(entryPoints);
        equal(
            entryPoints.length,
            2,
            "There are two files, so both should be expanded"
        );
    });

    it("Supports expanding globs in paths", () => {
        app.bootstrap({
            tsconfig,
            entryPoints: [`${fixture.cwd}/*.ts`],
            entryPointStrategy: EntryPointStrategy.Expand,
        });

        const entryPoints = app.getEntryPoints();
        ok(entryPoints);
        equal(
            entryPoints.length,
            2,
            "There are two files, so both should be expanded"
        );
    });

    it("Supports resolving directories", () => {
        app.bootstrap({
            tsconfig,
            entryPoints: [fixture.cwd],
            entryPointStrategy: EntryPointStrategy.Resolve,
        });

        const entryPoints = app.getEntryPoints();
        ok(entryPoints);
        equal(
            entryPoints.length,
            1,
            "entry-points/index.ts should have been the sole entry point"
        );
    });

    it("Supports resolving packages", () => {
        app.bootstrap({
            tsconfig: tsconfig,
            entryPoints: [fixture.cwd],
            entryPointStrategy: EntryPointStrategy.Packages,
        });

        const entryPoints = app.getEntryPoints();
        ok(entryPoints);
        equal(entryPoints.length, 1);
        equal(entryPoints[0].version, void 0);
        equal(entryPoints[0].readmeFile, void 0);
    });

    it("Supports resolving packages outside of cwd", () => {
        const fixture = tempdirProject({ rootDir: tmpdir() });
        fixture.addJsonFile("tsconfig.json", {
            include: ["."],
        });
        fixture.addJsonFile("package.json", {
            main: "index.ts",
        });
        fixture.addFile("index.ts", "export function fromIndex() {}");
        fixture.write();

        app.bootstrap({
            tsconfig: tsconfig,
            entryPoints: [fixture.cwd],
            entryPointStrategy: EntryPointStrategy.Packages,
        });

        const entryPoints = app.getEntryPoints();
        fixture.rm();
        ok(entryPoints);
        equal(entryPoints.length, 1);
        equal(entryPoints[0].version, void 0);
    });

    it("Supports custom tsconfig files #2061", () => {
        const fixture = tempdirProject({ rootDir: tmpdir() });
        fixture.addJsonFile("tsconfig.lib.json", {
            include: ["."],
        });
        fixture.addJsonFile("package.json", {
            main: "index.ts",
            typedoc: {
                tsconfig: "tsconfig.lib.json",
            },
        });
        fixture.addFile("index.ts", "export function fromIndex() {}");
        fixture.write();

        app.bootstrap({
            tsconfig: tsconfig,
            entryPoints: [fixture.cwd],
            entryPointStrategy: EntryPointStrategy.Packages,
        });

        const entryPoints = app.getEntryPoints();
        fixture.rm();
        ok(entryPoints);
        equal(entryPoints.length, 1);
    });

    it("Supports automatically discovering the readme files", () => {
        const fixture = tempdirProject();
        fixture.addJsonFile("tsconfig.json", {
            include: ["."],
        });
        fixture.addJsonFile("package.json", {
            main: "index.ts",
        });
        fixture.addFile("reaDME.md", "Text");
        fixture.addFile("index.ts", "export function fromIndex() {}");
        fixture.write();

        app.bootstrap({
            tsconfig: tsconfig,
            entryPoints: [fixture.cwd],
            entryPointStrategy: EntryPointStrategy.Packages,
        });

        const entryPoints = app.getEntryPoints();
        fixture.rm();
        ok(entryPoints);
        equal(entryPoints.length, 1);
        equal(entryPoints[0].readmeFile, join(fixture.cwd, "reaDME.md"));
    });
});