use vitest instread of jest

Author: neSpecc

Diff for: .github/workflows/main.yml

@@ -3,7 +3,7 @@ name: CI
 on: push
 
 jobs:
-  lint-test-build:
+  lint-test:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout repository
@@ -40,8 +40,8 @@ jobs:
       - name: Run unit tests
         run: yarn test
 
-      - name: Build library
-        run: yarn build
+      # - name: Build library
+      #   run: yarn build
 
       # - name: Publish library
       #   if: ${{ github.ref == 'refs/heads/main' }}

Diff for: .npmignore

@@ -5,3 +5,6 @@ tests/
 .github
 yarn.lock
 eslint.config.mjs
+vitest.config.ts
+vitest.workspace.ts
+*.test.ts

Diff for: README.md

@@ -11,7 +11,7 @@ A quick start template for a new TypeScript library
 - 💎 ESLint 9 with [eslint-config-codex](http://github.com/codex-team/eslint-config/)
 - 🥃 Typescript 5
 - 🥊 npx only-allow yarn
-- 🌶️ Tests with [Jest](http://jestjs.io)
+- 🌶️ Tests with [Vitest](https://vitest.dev)
 - 🍀 GitHub Actions for test/lint/build/publish purposes
 
 ## How to use

Diff for: eslint.config.mjs

@@ -2,12 +2,14 @@ import CodeX from 'eslint-config-codex';
 import { plugin as TsPlugin, parser as TsParser } from 'typescript-eslint';
 import path from 'path';
 import { fileURLToPath } from 'url';
+import EslintTestsConfig from './eslint.config.test.mjs';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
 export default [
   ...CodeX,
+  ...EslintTestsConfig,
   {
     name: 'codex-lib-ts',
     ignores: [

Diff for: eslint.config.test.mjs

@@ -0,0 +1,11 @@
+export default [
+  {
+    name: 'codex-lib-tests',
+    files: [
+      'packages/**/*.test.ts',
+    ],
+    rules: {
+      'n/no-missing-import': 'off',
+    },
+  },
+];

Diff for: jest.config.ts

@@ -15,18 +15,18 @@
     "clean": "rimraf -g \"packages/**/dist\" \"packages/**/*.tsbuildinfo\"",
     "lint": "yarn workspaces foreach -A run lint",
     "lint:fix": "yarn workspaces foreach -A run lint --fix",
+    "test": "vitest --watch=false",
+    "coverage": "vitest --watch=false --coverage",
     "preinstall": "npx only-allow yarn"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.14",
     "eslint": "^9.14.0",
     "eslint-config-codex": "2.0.3-rc.3",
-    "jest": "^29.7.0",
     "rimraf": "^6.0.1",
-    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.3",
-    "typescript-eslint": "^8.13.0"
+    "typescript-eslint": "^8.13.0",
+    "vitest": "^2.1.4"
   },
   "packageManager": "[email protected]"
 }

Diff for: package.json

@@ -19,14 +19,18 @@
     "lint": "eslint ./src",
     "lint:fix": "yarn lint --fix",
     "build": "tsc -p tsconfig.build.json",
-    "test": "jest"
+    "test:dev": "vitest",
+    "test": "vitest run",
+    "coverage": "vitest run --coverage"
   },
   "dependencies": {
     "mylib-utils": "workspace:^"
   },
   "devDependencies": {
+    "@vitest/coverage-v8": "^2.1.4",
     "eslint": "^9.14.0",
     "rimraf": "^6.0.1",
-    "typescript": "^5.6.3"
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.4"
   }
 }

Diff for: packages/core/package.json

@@ -4,5 +4,5 @@ import { myUtil } from 'mylib-utils';
  * Simple function that returns string
  */
 export default function main(): string {
-  return 'It works!' + myUtil(1, 2);
+  return 'It works! ' + myUtil(1, 2);
 }

Diff for: packages/core/src/index.ts

@@ -1,7 +1,12 @@
-import main from '../src';
+import main from '../src/index';
+import { describe, test, expect } from 'vitest';
 
-describe('TypeScript library template', () => {
-  test('Should return correct result', () => {
-    expect(main()).toBe('It works!');
+describe('My Package test', () => {
+  describe('main()', () => {
+    test('shoul return a contatinated string', () => {
+      const result = main();
+
+      expect(result).toBe('It works! 3');
+    });
   });
 });

Diff for: packages/core/tests/index.test.ts

@@ -4,13 +4,20 @@
   "main": "src/index.ts",
   "type": "module",
   "author": "CodeX <[email protected]>",
+  "files": [
+    "src"
+  ],
   "scripts": {
     "lint": "eslint ./src",
     "lint:fix": "yarn lint --fix",
-    "test": "jest"
+    "test:dev": "vitest",
+    "test": "vitest run",
+    "coverage": "vitest run --coverage"
   },
   "devDependencies": {
+    "@vitest/coverage-v8": "^2.1.4",
     "eslint": "^9.14.0",
-    "typescript": "^5.6.3"
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.4"
   }
 }

Diff for: packages/utils/package.json

@@ -1,7 +1,16 @@
-import main from '../../core/src';
+import { myUtil } from 'mylib-utils';
+import { describe, test, expect } from 'vitest';
 
-describe('TypeScript library template', () => {
-  test('Should return correct result', () => {
-    expect(main()).toBe('It works!');
+describe('My Utils package test', () => {
+  describe('myUtil()', () => {
+    test('shoul return a summ of two passed numbers', () => {
+      const number1 = 5;
+      const number2 = 10;
+
+      const summ = myUtil(number1, number2);
+
+      // eslint-disable-next-line @typescript-eslint/no-magic-numbers
+      expect(summ).toBe(15);
+    });
   });
 });

Diff for: packages/utils/tests/index.test.d.ts

@@ -0,0 +1,16 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    coverage: {
+      reporter: ['text'],
+      reportOnFailure: true,
+      thresholds: {
+        lines: 80,
+        branches: 80,
+        functions: 80,
+        statements: 80,
+      },
+    },
+  },
+});