test(vitest): use vitest instead of jest (#1124)

Author: philibea

.eslintignore

@@ -1,3 +1,4 @@
 node_modules/
 dist/
 examples/
+vite.config.ts

.eslintrc

@@ -1,10 +1,8 @@
 {
   "root": true,
-  "plugins": [
-    "eslint-plugin-tsdoc"
-  ],
+  "plugins": ["eslint-plugin-tsdoc"],
   "parserOptions": {
-    "project": ["tsconfig.json"]
+    "project": ["tsconfig.json"],
   },
   "extends": ["@scaleway/react/typescript"],
   "rules": {
@@ -13,23 +11,29 @@
       "error",
       {
         "selector": "enumMember",
-        "format": ["PascalCase"]
+        "format": ["PascalCase"],
       }
     ],
     "import/prefer-default-export": "off",
     "import/no-default-export": "error",
     "no-await-in-loop": "off",
-    "@typescript-eslint/no-namespace": "off"
+    "@typescript-eslint/no-namespace": "off",
   },
   "overrides": [
     {
       "files": [
         "./packages/clients/src/scw/**/*.ts",
-        "./packages/clients/src/internal/**/*.ts"
+        "./packages/clients/src/internal/**/*.ts",
       ],
       "rules": {
-        "@typescript-eslint/consistent-type-definitions": "off"
+        "@typescript-eslint/consistent-type-definitions": "off",
       }
-    }
-  ]
+    },
+    {
+      "files": ["**/*.test.ts", "__tests__/**/*.ts", "vite.config.ts"],
+      "rules": {
+        "eslint-disable import/no-extraneous-dependencies": "off"
+      },
+    },
+  ],
 }

.github/workflows/check-pull-request.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Use Node.js
         uses: actions/[email protected]
         with:
-          node-version: 18
+          node-version: 20
           check-latest: true
           cache: "pnpm"
       - run: pnpm install

.github/workflows/deploy-package.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Use Node.js
         uses: actions/[email protected]
         with:
-          node-version: 18
+          node-version: 20
           check-latest: true
       - run: pnpm install
       - run: pnpm run build

.github/workflows/run-tests.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Use Node.js
         uses: actions/[email protected]
         with:
-          node-version: 18
+          node-version: 20
           check-latest: true
           cache: "pnpm"
       - run: pnpm install
@@ -30,7 +30,7 @@ jobs:
       - name: Use Node.js
         uses: actions/[email protected]
         with:
-          node-version: 18
+          node-version: 20
           check-latest: true
           cache: "pnpm"
       - run: pnpm install
@@ -45,7 +45,7 @@ jobs:
           - jsdom
         node:
           - "18"
-          - "19"
+          - "20"
     steps:
       - uses: actions/[email protected]
       - uses: pnpm/[email protected]
@@ -57,5 +57,5 @@ jobs:
           cache: "pnpm"
       - run: pnpm install
       - run: pnpm run build
-      - run: pnpm run test:coverage --testEnvironment ${{ matrix.test-environment }}
+      - run: pnpm run test:coverage --environment ${{ matrix.test-environment }}
       - uses: codecov/[email protected]

env-setup.ts

@@ -10,20 +10,27 @@
   },
   "type": "module",
   "scripts": {
-    "build": "lerna exec --stream -- rollup -c ../../rollup.config.mjs",
+    "build": "pnpm recursive exec -- rollup -c ../../rollup.config.mjs",
     "build:profile": "cross-env PROFILE=true pnpm run build",
     "commit": "npx git-cz -a",
     "doc": "typedoc",
     "format": "prettier --write '**/*.ts'",
     "lint": "eslint --cache --ext ts .",
     "prepare": "husky install",
-    "test:coverage": "pnpm run test --coverage",
-    "test": "jest"
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui"
   },
   "lint-staged": {
     "*.ts": [
       "prettier --write",
       "eslint --fix --ext ts"
+    ],
+    "*.yaml": [
+      "prettier --write"
+    ],
+    "*.json": [
+      "prettier --write"
     ]
   },
   "config": {
@@ -36,58 +43,27 @@
       "@commitlint/config-conventional"
     ]
   },
-  "jest": {
-    "setupFiles": [
-      "./env-setup.ts"
-    ],
-    "collectCoverageFrom": [
-      "packages/*/src/**/*.{ts,tsx}"
-    ],
-    "coverageReporters": [
-      "text",
-      "cobertura"
-    ],
-    "modulePathIgnorePatterns": [
-      "<rootDir>/examples/",
-      "<rootDir>/dist/",
-      "<rootDir>/packages/clients/src/api/"
-    ],
-    "reporters": [
-      "default",
-      [
-        "jest-junit",
-        {
-          "outputDirectory": ".reports",
-          "outputName": "tests.xml"
-        }
-      ]
-    ],
-    "transformIgnorePatterns": [
-      "node_modules/(?!(.*(@scaleway)))"
-    ]
-  },
   "devDependencies": {
     "@babel/core": "^7.23.9",
     "@babel/plugin-transform-runtime": "^7.23.9",
     "@babel/preset-env": "^7.23.9",
     "@babel/preset-typescript": "^7.23.3",
     "@commitlint/cli": "^18.6.0",
     "@commitlint/config-conventional": "^18.6.0",
-    "@jest/globals": "^29.7.0",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@scaleway/eslint-config-react": "^3.17.2",
+    "@vitest/coverage-istanbul": "1.2.1",
+    "@vitest/coverage-v8": "1.2.1",
+    "@vitest/ui": "1.2.1",
     "babel-plugin-annotate-pure-calls": "^0.4.0",
     "cross-env": "^7.0.3",
     "cross-fetch": "^4.0.0",
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.56.0",
     "eslint-plugin-tsdoc": "^0.2.17",
     "husky": "^8.0.3",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
-    "jest-junit": "^16.0.0",
     "lerna": "^7.4.2",
     "lint-staged": "^15.2.0",
     "prettier": "^3.2.4",
@@ -96,7 +72,12 @@
     "rollup-plugin-dts": "^6.1.0",
     "rollup-plugin-visualizer": "^5.12.0",
     "typedoc": "^0.25.7",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "vite": "5.0.12",
+    "vitest": "1.2.1"
   },
-  "packageManager": "[email protected]"
+  "packageManager": "[email protected]",
+  "dependencies": {
+    "jsdom": "^24.0.0"
+  }
 }

package.json

@@ -1,5 +1,5 @@
-/* @jest-environment jsdom */
-import { describe, expect, it } from '@jest/globals'
+// @vitest-environment jsdom
+import { describe, expect, it } from 'vitest'
 import { isBrowser } from '../is-browser'
 
 describe('isBrowser', () => {

packages/clients/src/helpers/__tests__/is-browser.browser.ts renamed to packages/clients/src/helpers/__tests__/is-browser.browser.test.ts

@@ -1,5 +1,6 @@
-/* @jest-environment node */
-import { describe, expect, it } from '@jest/globals'
+// @vitest-environment node
+
+import { describe, expect, it } from 'vitest'
 import { isBrowser } from '../is-browser'
 
 describe('isBrowser', () => {

packages/clients/src/helpers/__tests__/is-browser.node.ts renamed to packages/clients/src/helpers/__tests__/is-browser.node.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from '@jest/globals'
+import { describe, expect, test } from 'vitest'
 import { isJSON, isJSONObject } from '../json'
 
 describe('isJSON', () => {