find-unused-exports.test.mjs

// @ts-check

import { strictEqual } from "node:assert";
import { spawnSync } from "node:child_process";
import { describe, it } from "node:test";
import { fileURLToPath } from "node:url";

import replaceStackTraces from "replace-stack-traces";
import assertSnapshot from "snapshot-assertion";

describe("CLI command `find-unused-exports`.", { concurrency: true }, () => {
  const FIND_UNUSED_EXPORTS_CLI_PATH = fileURLToPath(
    new URL("./find-unused-exports.mjs", import.meta.url),
  );

  it("No unused exports.", async () => {
    const { stdout, stderr, status, error } = spawnSync(
      "node",
      [FIND_UNUSED_EXPORTS_CLI_PATH],
      {
        cwd: new URL("./test/fixtures/no-unused-exports", import.meta.url),
        env: {
          ...process.env,
          FORCE_COLOR: "1",
        },
      },
    );

    if (error) throw error;

    await assertSnapshot(
      stdout.toString(),
      new URL(
        "./test/snapshots/find-unused-exports/no-unused-exports-stdout.ans",
        import.meta.url,
      ),
    );
    strictEqual(stderr.toString(), "");
    strictEqual(status, 0);
  });

  it("Some unused exports.", async () => {
    const { stdout, stderr, status, error } = spawnSync(
      "node",
      [FIND_UNUSED_EXPORTS_CLI_PATH],
      {
        cwd: new URL("./test/fixtures/some-unused-exports", import.meta.url),
        env: {
          ...process.env,
          FORCE_COLOR: "1",
        },
      },
    );

    if (error) throw error;

    strictEqual(stdout.toString(), "");
    await assertSnapshot(
      stderr.toString(),
      new URL(
        "./test/snapshots/find-unused-exports/some-unused-exports-stderr.ans",
        import.meta.url,
      ),
    );
    strictEqual(status, 1);
  });

  it("Module containing TypeScript syntax.", async () => {
    const { stdout, stderr, status, error } = spawnSync(
      "node",
      [FIND_UNUSED_EXPORTS_CLI_PATH],
      {
        cwd: new URL("./test/fixtures/typescript-syntax", import.meta.url),
        env: {
          ...process.env,
          FORCE_COLOR: "1",
        },
      },
    );

    if (error) throw error;

    strictEqual(stdout.toString(), "");
    await assertSnapshot(
      stderr.toString(),
      new URL(
        "./test/snapshots/find-unused-exports/typescript-syntax-stderr.ans",
        import.meta.url,
      ),
    );
    strictEqual(status, 1);
  });

  describe("Arg `--import-map`.", { concurrency: true }, () => {
    it("Invalid.", async () => {
      const { stdout, stderr, status, error } = spawnSync(
        "node",
        [FIND_UNUSED_EXPORTS_CLI_PATH, "--import-map", "_"],
        {
          cwd: new URL("./test/fixtures/import-map", import.meta.url),
          env: {
            ...process.env,
            FORCE_COLOR: "1",
          },
        },
      );

      if (error) throw error;

      strictEqual(stdout.toString(), "");
      await assertSnapshot(
        stderr.toString(),
        new URL(
          "./test/snapshots/find-unused-exports/import-map-invalid-stderr.ans",
          import.meta.url,
        ),
      );
      strictEqual(status, 1);
    });

    it("Valid.", async () => {
      const { stdout, stderr, status, error } = spawnSync(
        "node",
        [
          FIND_UNUSED_EXPORTS_CLI_PATH,
          "--import-map",
          '"$(cat import-map.json)"',
        ],
        {
          cwd: new URL("./test/fixtures/import-map", import.meta.url),
          env: {
            ...process.env,
            FORCE_COLOR: "1",
          },
          shell: true,
        },
      );

      if (error) throw error;

      strictEqual(stdout.toString(), "");
      await assertSnapshot(
        stderr.toString(),
        new URL(
          "./test/snapshots/find-unused-exports/import-map-valid-stderr.ans",
          import.meta.url,
        ),
      );
      strictEqual(status, 1);
    });
  });

  it("Arg `--module-glob`.", async () => {
    const { stdout, stderr, status, error } = spawnSync(
      "node",
      [FIND_UNUSED_EXPORTS_CLI_PATH, "--module-glob", "**/*.txt"],
      {
        cwd: new URL("./test/fixtures/moduleGlob", import.meta.url),
        env: {
          ...process.env,
          FORCE_COLOR: "1",
        },
      },
    );

    if (error) throw error;

    strictEqual(stdout.toString(), "");
    await assertSnapshot(
      stderr.toString(),
      new URL(
        "./test/snapshots/find-unused-exports/module-glob-stderr.ans",
        import.meta.url,
      ),
    );
    strictEqual(status, 1);
  });

  it("Arg `--resolve-file-extensions`.", async () => {
    const { stdout, stderr, status, error } = spawnSync(
      "node",
      [FIND_UNUSED_EXPORTS_CLI_PATH, "--resolve-file-extensions", "mjs,a.mjs"],
      {
        cwd: new URL(
          "./test/fixtures/extensionless-import-specifiers",
          import.meta.url,
        ),
        env: {
          ...process.env,
          FORCE_COLOR: "1",
        },
      },
    );

    if (error) throw error;

    strictEqual(stdout.toString(), "");
    await assertSnapshot(
      stderr.toString(),
      new URL(
        "./test/snapshots/find-unused-exports/resolve-file-extensions-stderr.ans",
        import.meta.url,
      ),
    );
    strictEqual(status, 1);
  });

  it("Args `--resolve-file-extensions` and `--resolve-index-files`.", async () => {
    const { stdout, stderr, status, error } = spawnSync(
      "node",
      [
        FIND_UNUSED_EXPORTS_CLI_PATH,
        "--resolve-file-extensions",
        "mjs,a.mjs",
        "--resolve-index-files",
      ],
      {
        cwd: new URL(
          "./test/fixtures/extensionless-import-specifiers-and-index-files",
          import.meta.url,
        ),
        env: {
          ...process.env,
          FORCE_COLOR: "1",
        },
      },
    );

    if (error) throw error;

    strictEqual(stdout.toString(), "");
    await assertSnapshot(
      stderr.toString(),
      new URL(
        "./test/snapshots/find-unused-exports/resolve-file-extensions-and-index-files-stderr.ans",
        import.meta.url,
      ),
    );
    strictEqual(status, 1);
  });

  it("Arg `--resolve-index-files` without using arg `--resolve-file-extensions`.", async () => {
    const { stdout, stderr, status, error } = spawnSync(
      "node",
      [FIND_UNUSED_EXPORTS_CLI_PATH, "--resolve-index-files"],
      {
        cwd: new URL(
          "./test/fixtures/extensionless-import-specifiers-and-index-files",
          import.meta.url,
        ),
        env: {
          ...process.env,
          FORCE_COLOR: "1",
        },
      },
    );

    if (error) throw error;

    strictEqual(stdout.toString(), "");
    await assertSnapshot(
      stderr.toString(),
      new URL(
        "./test/snapshots/find-unused-exports/resolve-index-files-without-resolve-file-extensions-stderr.ans",
        import.meta.url,
      ),
    );
    strictEqual(status, 1);
  });

  it("Module Babel can’t parse.", async () => {
    const fixtureProjectPath = fileURLToPath(
      new URL("./test/fixtures/unparsable-module", import.meta.url),
    );
    const { stdout, stderr, status, error } = spawnSync(
      "node",
      [FIND_UNUSED_EXPORTS_CLI_PATH, "--module-glob", "**/*.txt"],
      {
        cwd: fixtureProjectPath,
        env: {
          ...process.env,
          FORCE_COLOR: "1",
        },
      },
    );

    if (error) throw error;

    strictEqual(stdout.toString(), "");
    await assertSnapshot(
      replaceStackTraces(
        stderr.toString().replace(fixtureProjectPath, "<path>"),
      ),
      new URL(
        "./test/snapshots/find-unused-exports/unparsable-module-stderr.ans",
        import.meta.url,
      ),
    );
    strictEqual(status, 1);
  });
});