reportCliError.test.mjs

// @ts-check

import { strictEqual, throws } 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";

import reportCliError from "./reportCliError.mjs";

describe("Function `reportCliError`.", { concurrency: true }, () => {
  it("Argument 1 `cliDescription` not a string.", () => {
    throws(() => {
      reportCliError(
        // @ts-expect-error Testing invalid.
        true,
        new Error("Message."),
      );
    }, new TypeError("Argument 1 `cliDescription` must be a string."));
  });

  describe("`Error` instance.", { concurrency: true }, () => {
    it("With stack.", async () => {
      const { stdout, stderr, status, error } = spawnSync(
        "node",
        [
          fileURLToPath(
            new URL(
              "./test/fixtures/reportCliError/Error-instance-with-stack.mjs",
              import.meta.url,
            ),
          ),
        ],
        {
          env: {
            ...process.env,
            FORCE_COLOR: "1",
          },
        },
      );

      if (error) throw error;

      strictEqual(stdout.toString(), "");

      await assertSnapshot(
        replaceStackTraces(stderr.toString()),
        new URL(
          "./test/snapshots/reportCliError/Error-instance-with-stack-stderr.ans",
          import.meta.url,
        ),
      );

      strictEqual(status, 0);
    });

    it("Without stack.", async () => {
      const { stdout, stderr, status, error } = spawnSync(
        "node",
        [
          fileURLToPath(
            new URL(
              "./test/fixtures/reportCliError/Error-instance-without-stack.mjs",
              import.meta.url,
            ),
          ),
        ],
        {
          env: {
            ...process.env,
            FORCE_COLOR: "1",
          },
        },
      );

      if (error) throw error;

      strictEqual(stdout.toString(), "");

      await assertSnapshot(
        replaceStackTraces(stderr.toString()),
        new URL(
          "./test/snapshots/reportCliError/Error-instance-without-stack-stderr.ans",
          import.meta.url,
        ),
      );

      strictEqual(status, 0);
    });
  });

  it("`CliError` instance.", async () => {
    const { stdout, stderr, status, error } = spawnSync(
      "node",
      [
        fileURLToPath(
          new URL(
            "./test/fixtures/reportCliError/CliError-instance.mjs",
            import.meta.url,
          ),
        ),
      ],
      {
        env: {
          ...process.env,
          FORCE_COLOR: "1",
        },
      },
    );

    if (error) throw error;

    strictEqual(stdout.toString(), "");

    await assertSnapshot(
      replaceStackTraces(stderr.toString()),
      new URL(
        "./test/snapshots/reportCliError/CliError-instance-stderr.ans",
        import.meta.url,
      ),
    );

    strictEqual(status, 0);
  });

  it("Primitive value.", async () => {
    const { stdout, stderr, status, error } = spawnSync(
      "node",
      [
        fileURLToPath(
          new URL(
            "./test/fixtures/reportCliError/primitive-value.mjs",
            import.meta.url,
          ),
        ),
      ],
      {
        env: {
          ...process.env,
          FORCE_COLOR: "1",
        },
      },
    );

    if (error) throw error;

    strictEqual(stdout.toString(), "");

    await assertSnapshot(
      replaceStackTraces(stderr.toString()),
      new URL(
        "./test/snapshots/reportCliError/primitive-value-stderr.ans",
        import.meta.url,
      ),
    );

    strictEqual(status, 0);
  });
});