chore: use vitest (#260)

probot · Jul 21, 2024 · 76f1ed9 · 76f1ed9
1 parent c03bc0e
commit 76f1ed9
Show file tree

Hide file tree

Showing 7 changed files with 1,704 additions and 4,595 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -8,7 +8,7 @@
     "lint": "prettier --check '{src,test}/**/*.ts' README.md package.json",
     "lint:fix": "prettier --write '{src,test}/**/*.ts' README.md package.json",
     "pretest": "npm run -s lint",
-    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --coverage"
+    "test": "vitest run --coverage"
   },
   "repository": "github:probot/octokit-plugin-config",
   "keywords": [
@@ -22,48 +22,21 @@
   "devDependencies": {
     "@octokit/core": "^6.0.1",
     "@octokit/tsconfig": "^3.0.0",
-    "@types/jest": "^29.0.0",
     "@types/js-yaml": "^4.0.5",
     "@types/node": "^20.0.0",
+    "@vitest/coverage-v8": "^2.0.3",
     "esbuild": "^0.21.0",
     "fetch-mock": "npm:@gr2m/fetch-mock@9.11.0-pull-request-644.1",
     "globby": "^14.0.0",
-    "jest": "^29.0.0",
     "prettier": "^3.0.0",
     "semantic-release-plugin-update-version-in-files": "^1.1.0",
     "strip-indent": "^4.0.0",
-    "ts-jest": "^29.0.0",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "vitest": "^2.0.3"
   },
   "peerDependencies": {
     "@octokit/core": ">=5"
   },
-  "jest": {
-    "extensionsToTreatAsEsm": [
-      ".ts"
-    ],
-    "transform": {
-      "^.+\\.(ts|tsx)$": [
-        "ts-jest",
-        {
-          "tsconfig": "test/tsconfig.test.json",
-          "useESM": true
-        }
-      ]
-    },
-    "testEnvironment": "node",
-    "coverageThreshold": {
-      "global": {
-        "statements": 100,
-        "branches": 100,
-        "functions": 100,
-        "lines": 100
-      }
-    },
-    "moduleNameMapper": {
-      "^(.+)\\.jsx?$": "$1"
-    }
-  },
   "release": {
     "branches": [
       "+([0-9]).x",

diff --git a/test/__snapshots__/get.test.ts.snap b/test/__snapshots__/get.test.ts.snap
@@ -1,6 +1,6 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`octokit.config.get .json extension: result 1`] = `
+exports[`octokit.config.get > .json extension > result 1`] = `
 {
   "config": {
     "comment": "Thank you for creating the issue!",
@@ -19,7 +19,7 @@ exports[`octokit.config.get .json extension: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get .yaml extension: result 1`] = `
+exports[`octokit.config.get > .yaml extension > result 1`] = `
 {
   "config": {
     "comment": "Thank you for creating the issue!",
@@ -38,7 +38,7 @@ exports[`octokit.config.get .yaml extension: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get _extends file is missing: result 1`] = `
+exports[`octokit.config.get > _extends file is missing > result 1`] = `
 {
   "config": {
     "setting1": "value from repo config file",
@@ -64,7 +64,37 @@ exports[`octokit.config.get _extends file is missing: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get _extends: base -> _extends: base2: result 1`] = `
+exports[`octokit.config.get > _extends: base > result 1`] = `
+{
+  "config": {
+    "setting1": "value from repo config file",
+    "setting2": "value from base config file",
+  },
+  "files": [
+    {
+      "config": {
+        "setting1": "value from repo config file",
+      },
+      "owner": "octocat",
+      "path": ".github/my-app.yml",
+      "repo": "hello-world",
+      "url": "https://github.com/gitapi/repos/octocat/hello-world/contents/.github%2Fmy-app.yml",
+    },
+    {
+      "config": {
+        "setting1": "value from base config file",
+        "setting2": "value from base config file",
+      },
+      "owner": "octocat",
+      "path": ".github/my-app.yml",
+      "repo": "base",
+      "url": "https://github.com/gitapi/repos/octocat/base/contents/.github%2Fmy-app.yml",
+    },
+  ],
+}
+`;
+
+exports[`octokit.config.get > _extends: base -> _extends: base2 > result 1`] = `
 {
   "config": {
     "setting1": "value from repo config file",
@@ -106,7 +136,7 @@ exports[`octokit.config.get _extends: base -> _extends: base2: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get _extends: base with defaults and custom merge: result 1`] = `
+exports[`octokit.config.get > _extends: base with defaults and custom merge > result 1`] = `
 {
   "config": {
     "otherSetting1": "value from repo config file",
@@ -149,37 +179,7 @@ exports[`octokit.config.get _extends: base with defaults and custom merge: resul
 }
 `;
 
-exports[`octokit.config.get _extends: base: result 1`] = `
-{
-  "config": {
-    "setting1": "value from repo config file",
-    "setting2": "value from base config file",
-  },
-  "files": [
-    {
-      "config": {
-        "setting1": "value from repo config file",
-      },
-      "owner": "octocat",
-      "path": ".github/my-app.yml",
-      "repo": "hello-world",
-      "url": "https://github.com/gitapi/repos/octocat/hello-world/contents/.github%2Fmy-app.yml",
-    },
-    {
-      "config": {
-        "setting1": "value from base config file",
-        "setting2": "value from base config file",
-      },
-      "owner": "octocat",
-      "path": ".github/my-app.yml",
-      "repo": "base",
-      "url": "https://github.com/gitapi/repos/octocat/base/contents/.github%2Fmy-app.yml",
-    },
-  ],
-}
-`;
-
-exports[`octokit.config.get _extends: base:test.yml: result 1`] = `
+exports[`octokit.config.get > _extends: base:test.yml > result 1`] = `
 {
   "config": {
     "setting1": "value from repo config file",
@@ -209,7 +209,7 @@ exports[`octokit.config.get _extends: base:test.yml: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get _extends: other-owner/base: result 1`] = `
+exports[`octokit.config.get > _extends: other-owner/base > result 1`] = `
 {
   "config": {
     "setting1": "value from repo config file",
@@ -239,7 +239,7 @@ exports[`octokit.config.get _extends: other-owner/base: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get _extends: other-owner/base:test.yml: result 1`] = `
+exports[`octokit.config.get > _extends: other-owner/base:test.yml > result 1`] = `
 {
   "config": {
     "setting1": "value from repo config file",
@@ -269,7 +269,7 @@ exports[`octokit.config.get _extends: other-owner/base:test.yml: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get README simple usage example: result 1`] = `
+exports[`octokit.config.get > README simple usage example > result 1`] = `
 {
   "config": {
     "comment": "Thank you for creating the issue!",
@@ -288,7 +288,7 @@ exports[`octokit.config.get README simple usage example: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get branch option: result 1`] = `
+exports[`octokit.config.get > branch option > result 1`] = `
 {
   "config": {
     "comment": "Thank you for creating the issue!",
@@ -307,7 +307,7 @@ exports[`octokit.config.get branch option: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get config file is empty: result 1`] = `
+exports[`octokit.config.get > config file is empty > result 1`] = `
 {
   "config": {},
   "files": [
@@ -322,7 +322,7 @@ exports[`octokit.config.get config file is empty: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get config file missing: result 1`] = `
+exports[`octokit.config.get > config file missing > result 1`] = `
 {
   "config": {
     "comment": "Thank you for creating the issue!",
@@ -346,7 +346,7 @@ exports[`octokit.config.get config file missing: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get merges deeply using defaults function: result 1`] = `
+exports[`octokit.config.get > merges deeply using defaults function > result 1`] = `
 {
   "config": {
     "otherSetting1": "value from config file",
@@ -373,54 +373,54 @@ exports[`octokit.config.get merges deeply using defaults function: result 1`] =
 }
 `;
 
-exports[`octokit.config.get merges defaults option from .github repository: result 1`] = `
+exports[`octokit.config.get > merges defaults option > result 1`] = `
 {
   "config": {
-    "config": "value from octocat/.github:.github/my-app.yml",
+    "config": "value from .github/my-app.yml",
     "otherConfig": "default value",
   },
   "files": [
-    {
-      "config": null,
-      "owner": "octocat",
-      "path": ".github/my-app.yml",
-      "repo": "hello-world",
-      "url": "https://github.com/gitapi/repos/octocat/hello-world/contents/.github%2Fmy-app.yml",
-    },
     {
       "config": {
-        "config": "value from octocat/.github:.github/my-app.yml",
+        "config": "value from .github/my-app.yml",
       },
       "owner": "octocat",
       "path": ".github/my-app.yml",
-      "repo": ".github",
-      "url": "https://github.com/gitapi/repos/octocat/.github/contents/.github%2Fmy-app.yml",
+      "repo": "hello-world",
+      "url": "https://github.com/gitapi/repos/octocat/hello-world/contents/.github%2Fmy-app.yml",
     },
   ],
 }
 `;
 
-exports[`octokit.config.get merges defaults option: result 1`] = `
+exports[`octokit.config.get > merges defaults option from .github repository > result 1`] = `
 {
   "config": {
-    "config": "value from .github/my-app.yml",
+    "config": "value from octocat/.github:.github/my-app.yml",
     "otherConfig": "default value",
   },
   "files": [
     {
-      "config": {
-        "config": "value from .github/my-app.yml",
-      },
+      "config": null,
       "owner": "octocat",
       "path": ".github/my-app.yml",
       "repo": "hello-world",
       "url": "https://github.com/gitapi/repos/octocat/hello-world/contents/.github%2Fmy-app.yml",
     },
+    {
+      "config": {
+        "config": "value from octocat/.github:.github/my-app.yml",
+      },
+      "owner": "octocat",
+      "path": ".github/my-app.yml",
+      "repo": ".github",
+      "url": "https://github.com/gitapi/repos/octocat/.github/contents/.github%2Fmy-app.yml",
+    },
   ],
 }
 `;
 
-exports[`octokit.config.get repo is .github: result 1`] = `
+exports[`octokit.config.get > repo is .github > result 1`] = `
 {
   "config": {},
   "files": [
@@ -435,7 +435,7 @@ exports[`octokit.config.get repo is .github: result 1`] = `
 }
 `;
 
-exports[`octokit.config.get resolves _extends in .github repository file: result 1`] = `
+exports[`octokit.config.get > resolves _extends in .github repository file > result 1`] = `
 {
   "config": {
     "config": "value from octocat/.github:.github/my-second-app.yml",
@@ -478,7 +478,7 @@ exports[`octokit.config.get resolves _extends in .github repository file: result
 }
 `;
 
-exports[`octokit.config.get returns defaults option when no config files exist: result 1`] = `
+exports[`octokit.config.get > returns defaults option when no config files exist > result 1`] = `
 {
   "config": {
     "comment": "Thank you for creating the issue!",

diff --git a/test/get.test.ts b/test/get.test.ts
@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import { Octokit } from "@octokit/core";
 import fetchMock from "fetch-mock";
 import stripIndent from "strip-indent";

diff --git a/test/issues.test.ts b/test/issues.test.ts
@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import { Octokit } from "@octokit/core";
 import fetchMock from "fetch-mock";
 

diff --git a/test/smoke.test.ts b/test/smoke.test.ts
@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import { config, composeConfigGet } from "../src/index.js";
 
 describe("Smoke test", () => {

diff --git a/vite.config.js b/vite.config.js
@@ -0,0 +1,13 @@
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  test: {
+    coverage: {
+      include: ["src/**/*.ts"],
+      reporter: ["html"],
+      thresholds: {
+        100: true,
+      },
+    },
+  },
+});