switch testing library to vitest

Author: tobidelius

.gitignore

@@ -5,7 +5,7 @@
 # TS
 /dist
 
-# Jest
+# Code Coverage
 /coverage
 
 # OS generated files

README.md

@@ -13,9 +13,3 @@ Simple skeleton for TypeScript Node programs.
 2. After this is done you you can remove the `setup` file.
 3. Make sure you edit `package.json` with a new name and meta information.
 4. Open `.github/workflows/tests.yml` and change `run: ./setup` to: `run: npm install`.
-
-## NPM Dependencies
-
-* [typescript](https://www.typescriptlang.org/) + types/tools
-* [jest](https://jestjs.io/) (testing)
-* [eslint](https://github.com/eslint/eslint) (linter) + typescript-eslint/airbnb

package.json

@@ -5,9 +5,9 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "test": "npx jest test",
-    "test:cov": "npx jest test --coverage",
-    "lint": "npx ts-standard .",
+    "test": "vitest --run",
+    "test:watch": "vitest --watch",
+    "test:coverage": "vitest --coverage",
     "build": "npx tsc"
   },
   "author": "Tobias Sandelius @tobidelius",
@@ -19,5 +19,12 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/tobidelius/typescript-node-skeleton.git"
+  },
+  "devDependencies": {
+    "@types/node": "^22.14.0",
+    "@vitest/coverage-v8": "^3.1.1",
+    "ts-standard": "^12.0.2",
+    "typescript": "^5.8.2",
+    "vitest": "^3.1.1"
   }
 }

setup

@@ -1,5 +1,5 @@
 npm i -D typescript \
-  jest \
-  ts-jest \
-  @types/jest \
+  @types/node \
+  @vitest/coverage-v8 \
+  vitest \
   ts-standard

test/setup.ts

@@ -1,23 +1,15 @@
-// Setup for the entire suit.
-global.beforeAll((done) => {
-  // console.log('BEFORE ALL')
-  done()
+beforeAll(async () => {
+  // is run before all tests
 })
 
-// Teardown for the entire suit.
-global.afterAll((done) => {
-  // console.log('AFTER ALL')
-  done()
+afterAll(async () => {
+  // is run after all tests
 })
 
-// Setup before each spec
-global.beforeEach((done) => {
-  // console.log('BEFORE EACH')
-  done()
+beforeEach(async () => {
+  // is run before each test
 })
 
-// Teardown after each spec.
-global.afterEach((done) => {
-  // console.log('AFTER EACH')
-  done()
+afterEach(async () => {
+  // is run after each test
 })

tsconfig.json

@@ -1,16 +1,33 @@
 {
   "compilerOptions": {
-    "target": "ESNext",
-    "module": "commonjs",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "sourceMap": true,
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "baseUrl": "."
+    "target": "ES2020", // Set to a modern ECMAScript version (or "ESNext" for the latest)
+    "module": "CommonJS", // Set module system to CommonJS (for Node.js)
+    "moduleResolution": "node", // Helps TypeScript find modules in Node.js
+    "lib": [
+      "ES2020"
+    ], // Include necessary libraries for Node.js runtime
+    "esModuleInterop": true, // Allow default imports from modules that don't have a default export
+    "skipLibCheck": true, // Skip type checking of declaration files (speeds up build)
+    "strict": true, // Enable strict type checking
+    "forceConsistentCasingInFileNames": true, // Enforce consistent file naming
+    "outDir": "./dist", // Directory where compiled JavaScript will go
+    "declaration": true, // Generate TypeScript declaration files (.d.ts)
+    "declarationMap": true, // Generate map files for declarations
+    "sourceMap": true, // Enable source maps for debugging
+    "allowJs": false, // Do not allow JavaScript files in the project
+    "resolveJsonModule": true, // Allow importing JSON modules (if needed)
+    "noEmitOnError": true, // Don't emit any files if there are errors
+    "types": [
+      "node",
+      "vitest/globals"
+    ]
   },
-  "include": ["src/**/*.ts"],
-  "exclude": ["node_modules", "dist"]
+  "include": [
+    "src/**/*.ts",
+    "test/**/*.ts" // Include all TypeScript files from the "src" folder
+  ],
+  "exclude": [
+    "node_modules", // Exclude node_modules folder
+    "dist" // Exclude dist folder (output directory)
+  ]
 }

vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    setupFiles: './test/setup.ts',
+    globals: true
+  }
+})