test: add end-to-end tests

Author: tscpp

.github/workflows/checks.yml

@@ -37,6 +37,21 @@ jobs:
       - run: npm ci
       - run: npm test
 
+  e2e:
+    name: E2E
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+          cache: "npm"
+
+      - run: npm ci
+      - run: npm run e2e
+
   lint:
     name: Lint
     runs-on: ubuntu-latest

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 /dist
 /coverage
+/e2e/out

.vscode/tasks.json

@@ -3,14 +3,14 @@
   "tasks": [
     {
       "type": "typescript",
-      "tsconfig": "tsconfig.json",
+      "tsconfig": "tsconfig.lib.json",
       "option": "watch",
       "problemMatcher": ["$tsc-watch"],
       "group": {
         "kind": "build",
         "isDefault": true
       },
-      "label": "tsc: watch - tsconfig.json"
+      "label": "tsc: watch - tsconfig.lib.json"
     }
   ]
 }

e2e/stable-bump.test.ts

@@ -0,0 +1,49 @@
+import { expect, it } from "@jest/globals";
+import sandbox from "./utils/sandbox.js";
+import json from "./utils/json.js";
+import { CONVER } from "./utils/binary.js";
+
+it("bumps stable version", async () => {
+  await sandbox("stable-bump", async ({ $, name, sandbox }) => {
+    // package.json
+    await sandbox.writeFiles({
+      "package.json": json({
+        name,
+        version: "1.2.3",
+      }),
+    });
+
+    // init sandbox
+    await $`git init`;
+    await $`${CONVER} init --yes`;
+    await $`git commit -m ${"chore: first commit"} --allow-empty`;
+
+    // check status
+    let status = await getStatus();
+    expect(status).toEqual([]);
+
+    // add commit
+    await sandbox.writeFiles({
+      "foo.txt": "foo",
+    });
+    await $`git add foo.txt`;
+    await $`git commit -m ${"feat: add foo"}`;
+
+    // check status
+    status = await getStatus();
+    expect(status).toEqual([
+      {
+        name,
+        oldVersion: "1.2.3",
+        newVersion: "1.3.0",
+        bump: "minor",
+      },
+    ]);
+
+    async function getStatus() {
+      const result = await $`${CONVER} status --json`;
+      const status = JSON.parse(result.stdout) as unknown;
+      return status;
+    }
+  });
+});

e2e/utils/binary.ts

@@ -0,0 +1,4 @@
+import { resolve } from "node:path";
+import packageJson from "../../package.json";
+
+export const CONVER = resolve(packageJson.bin.conver);

e2e/utils/json.ts

@@ -0,0 +1,3 @@
+export default function json(data: unknown) {
+  return JSON.stringify(data, undefined, 2);
+}

e2e/utils/sandbox.ts

@@ -0,0 +1,44 @@
+import { $, ExecaScriptMethod } from "execa";
+import { mkdir, rm, writeFile } from "node:fs/promises";
+import { join, resolve } from "node:path";
+
+export interface SandboxContext {
+  $: ExecaScriptMethod<{}>;
+  root: string;
+  name: string;
+  sandbox: Sandbox;
+}
+
+export default async function sandbox(
+  name: string,
+  callback: (sandbox: SandboxContext) => Promise<void>,
+) {
+  const root = resolve("e2e/out", name);
+  await mkdir(root, { recursive: true });
+  try {
+    await callback({
+      $: $({ cwd: root }),
+      root,
+      name,
+      sandbox: new Sandbox(root),
+    });
+  } finally {
+    await rm(root, { force: true, recursive: true });
+  }
+}
+
+export class Sandbox {
+  constructor(private root: string) {}
+
+  async writeFiles(files: Record<string, string>): Promise<void> {
+    for (const [name, data] of Object.entries(files)) {
+      await writeFile(join(this.root, name), data);
+    }
+  }
+
+  async removeFiles(files: string[]): Promise<void> {
+    for (const name of files) {
+      await rm(join(this.root, name), { force: true, recursive: true });
+    }
+  }
+}

eslint.config.js

@@ -8,10 +8,10 @@ export default [
     languageOptions: {
       globals: globals.node,
       parserOptions: {
-        project: ["tsconfig.json", "test/tsconfig.json"],
+        project: ["tsconfig.lib.json", "tsconfig.test.json"],
       },
     },
-    ignores: ["**/*", "!src/**/*"],
+    ignores: ["**/*", "!src/**/*", "!e2e/**/*"],
   },
   pluginJs.configs.recommended,
   ...tseslint.configs.recommendedTypeChecked,

package.json

@@ -42,7 +42,8 @@
     "lint": "eslint src",
     "prepare": "husky",
     "release": "npm run build && npm run version && npm publish",
-    "test": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js",
+    "test": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js src",
+    "e2e": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js e2e",
     "version": "node ./dist/cli/main.js version"
   },
   "dependencies": {

tsconfig.json

@@ -1,10 +1,11 @@
 {
   "extends": ["@tsconfig/strictest", "@tsconfig/node20"],
   "compilerOptions": {
-    "types": ["node", "@jest/globals"],
-    "rootDir": "src",
-    "outDir": "dist",
-    "declaration": true
+    "types": ["node"]
   },
-  "include": ["src"]
+  "references": [
+    { "path": "./tsconfig.lib.json" },
+    { "path": "./tsconfig.test.json" }
+  ],
+  "include": []
 }