utils.test.ts

import { createFixture } from "fs-fixture";
import { afterEach, expect, test, vi } from "vitest";
import {
  BumpLevels,
  getChangelogEntry,
  sortTheThings,
  throwOnRemovedCommitModeInput,
  validateChangesetsCliVersion,
  isObject,
  isString,
} from "./utils.ts";

let changelog = `# @keystone-alpha/email

## 3.0.1

### Patch Changes

- [19fe6c1b](https://github.com/keystonejs/keystone-5/commit/19fe6c1b):

  Move frontmatter in docs into comments

## 3.0.0

### Major Changes

- [2164a779](https://github.com/keystonejs/keystone-5/commit/2164a779):

  - Replace jade with pug because Jade was renamed to Pug, and \`jade\` package is outdated

### Patch Changes

- [81dc0be5](https://github.com/keystonejs/keystone-5/commit/81dc0be5):

  - Update dependencies

## 2.0.0

- [patch][b69fb9b7](https://github.com/keystonejs/keystone-5/commit/b69fb9b7):

  - Update dev devependencies

- [major][f97e4ecf](https://github.com/keystonejs/keystone-5/commit/f97e4ecf):

  - Export { emailSender } as the API, rather than a default export

## 1.0.2

- [patch][7417ea3a](https://github.com/keystonejs/keystone-5/commit/7417ea3a):

  - Update patch-level dependencies

## 1.0.1

- [patch][1f0bc236](https://github.com/keystonejs/keystone-5/commit/1f0bc236):

  - Update the package.json author field to "The Keystone Development Team"

## 1.0.0

- [major] 8b6734ae:

  - This is the first release of keystone-alpha (previously voussoir).
    All packages in the \`@voussoir\` namespace are now available in the \`@keystone-alpha\` namespace, starting at version \`1.0.0\`.
    To upgrade your project you must update any \`@voussoir/<foo>\` dependencies in \`package.json\` to point to \`@keystone-alpha/<foo>: "^1.0.0"\` and update any \`require\`/\`import\` statements in your code.

# @voussoir/email

## 0.0.2

- [patch] 113e16d4:

  - Remove unused dependencies

- [patch] 625c1a6d:

  - Update mjml-dependency
`;

afterEach(() => {
  vi.unstubAllEnvs();
});

test("it works", () => {
  let entry = getChangelogEntry(changelog, "3.0.0");
  expect(entry.content).toMatchSnapshot();
  expect(entry.highestLevel).toBe(BumpLevels.major);
});

test("it works", () => {
  let entry = getChangelogEntry(changelog, "3.0.1");
  expect(entry.content).toMatchSnapshot();
  expect(entry.highestLevel).toBe(BumpLevels.patch);
});

test("it sorts the things right", () => {
  let things = [
    {
      name: "a",
      highestLevel: BumpLevels.major,
      private: true,
    },
    {
      name: "b",
      highestLevel: BumpLevels.patch,
      private: false,
    },
    {
      name: "c",
      highestLevel: BumpLevels.major,
      private: false,
    },
  ];
  expect(things.sort(sortTheThings)).toMatchSnapshot();
});

test.each([
  ["commit-mode", "git-cli", "push-with-git-cli: true"],
  ["commit-mode", "github-api", "push-with-git-cli: false"],
  ["commitMode", "git-cli", "push-with-git-cli: true"],
  ["commitMode", "github-api", "push-with-git-cli: false"],
])(
  "explains how to migrate the removed %s input from %s",
  (inputName, value, replacement) => {
    vi.stubEnv(`INPUT_${inputName.toUpperCase()}`, value);
    expect(() => throwOnRemovedCommitModeInput()).toThrow(replacement);
  },
);

test("throws when the project declares Changesets CLI v2", async () => {
  await using fixture = await createFixture({
    "package.json": JSON.stringify({
      name: "project",
      devDependencies: { "@changesets/cli": "^2.29.7" },
    }),
    "package-lock.json": "",
  });

  await expect(validateChangesetsCliVersion(fixture.path)).rejects.toThrow(
    "This version of the Changesets action is designed to work with Changesets CLI v3. Changesets CLI v2 is not supported; use Changesets action v1 instead, which is compatible with CLI v2.",
  );
});

test("accepts a Changesets CLI v3 contract without an installed CLI", async () => {
  await using fixture = await createFixture({
    "package.json": JSON.stringify({
      name: "project",
      devDependencies: { "@changesets/cli": "^3.0.0" },
    }),
    "package-lock.json": "",
  });

  await expect(
    validateChangesetsCliVersion(fixture.path),
  ).resolves.toBeUndefined();
});

test("throws when the project has Changesets CLI v2 installed", async () => {
  await using fixture = await createFixture({
    "package.json": JSON.stringify({
      name: "project",
      devDependencies: { "@changesets/cli": "^3.0.0" },
    }),
    "package-lock.json": "",
    "node_modules/@changesets/cli/package.json": JSON.stringify({
      name: "@changesets/cli",
      version: "2.29.7",
    }),
  });

  await expect(validateChangesetsCliVersion(fixture.path)).rejects.toThrow(
    "This version of the Changesets action is designed to work with Changesets CLI v3. Changesets CLI v2 is not supported; use Changesets action v1 instead, which is compatible with CLI v2.",
  );
});

test.each([
  {
    input: null,
    expected: false,
  },
  {
    input: undefined,
    expected: false,
  },
  {
    input: "changesets",
    expected: false,
  },
  {
    input: 1,
    expected: false,
  },
  {
    input: true,
    expected: false,
  },
  {
    input: [],
    expected: false,
  },
  {
    input: {},
    expected: true,
  },
])("isObject: $input should return $expected", ({ input, expected }) => {
  expect(isObject(input)).toBe(expected);
});

test.each([
  {
    input: null,
    expected: false,
  },
  {
    input: undefined,
    expected: false,
  },
  {
    input: "changesets",
    expected: true,
  },
  {
    input: 1,
    expected: false,
  },
  {
    input: true,
    expected: false,
  },
  {
    input: [],
    expected: false,
  },
  {
    input: {},
    expected: false,
  },
  {
    input: () => "test",
    expected: false,
  },
])("isString: $input should return $expected", ({ input, expected }) => {
  expect(isString(input)).toBe(expected);
});