chore(tests): migrate to vitest (#1753)

* test: migrate to vitest * test: try #1 remove CI-MATRIX tags * test: try 2 remove import/require replace * chore: remove unused scripts/assignments * chore(test-multiple-builds.yml): remove import/require replace script * fix merging main --------- Co-authored-by: daishi <[email protected]>
pmndrs · May 4, 2023 · 496a466 · 496a466
1 parent 630ba1a
commit 496a466
Show file tree

Hide file tree

Showing 16 changed files with 875 additions and 1,513 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -20,7 +20,7 @@
     "prettier",
     "react-hooks",
     "import",
-    "jest"
+    "vitest"
   ],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
@@ -48,10 +48,12 @@
     "@typescript-eslint/no-use-before-define": "off",
     "@typescript-eslint/no-empty-function": "off",
     "@typescript-eslint/no-explicit-any": "off",
-    "jest/consistent-test-it": [
+    "vitest/consistent-test-it": [
       "error",
       { "fn": "it", "withinDescribe": "it" }
     ],
+    "import/namespace": "off",
+    "import/named": "off",
     "import/order": [
       "error",
       {

diff --git a/.github/workflows/test-multiple-builds.yml b/.github/workflows/test-multiple-builds.yml
@@ -68,17 +68,13 @@ jobs:
         if: ${{ matrix.build == 'umd' && matrix.env == 'development' }}
         run: |
           sed -i~ "s/<rootDir>\/src\(.*\)\.ts/<rootDir>\/dist\/umd\1.development.js/" package.json
-          sed -i~ 's/"test:ci":.*,$/"test:ci": "jest",/' package.json
-          sed -i~ 's/= await import(/= require(/' tests/devtools.test.tsx
           sed -i~ "s/it('\[${DEVTOOLS_SKIP}\]/it.skip('/" tests/devtools.test.tsx
         env:
           DEVTOOLS_SKIP: ${{ matrix.devtools-skip }}
       - name: Patch for UMD (PRD)
         if: ${{ matrix.build == 'umd' && matrix.env == 'production' }}
         run: |
           sed -i~ "s/<rootDir>\/src\(.*\)\.ts/<rootDir>\/dist\/umd\1.production.js/" package.json
-          sed -i~ 's/"test:ci":.*,$/"test:ci": "jest",/' package.json
-          sed -i~ 's/= await import(/= require(/' tests/devtools.test.tsx
           sed -i~ "s/it('\[${DEVTOOLS_SKIP}\]/it.skip('/" tests/devtools.test.tsx
         env:
           DEVTOOLS_SKIP: ${{ matrix.devtools-skip }}

diff --git a/.github/workflows/test-multiple-versions.yml b/.github/workflows/test-multiple-versions.yml
@@ -68,8 +68,6 @@ jobs:
           sed -i~ '1s/^/import React from "react";/' tests/*.tsx
           sed -i~ 's/"jsx": "react-jsx"/"jsx": "react"/' tsconfig.json
           sed -i~ 's/import\.meta\.env[?]\.MODE/"DEVELOPMENT".toLowerCase()/' src/*.ts src/*/*.ts
-          sed -i~ 's/"test:ci":.*,$/"test:ci": "jest",/' package.json
-          sed -i~ 's/= await import(/= require(/' tests/devtools.test.tsx
           sed -i~ "s/it('\[${DEVTOOLS_SKIP}\]/it.skip('/" tests/devtools.test.tsx
         env:
           DEVTOOLS_SKIP: ${{ matrix.devtools-skip }}

diff --git a/.github/workflows/test-old-typescript.yml b/.github/workflows/test-old-typescript.yml
@@ -46,5 +46,4 @@ jobs:
       - name: Test ${{ matrix.typescript }}
         run: |
           yarn add -D typescript@${{ matrix.typescript }}
-          rm -r node_modules/parse5
           yarn tsc --noEmit
diff --git a/package.json b/package.json
@@ -91,12 +91,10 @@
     "eslint": "eslint --no-eslintrc --c .eslintrc.json --fix '*.{js,json}' '{src,tests}/**/*.{ts,tsx}'",
     "eslint:ci": "eslint  --no-eslintrc --c .eslintrc.json '*.{js,json}' '{src,tests}/**/*.{ts,tsx}'",
     "pretest": "tsc --noEmit",
-    "test": "yarn node --experimental-vm-modules $(yarn bin jest)",
-    "test:ci": "yarn node --experimental-vm-modules $(yarn bin jest)",
-    "test:dev": "yarn node --experimental-vm-modules $(yarn bin jest) --watch --no-coverage",
-    "test:coverage:watch": "yarn node --experimental-vm-modules $(yarn bin jest) --watch",
+    "test": "vitest --ui --coverage",
+    "test:ci": "vitest",
     "patch-d-ts": "node -e \"var {entries}=require('./rollup.config.js');require('shelljs').find('dist/**/*.d.ts').forEach(f=>{entries.forEach(({find,replacement})=>require('shelljs').sed('-i',new RegExp(' from \\''+find.source.slice(0,-1)+'\\';$'),' from \\''+replacement+'\\';',f));require('shelljs').sed('-i',/ from '(\\.[^']+)\\.ts';$/,' from \\'\\$1\\';',f)})\"",
-    "copy": "shx cp -r dist/src/* dist/esm && shx cp -r dist/src/* dist && shx rm -rf dist/src && shx rm -rf dist/{src,tests} && downlevel-dts dist dist/ts3.4 && shx cp package.json readme.md LICENSE dist && json -I -f dist/package.json -e \"this.private=false; this.devDependencies=undefined; this.optionalDependencies=undefined; this.scripts=undefined; this.prettier=undefined; this.jest=undefined;\"",
+    "copy": "shx cp -r dist/src/* dist/esm && shx cp -r dist/src/* dist && shx rm -rf dist/src && shx rm -rf dist/{src,tests} && downlevel-dts dist dist/ts3.4 && shx cp package.json readme.md LICENSE dist && json -I -f dist/package.json -e \"this.private=false; this.devDependencies=undefined; this.optionalDependencies=undefined; this.scripts=undefined; this.prettier=undefined;\"",
     "patch-esm-ts": "node -e \"require('shelljs').find('dist/esm/**/*.d.ts').forEach(f=>{var f2=f.replace(/\\.ts$/,'.mts');require('fs').copyFileSync(f,f2);require('shelljs').sed('-i',/ from '(\\.[^']+)';$/,' from \\'\\$1.mjs\\';',f2);require('shelljs').sed('-i',/^declare module '(\\.[^']+)'/,'declare module \\'\\$1.mjs\\'',f2)})\""
   },
   "engines": {
@@ -132,44 +130,9 @@
     "url": "https://github.com/pmndrs/zustand/issues"
   },
   "homepage": "https://github.com/pmndrs/zustand",
-  "jest": {
-    "rootDir": ".",
-    "testEnvironment": "jsdom",
-    "preset": "ts-jest/presets/default-esm",
-    "transform": {
-      "^.+\\.(t|j)sx?$": [
-        "ts-jest",
-        {
-          "useESM": true
-        }
-      ]
-    },
-    "extensionsToTreatAsEsm": [
-      ".ts",
-      ".tsx"
-    ],
-    "moduleNameMapper": {
-      "^zustand$": "<rootDir>/src/index.ts",
-      "^zustand/(.*)$": "<rootDir>/src/$1.ts"
-    },
-    "modulePathIgnorePatterns": [
-      "dist"
-    ],
-    "testRegex": "test.(js|ts|tsx)$",
-    "coverageDirectory": "./coverage/",
-    "collectCoverage": true,
-    "coverageReporters": [
-      "json",
-      "html",
-      "text",
-      "text-summary"
-    ],
-    "collectCoverageFrom": [
-      "src/**/*.{js,ts,tsx}",
-      "tests/**/*.{js,ts,tsx}"
-    ]
-  },
   "dependencies": {
+    "@vitest/ui": "^0.30.1",
+    "eslint-plugin-vitest": "^0.1.4",
     "use-sync-external-store": "1.2.0"
   },
   "devDependencies": {
@@ -192,20 +155,19 @@
     "@types/use-sync-external-store": "^0.0.3",
     "@typescript-eslint/eslint-plugin": "^5.57.0",
     "@typescript-eslint/parser": "^5.57.0",
+    "@vitest/coverage-c8": "^0.30.1",
     "concurrently": "^8.0.1",
     "downlevel-dts": "^0.11.0",
     "esbuild": "^0.17.14",
     "eslint": "^8.37.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-import-resolver-alias": "^1.1.2",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.1",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "immer": "^9.0.21",
-    "jest": "^29.5.0",
-    "jest-environment-jsdom": "^29.5.0",
+    "jsdom": "^21.1.1",
     "json": "^11.0.0",
     "prettier": "^2.8.7",
     "react": "^18.2.0",
@@ -214,8 +176,8 @@
     "rollup": "^3.20.2",
     "rollup-plugin-esbuild": "^5.0.0",
     "shx": "^0.3.4",
-    "ts-jest": "^29.0.5",
-    "typescript": "^5.0.3"
+    "typescript": "^5.0.3",
+    "vitest": "^0.30.1"
   },
   "peerDependencies": {
     "immer": ">=9.0",

diff --git a/tests/basic.test.tsx b/tests/basic.test.tsx
@@ -6,9 +6,9 @@ import {
   useLayoutEffect,
   useState,
 } from 'react'
-import { afterEach, expect, it, jest } from '@jest/globals'
 import { act, fireEvent, render } from '@testing-library/react'
 import ReactDOM from 'react-dom'
+import { afterEach, expect, it, vi } from 'vitest'
 import { create } from 'zustand'
 import type { StoreApi } from 'zustand'
 
@@ -306,7 +306,7 @@ it('can call useBoundStore with progressively more arguments', async () => {
 })
 
 it('can throw an error in selector', async () => {
-  console.error = jest.fn()
+  console.error = vi.fn()
   type State = { value: string | number }
 
   const initialState: State = { value: 'foo' }
@@ -353,7 +353,7 @@ it('can throw an error in selector', async () => {
 })
 
 it('can throw an error in equality checker', async () => {
-  console.error = jest.fn()
+  console.error = vi.fn()
   type State = { value: string | number }
 
   const initialState: State = { value: 'foo' }
@@ -442,7 +442,7 @@ it('can set the store', () => {
 it('both NaN should not update', () => {
   const { setState, subscribe } = create<number>(() => NaN)
 
-  const fn = jest.fn()
+  const fn = vi.fn()
   subscribe(fn)
 
   setState(NaN)

diff --git a/tests/context.test.tsx b/tests/context.test.tsx
@@ -6,8 +6,8 @@ import {
   useEffect,
   useState,
 } from 'react'
-import { afterEach, it, jest } from '@jest/globals'
 import { render } from '@testing-library/react'
+import { afterEach, it, vi } from 'vitest'
 import { create } from 'zustand'
 import type { StoreApi } from 'zustand'
 import createContext from 'zustand/context'
@@ -123,7 +123,7 @@ it('uses context store api', async () => {
 })
 
 it('throws error when not using provider', async () => {
-  console.error = jest.fn()
+  console.error = vi.fn()
 
   class ErrorBoundary extends ClassComponent<
     { children?: ReactNode | undefined },