build: switch to vitest (#293)

oscard0m · web-flow · commit 406ec25c8d44 · 2024-10-03T19:31:10.000-04:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -12,7 +12,8 @@
     "lint": "prettier --check '{src,test}/**/*' README.md package.json",
     "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json",
     "pretest": "npm run -s lint",
-    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --coverage"
+    "test": "vitest run --coverage",
+    "test:ui": "vitest --ui --coverage"
   },
   "repository": "https://github.com/octokit/plugin-create-or-update-text-file.js",
   "keywords": [
@@ -27,45 +28,20 @@
   "devDependencies": {
     "@octokit/core": "^6.0.1",
     "@octokit/tsconfig": "^3.0.0",
-    "@types/jest": "^29.5.2",
     "@types/node": "^20.0.0",
+    "@vitest/coverage-v8": "^2.1.2",
+    "@vitest/ui": "^2.1.2",
     "esbuild": "^0.24.0",
     "fetch-mock": "npm:@gr2m/fetch-mock@9.11.0-pull-request-644.1",
     "glob": "^11.0.0",
-    "jest": "^29.5.0",
     "prettier": "3.3.3",
     "semantic-release-plugin-update-version-in-files": "^1.1.0",
-    "ts-jest": "^29.0.0",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "vitest": "^2.1.2"
   },
   "peerDependencies": {
     "@octokit/core": ">=6"
   },
-  "jest": {
-    "extensionsToTreatAsEsm": [
-      ".ts"
-    ],
-    "transform": {
-      "^.+\\.(ts|tsx)$": [
-        "ts-jest",
-        {
-          "tsconfig": "test/tsconfig.test.json",
-          "useESM": true
-        }
-      ]
-    },
-    "coverageThreshold": {
-      "global": {
-        "statements": 100,
-        "branches": 100,
-        "functions": 100,
-        "lines": 100
-      }
-    },
-    "moduleNameMapper": {
-      "^(.+)\\.jsx?$": "$1"
-    }
-  },
   "release": {
     "branches": [
       "+([0-9]).x",
diff --git a/src/compose-create-or-update-text-file.ts b/src/compose-create-or-update-text-file.ts
@@ -1,4 +1,4 @@
-import { Octokit } from "@octokit/core";
+import type { Octokit } from "@octokit/core";
 
 import { getFileContents } from "./get-file-content.js";
 import type {
diff --git a/src/get-file-content.ts b/src/get-file-content.ts
@@ -1,5 +1,5 @@
 import { RequestError } from "@octokit/request-error";
-import { Octokit } from "@octokit/core";
+import type { Octokit } from "@octokit/core";
 import { base64ToUtf8 } from "./utils.js";
 
 type Options = {
@@ -55,7 +55,7 @@ export async function getFileContents(
   const { data } = await octokit
     .request(route, getContentsParameters)
     .catch((error: RequestError) => {
-      /* istanbul ignore if */
+      /* v8 ignore next */
       if (error.status !== 404) throw error;
 
       return {
@@ -98,11 +98,10 @@ export async function getFileContents(
       content: base64ToUtf8(data.content),
       sha: data.sha,
     };
+    /* v8 ignore start */
   } catch (error: any) {
-    /* istanbul ignore next */
     if (error.message !== "URI malformed") throw error;
 
-    /* istanbul ignore next error is only thrown in browsers, not node. */
     throw new RequestError(
       `[@octokit/plugin-create-or-update-text-file] ${requestOptions.url} is a binary file, only text files are supported`,
       403,
@@ -111,4 +110,5 @@ export async function getFileContents(
       },
     );
   }
+  /* v8 ignore stop */
 }
diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,4 @@
-import { Octokit } from "@octokit/core";
+import type { Octokit } from "@octokit/core";
 
 import { composeCreateOrUpdateTextFile } from "./compose-create-or-update-text-file.js";
 import { VERSION } from "./version.js";
diff --git a/src/utils.ts b/src/utils.ts
@@ -1,5 +1,4 @@
-/* istanbul ignore file */
-
+/* v8 ignore start */
 // universal implementation of nodeUtf8ToBase64/nodeBase64ToUtf8 methods for browsers, Node, and Deno.
 //
 // - good docs on base64
@@ -55,3 +54,5 @@ function browserBase64ToUtf8(data: string) {
 
 export const utf8ToBase64 = isNode ? nodeUtf8ToBase64 : browserUtf8ToBase64;
 export const base64ToUtf8 = isNode ? nodeBase64ToUtf8 : browserBase64ToUtf8;
+
+/* v8 ignore stop */
diff --git a/test/create-or-update-text-file.test.ts b/test/create-or-update-text-file.test.ts
@@ -3,6 +3,7 @@ import { Octokit } from "@octokit/core";
 
 import { createOrUpdateTextFile } from "../src";
 import { utf8ToBase64 } from "../src/utils";
+import { describe, it, expect } from "vitest";
 
 const MyOctokit = Octokit.plugin(createOrUpdateTextFile).defaults({
   userAgent: "test",
diff --git a/test/errors.test.ts b/test/errors.test.ts
@@ -3,6 +3,8 @@ import { Octokit } from "@octokit/core";
 
 import { createOrUpdateTextFile } from "../src";
 
+import { describe, test, expect } from "vitest";
+
 const MyOctokit = Octokit.plugin(createOrUpdateTextFile).defaults({
   userAgent: "test",
 });
diff --git a/test/smoke.test.ts b/test/smoke.test.ts
@@ -1,4 +1,5 @@
 import { createOrUpdateTextFile, composeCreateOrUpdateTextFile } from "../src";
+import { describe, it, expect } from "vitest";
 
 describe("createOrUpdateTextFile", () => {
   it("is a function", () => {
diff --git a/test/tsconfig.test.json b/test/tsconfig.test.json
diff --git a/vite.config.js b/vite.config.js
@@ -0,0 +1,14 @@
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  test: {
+    coverage: {
+      include: ["src/**/*.ts"],
+      reporter: ["html", "text", "json"],
+      thresholds: {
+        100: true,
+      },
+      reportOnFailure: true,
+    },
+  },
+});

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { Octokit } from "@octokit/core";`
	`1`	`+import type { Octokit } from "@octokit/core";`
`2`	`2`
`3`	`3`	`import { getFileContents } from "./get-file-content.js";`
`4`	`4`	`import type {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import { createOrUpdateTextFile, composeCreateOrUpdateTextFile } from "../src";`
	`2`	`+import { describe, it, expect } from "vitest";`
`2`	`3`
`3`	`4`	`describe("createOrUpdateTextFile", () => {`
`4`	`5`	`it("is a function", () => {`