chore: switch to Vitest for running all the tests (#125)

Signed-off-by: Dirk de Visser <[email protected]>

Author: dirkdev98

.github/workflows/ci.yml

@@ -40,7 +40,7 @@ jobs:
 
       - name: "Test"
         run: |
-          npm run test:ws
+          npm run test
 
   check-licenses:
     uses: lightbasenl/platforms/.github/workflows/lib-license-checker.yml@main

README.md

@@ -35,7 +35,8 @@ npm run build:ws
 npm run lint:ws
 
 # Run the 'test' script for all packages in the workspace
-npm run test:ws
+# Note that we use Vitest in workspace mode, which includes all tests of sub-packages.
+npm run test
 
 # Clean ESLint cache & dist directories in the workspace.
 npm run clean:ws

docs/decisions/000-template.md

@@ -0,0 +1,19 @@
+# Title
+
+## Context
+
+What is the issue that we're seeing that is motivating this decision or change?
+
+## Decision
+
+What is the change that we're proposing and/or doing?
+
+## Consequences
+
+What becomes easier or more challenging to do because of this change?
+
+---
+
+[//]:
+	#
+	"Put references and URL's here. Using the [title][1] syntax above, with [1]: foo.com here"

docs/decisions/001-vitest.md

@@ -0,0 +1,29 @@
+# Using Vitest
+
+## Context
+
+We currently test our packages with the use of the Node.js [built-in test runner][1]. This
+has a few downsides:
+
+- We write the test files with TypeScript, so either need to use a 'loader' like `tsx` or
+  transpile tests before running them.
+- The Node.js test runner just doesn't have the IDE support that we expect.
+
+## Decision
+
+Use [Vitest][2]. Webstorm comes with decent support. It supports on the fly transpiling of
+TypeScript and many more things. While staying fast, and only requiring a few lines of
+config.
+
+Another useful feature of Vitest is the out-of-the-box support for workspaces, which means
+that launching tests from the root or per package works seamlessly.
+
+## Consequences
+
+In the future we may have the need to support JSX in certain packages and thus tests,
+which Vitest supports. For other scenarios, Vite(st) plugins are most likely available.
+
+---
+
+[1]: https://nodejs.org/api/test.html
+[2]: https://vitest.dev/

package.json

@@ -8,19 +8,21 @@
 		"lint:ws": "npm run lint --workspaces --if-present --include-workspace-root",
 		"lint:ci:ws": "npm run lint:ci --workspaces --if-present --include-workspace-root",
 		"build:ws": "npm run build && npm run build --workspaces --if-present",
-		"test:ws": "npm run test --workspaces --if-present --include-workspace-root",
+		"clean:ws": "npm run clean --workspaces --if-present --include-workspace-root",
 		"build": "tsc --build",
 		"lint": "eslint . --fix --cache --cache-strategy content --cache-location .cache/eslint/ --color",
+		"test": "vitest",
 		"lint:ci": "eslint .",
-		"clean": "rm -rf ./.cache ./tsconfig.tsbuildinfo",
-		"clean:ws": "npm run clean --workspaces --if-present --include-workspace-root"
+		"clean": "rm -rf ./.cache ./tsconfig.tsbuildinfo"
 	},
 	"devDependencies": {
 		"@types/node": "20.14.9",
 		"@lightbase/eslint-config": "*",
 		"@total-typescript/tsconfig": "1.0.4",
+		"@vitest/coverage-v8": "2.0.0-beta.12",
 		"patch-package": "8.0.0",
-		"typescript": "5.5.2"
+		"typescript": "5.5.2",
+		"vitest": "2.0.0-beta.12"
 	},
 	"workspaces": ["packages/*", "apps/*"]
 }

packages/eslint-config/package.json

@@ -24,8 +24,7 @@
 		"build": "tsc -p ./tsconfig.json",
 		"lint": "eslint . --fix --cache --cache-strategy content --cache-location .cache/eslint/ --color",
 		"lint:ci": "eslint .",
-		"pretest": "npm run build",
-		"test": "node --test",
+		"test": "vitest",
 		"clean": "rm -rf ./.cache ./dist"
 	},
 	"dependencies": {

packages/eslint-config/src/index.ts

@@ -25,10 +25,11 @@ interface LightbaseEslintConfigOptions {
  * Entrypoint for your everything included ESLint config.
  */
 export async function defineConfig(
-	opts: LightbaseEslintConfigOptions,
+	opts?: LightbaseEslintConfigOptions,
 	...userConfigs: Array<FlatConfig.Config>
 ): Promise<Array<FlatConfig.Config>> {
 	globUseFromUserConfig(...userConfigs);
+	opts ??= {};
 	opts.typescript = typescriptResolveConfig(opts.typescript);
 
 	// Only load React + related plugins if necessary. This adds quite the startup penalty otherwise.

packages/eslint-config/test/config.test.ts

@@ -0,0 +1,18 @@
+import { test, expect } from "vitest";
+import { defineConfig } from "../src/index.js";
+
+test("returns a config if no arguments are specified", async () => {
+	expect(await defineConfig()).toEqual(expect.arrayContaining([]));
+});
+
+test("returns a config if TypeScript options are specified", async () => {
+	expect(await defineConfig({ typescript: false })).toEqual(expect.arrayContaining([]));
+	expect(await defineConfig({ typescript: true })).toEqual(expect.arrayContaining([]));
+	expect(await defineConfig({ typescript: {} })).toEqual(expect.arrayContaining([]));
+});
+
+test("returns a config if globals are specified", async () => {
+	expect(await defineConfig({ globals: ["node", "es5"] })).toEqual(
+		expect.arrayContaining([]),
+	);
+});