Migrate to Vitest

Author: Mrtenz

eslint.config.mjs

@@ -1,5 +1,5 @@
 import base, { createConfig } from '@metamask/eslint-config';
-import jest from '@metamask/eslint-config-jest';
+import vitest from '@metamask/eslint-config-vitest';
 import nodejs from '@metamask/eslint-config-nodejs';
 import typescript from '@metamask/eslint-config-typescript';
 
@@ -92,11 +92,7 @@ const config = createConfig([
 
   {
     files: ['**/*.test.ts', '**/*.test.js'],
-    extends: [jest, nodejs],
-
-    rules: {
-      'jest/no-conditional-in-test': 'off',
-    },
+    extends: [vitest, nodejs],
   },
 ]);
 

jest.config.js

@@ -43,8 +43,8 @@
     "lint:fix": "yarn lint:eslint --fix && yarn lint:constraints --fix && yarn lint:misc --write && yarn lint:dependencies && yarn lint:changelog",
     "lint:misc": "prettier '**/*.json' '**/*.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "prepack": "./scripts/prepack.sh",
-    "test": "jest && jest-it-up && attw --pack",
-    "test:watch": "jest --watch"
+    "test": "vitest && attw --pack",
+    "test:watch": "vitest --watch"
   },
   "dependencies": {
     "@metamask/scure-bip39": "^2.1.1",
@@ -59,12 +59,13 @@
     "@lavamoat/preinstall-always-fail": "^2.0.0",
     "@metamask/auto-changelog": "^4.0.0",
     "@metamask/eslint-config": "^14.0.0",
-    "@metamask/eslint-config-jest": "^14.0.0",
     "@metamask/eslint-config-nodejs": "^14.0.0",
     "@metamask/eslint-config-typescript": "^14.0.0",
+    "@metamask/eslint-config-vitest": "^1.0.0",
     "@ts-bridge/cli": "^0.6.0",
-    "@types/jest": "^28.1.6",
     "@types/node": "^18.18",
+    "@vitest/coverage-istanbul": "3.0.8",
+    "@vitest/eslint-plugin": "^1.1.4",
     "@yarnpkg/types": "^4.0.0-rc.52",
     "depcheck": "^1.4.3",
     "eslint": "^9.11.0",
@@ -77,15 +78,15 @@
     "eslint-plugin-n": "^17.10.3",
     "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-promise": "^7.1.0",
-    "jest": "^28.1.3",
-    "jest-it-up": "^2.0.2",
     "prettier": "^3.3.3",
     "prettier-plugin-packagejson": "^2.3.0",
     "ts-jest": "^28.0.7",
     "ts-node": "^10.9.1",
     "typedoc": "^0.26.11",
     "typescript": "~5.4.5",
-    "typescript-eslint": "^8.6.0"
+    "typescript-eslint": "^8.6.0",
+    "vite": "^6.2.0",
+    "vitest": "^3.0.7"
   },
   "packageManager": "yarn@4.1.1",
   "engines": {
@@ -97,7 +98,8 @@
   },
   "lavamoat": {
     "allowScripts": {
-      "@lavamoat/preinstall-always-fail": false
+      "@lavamoat/preinstall-always-fail": false,
+      "vite>esbuild": true
     }
   }
 }

package.json

@@ -1,4 +1,5 @@
 import { bytesToHex } from '@metamask/utils';
+import { describe, expect, it, vi } from 'vitest';
 
 import {
   BIP_44_COIN_TYPE_DEPTH,
@@ -25,8 +26,8 @@ const defaultBip39BytesToken = mnemonicPhraseToBytes(fixtures.local.mnemonic);
  * @returns The mock cryptographic functions.
  */
 function getMockFunctions(): CryptographicFunctions {
-  const mockHmacSha512 = jest.fn().mockImplementation(hmacSha512);
-  const mockPbkdf2Sha512 = jest.fn().mockImplementation(pbkdf2Sha512);
+  const mockHmacSha512 = vi.fn().mockImplementation(hmacSha512);
+  const mockPbkdf2Sha512 = vi.fn().mockImplementation(pbkdf2Sha512);
 
   return {
     hmacSha512: mockHmacSha512,

src/BIP44CoinTypeNode.test.ts

@@ -1,4 +1,5 @@
 import { bytesToHex } from '@metamask/utils';
+import { describe, expect, it, vi } from 'vitest';
 
 import { BIP44Node, BIP44PurposeNodeToken, secp256k1 } from '.';
 import type { CryptographicFunctions } from './cryptography';
@@ -20,8 +21,8 @@ const defaultBip39BytesToken = mnemonicPhraseToBytes(fixtures.local.mnemonic);
  * @returns The mock cryptographic functions.
  */
 function getMockFunctions(): CryptographicFunctions {
-  const mockHmacSha512 = jest.fn().mockImplementation(hmacSha512);
-  const mockPbkdf2Sha512 = jest.fn().mockImplementation(pbkdf2Sha512);
+  const mockHmacSha512 = vi.fn().mockImplementation(hmacSha512);
+  const mockPbkdf2Sha512 = vi.fn().mockImplementation(pbkdf2Sha512);
 
   return {
     hmacSha512: mockHmacSha512,

src/BIP44Node.test.ts

@@ -1,4 +1,5 @@
 import { bytesToHex, hexToBytes } from '@metamask/utils';
+import { describe, expect, it, vi } from 'vitest';
 
 import { BIP44PurposeNodeToken } from './constants';
 import type { CryptographicFunctions } from './cryptography';
@@ -22,8 +23,8 @@ const defaultBip39BytesToken = mnemonicPhraseToBytes(fixtures.local.mnemonic);
  * @returns The mock cryptographic functions.
  */
 function getMockFunctions(): CryptographicFunctions {
-  const mockHmacSha512 = jest.fn().mockImplementation(hmacSha512);
-  const mockPbkdf2Sha512 = jest.fn().mockImplementation(pbkdf2Sha512);
+  const mockHmacSha512 = vi.fn().mockImplementation(hmacSha512);
+  const mockPbkdf2Sha512 = vi.fn().mockImplementation(pbkdf2Sha512);
 
   return {
     hmacSha512: mockHmacSha512,

src/SLIP10Node.test.ts

@@ -1,6 +1,7 @@
 import { bytesToHex } from '@metamask/utils';
 // eslint-disable-next-line n/no-unsupported-features/node-builtins
 import { webcrypto } from 'crypto';
+import { describe, expect, it, vi } from 'vitest';
 
 import {
   hmacSha512,
@@ -21,7 +22,7 @@ describe('hmacSha512', () => {
     const data = new Uint8Array(32);
 
     const hash = new Uint8Array(64).fill(1);
-    const customHmacSha512 = jest.fn().mockResolvedValue(hash);
+    const customHmacSha512 = vi.fn().mockResolvedValue(hash);
 
     const result = await hmacSha512(key, data, {
       hmacSha512: customHmacSha512,
@@ -42,7 +43,7 @@ describe('hmacSha512', () => {
   });
 
   it('returns the HMAC-SHA-512 when using the fallback', async () => {
-    jest.spyOn(utils, 'isWebCryptoSupported').mockReturnValueOnce(false);
+    vi.spyOn(utils, 'isWebCryptoSupported').mockReturnValueOnce(false);
 
     const key = new Uint8Array(32);
     const data = new Uint8Array(32);
@@ -73,7 +74,7 @@ describe('pbkdf2Sha512', () => {
     const keyLength = 64;
 
     const hash = new Uint8Array(64).fill(1);
-    const customPbkdf2Sha512 = jest.fn().mockResolvedValue(hash);
+    const customPbkdf2Sha512 = vi.fn().mockResolvedValue(hash);
 
     const result = await pbkdf2Sha512(password, salt, iterations, keyLength, {
       pbkdf2Sha512: customPbkdf2Sha512,
@@ -101,7 +102,7 @@ describe('pbkdf2Sha512', () => {
   });
 
   it('returns the PBKDF2-SHA-512 when using the fallback', async () => {
-    jest.spyOn(utils, 'isWebCryptoSupported').mockReturnValueOnce(false);
+    vi.spyOn(utils, 'isWebCryptoSupported').mockReturnValueOnce(false);
 
     const password = new Uint8Array(32);
     const salt = new Uint8Array(32);

src/cryptography.test.ts

@@ -1,4 +1,5 @@
 import { hexToBytes, bytesToHex } from '@metamask/utils';
+import { describe, expect, it } from 'vitest';
 
 import {
   compressPublicKey,

src/curves/ed25519.test.ts

@@ -1,4 +1,5 @@
 import { bytesToHex, hexToBytes } from '@metamask/utils';
+import { describe, expect, it } from 'vitest';
 
 import { ed25519Bip32 } from '.';
 import {

src/curves/ed25519Bip32.test.ts

@@ -1,4 +1,5 @@
 import { bytesToHex, hexToBytes } from '@metamask/utils';
+import { describe, expect, it } from 'vitest';
 
 import { curve, getPublicKey, isValidPrivateKey, publicAdd } from './secp256k1';
 import fixtures from '../../test/fixtures';