Vitest (#1692)

* Set up Vitest

* Run yarn dedupe

* Extract API

* Remove unused dependencies

* Remove script no longer needed

* Update yarn.lock

* Add vitest workspace and fix lib type checking

* Add vitest typings workaround

* Add noEmit to all test/tsconfig.js files

* Extract API

* Add back Assertions type

* Remove unused devDependencies found by knip

* Add back original alfa-test as alfa-test-deprecated

* Delete parts from old alfa-test that are no longer needed

* Update yarn.lock

* Add vitest as dependency to alfa-test and update valid external dependencies

* Add new API report

* Add changeset

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

.changeset/orange-points-rule.md

@@ -0,0 +1,8 @@
+---
+"@siteimprove/alfa-test-deprecated": minor
+"@siteimprove/alfa-test": minor
+---
+
+**Breaking:** The `alfa-test` package is now called `alfa-test-deprecated` and a new `alfa-test` package was added.
+
+Consumers can either migrate by replacing references to `alfa-test` with `alfa-test-deprecated` or they can attempt to use `alfa-test` which builds on [Vitest](https://vitest.dev).

config/validate-structure.json

@@ -10,7 +10,8 @@
     "noExternalDeps": true,
     "allowedExternalDeps": {
       "@siteimprove/alfa-compatibility": ["browserslist"],
-      "@siteimprove/alfa-test": ["chalk"],
+      "@siteimprove/alfa-test": ["vitest"],
+      "@siteimprove/alfa-test-deprecated": ["chalk"],
       "@siteimprove/alfa-toolchain": [
         "@changesets/assemble-release-plan",
         "@changesets/config",

config/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    include: ["test/**/*.spec.ts?(x)"],
+  },
+});

config/vitest.workspace.ts

@@ -0,0 +1 @@
+export default ["packages/alfa-*", "!packages/alfa-test-deprecated"];

docs/review/api/alfa-dom.api.md

@@ -89,10 +89,10 @@ export namespace Attribute {
     // (undocumented)
     export interface MinimalJSON extends Node.JSON<"attribute"> {
     }
-    const // Warning: (ae-forgotten-export) The symbol "predicate" needs to be exported by the entry point index.d.ts
+    const // Warning: (ae-forgotten-export) The symbol "predicate_3" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
-    hasName: typeof predicate.hasName;
+    hasName: typeof predicate_3.hasName;
 }
 
 // @public (undocumented)
@@ -374,28 +374,28 @@ export namespace Element {
         // (undocumented)
         style: Block.JSON | string | null;
     }
-    const // Warning: (ae-forgotten-export) The symbol "predicate_3" needs to be exported by the entry point index.d.ts
+    const // Warning: (ae-forgotten-export) The symbol "predicate" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
-    hasAttribute: typeof predicate_3.hasAttribute, // (undocumented)
-    hasBox: typeof predicate_3.hasBox, // (undocumented)
-    hasDisplaySize: typeof predicate_3.hasDisplaySize, // (undocumented)
-    hasId: typeof predicate_3.hasId, // (undocumented)
-    hasInputType: typeof predicate_3.hasInputType, // (undocumented)
-    hasName: typeof predicate_3.hasName, // (undocumented)
-    hasNamespace: typeof predicate_3.hasNamespace, // (undocumented)
-    hasTabIndex: typeof predicate_3.hasTabIndex, // (undocumented)
+    hasAttribute: typeof predicate.hasAttribute, // (undocumented)
+    hasBox: typeof predicate.hasBox, // (undocumented)
+    hasDisplaySize: typeof predicate.hasDisplaySize, // (undocumented)
+    hasId: typeof predicate.hasId, // (undocumented)
+    hasInputType: typeof predicate.hasInputType, // (undocumented)
+    hasName: typeof predicate.hasName, // (undocumented)
+    hasNamespace: typeof predicate.hasNamespace, // (undocumented)
+    hasTabIndex: typeof predicate.hasTabIndex, // (undocumented)
     hasUniqueId: Predicate<Element<string>>, // (undocumented)
-    isBrowsingContextContainer: typeof predicate_3.isBrowsingContextContainer, // (undocumented)
-    isContent: typeof predicate_3.isContent, // (undocumented)
-    isActuallyDisabled: typeof predicate_3.isActuallyDisabled, // (undocumented)
-    isDocumentElement: typeof predicate_3.isDocumentElement, // (undocumented)
-    isDraggable: typeof predicate_3.isDraggable, // (undocumented)
-    isEditingHost: typeof predicate_3.isEditingHost, // (undocumented)
-    isFallback: typeof predicate_3.isFallback, // (undocumented)
-    isScopedTo: typeof predicate_3.isScopedTo, // (undocumented)
-    isSuggestedFocusable: typeof predicate_3.isSuggestedFocusable, // (undocumented)
-    isReplaced: typeof predicate_3.isReplaced;
+    isBrowsingContextContainer: typeof predicate.isBrowsingContextContainer, // (undocumented)
+    isContent: typeof predicate.isContent, // (undocumented)
+    isActuallyDisabled: typeof predicate.isActuallyDisabled, // (undocumented)
+    isDocumentElement: typeof predicate.isDocumentElement, // (undocumented)
+    isDraggable: typeof predicate.isDraggable, // (undocumented)
+    isEditingHost: typeof predicate.isEditingHost, // (undocumented)
+    isFallback: typeof predicate.isFallback, // (undocumented)
+    isScopedTo: typeof predicate.isScopedTo, // (undocumented)
+    isSuggestedFocusable: typeof predicate.isSuggestedFocusable, // (undocumented)
+    isReplaced: typeof predicate.isReplaced;
     // (undocumented)
     export interface MinimalJSON extends Node.JSON<"element"> {
     }

docs/review/api/alfa-test-deprecated.api.md

@@ -0,0 +1,79 @@
+## API Report File for "@siteimprove/alfa-test-deprecated"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public (undocumented)
+export interface Assertions {
+    // (undocumented)
+    <T>(value: T, message?: string): void;
+    // (undocumented)
+    deepEqual<T>(actual: T, expected: T, message?: string): void;
+    // (undocumented)
+    equal<T>(actual: T, expected: T, message?: string): void;
+    // (undocumented)
+    fail(message?: string): never;
+    // (undocumented)
+    notDeepEqual<T>(actual: T, expected: T, message?: string): void;
+    // (undocumented)
+    notEqual<T>(actual: T, expected: T, message?: string): void;
+    // (undocumented)
+    rejects<T>(block: Function | Promise<T>, error?: RegExp | Function | Object | Error, message?: string): void;
+    // (undocumented)
+    throws(block: Function, error?: RegExp | Function | Object | Error, message?: string): void;
+}
+
+// @public (undocumented)
+export interface Controller<T = number> {
+    // (undocumented)
+    iterations: number;
+    // (undocumented)
+    seed?: number;
+    // (undocumented)
+    wrapper: (rng: RNG<number>, iteration: number) => RNG<T>;
+}
+
+// Warning: (ae-internal-missing-underscore) The name "defaultController" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal (undocumented)
+export const defaultController: Controller<number>;
+
+// Warning: (ae-internal-missing-underscore) The name "format" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal (undocumented)
+export function format(name: string, error: Error): string;
+
+// Warning: (ae-internal-missing-underscore) The name "Notifier" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal (undocumented)
+export interface Notifier {
+    // (undocumented)
+    error(message: string): void;
+}
+
+// @public (undocumented)
+export type RNG<T = number> = () => T;
+
+// Warning: (ae-internal-missing-underscore) The name "seedableRNG" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export function seedableRNG(seed: number): RNG<number>;
+
+// Warning: (ae-forgotten-export) The symbol "Frame" needs to be exported by the entry point index.d.ts
+// Warning: (ae-internal-missing-underscore) The name "stack" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal (undocumented)
+export function stack(error: Error): Iterable<Frame>;
+
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "test" because one of its declarations is marked as @internal
+//
+// @public (undocumented)
+export function test<T = number>(name: string, assertion: (assert: Assertions, rng: RNG<T>, seed: number) => void | Promise<void>, controller?: Partial<Controller<T>>): Promise<void>;
+
+// @internal (undocumented)
+export function test<T = number>(name: string, assertion: (assert: Assertions, rng: RNG<T>, seed: number) => void | Promise<void>, notifier: Notifier, controller?: Partial<Controller<T>>): Promise<void>;
+
+// (No @packageDocumentation comment for this package)
+
+```

package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "build": "node --max-old-space-size=8192 scripts/build.mjs --pretty",
     "clean": "node scripts/clean.mjs --pretty",
-    "test": "node scripts/test.mjs --pretty",
+    "test": "yarn build && vitest run --config ./config/vitest.config.ts",
     "watch": "node scripts/watch.mjs --pretty",
     "extract": "node scripts/api-extractor.mjs --pretty",
     "document": "api-documenter generate -i docs/data/api -o docs/api",
@@ -32,15 +32,13 @@
     "@microsoft/api-documenter": "^7.19.9",
     "@microsoft/api-extractor": "^7.29.5",
     "@siteimprove/alfa-toolchain": "workspace:^0.94.1",
-    "@types/async": "^3.2.20",
     "@types/node": "^22.0.0",
-    "async": "^3.2.1",
-    "execa": "^9.0.0",
     "knip": "^5.23.1",
     "minimist": "^1.2.6",
     "package-dependency-graph": "^1.14.4",
     "prettier": "^3.0.0",
-    "typescript": "^5.5.2"
+    "typescript": "^5.5.2",
+    "vitest": "^2.1.5"
   },
   "packageManager": "[email protected]"
 }

packages/alfa-affine/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./transformation.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-aria/test/tsconfig.json

@@ -4,7 +4,7 @@
   "compilerOptions": {
     "jsx": "react-jsx",
     "jsxImportSource": "@siteimprove/alfa-dom",
-    "outDir": "."
+    "noEmit": true
   },
   "files": [
     "./dom/predicate/has-accessible-name.spec.tsx",

packages/alfa-branched/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./branched.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-cache/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./cache.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-cascade/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": ".",
+    "noEmit": true,
     "jsx": "react-jsx",
     "jsxImportSource": "@siteimprove/alfa-dom"
   },

packages/alfa-comparable/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./comparable.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-css-feature/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": [
     "./media.spec.ts",

packages/alfa-css/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": [
     "./common/parse.ts",

packages/alfa-dom/package.json

@@ -24,6 +24,8 @@
     "./jsx.js": "./dist/jsx.js",
     "./jsx-runtime": "./dist/jsx-runtime.js",
     "./jsx-runtime.js": "./dist/jsx-runtime.js",
+    "./jsx-dev-runtime": "./dist/jsx-runtime.js",
+    "./jsx-dev-runtime.js": "./dist/jsx-runtime.js",
     "./native": "./dist/native.js",
     "./native.js": "./dist/native.js"
   },

packages/alfa-dom/src/index.ts

@@ -37,5 +37,5 @@ export * from "./node/type.js";
 
 export * from "./node/query/index.js";
 
-export * from "./h.js";
+export { h } from "./h.js";
 export * from "./jsx.js";

packages/alfa-dom/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": ".",
+    "noEmit": true,
     "jsx": "react-jsx",
     "jsxImportSource": "@siteimprove/alfa-dom"
   },

packages/alfa-emitter/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./emitter.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-equatable/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./equatable.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-flags/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./flags.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-fnv/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./fnv.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-future/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./future.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-generator/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./generator.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-graph/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./graph.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-http/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./request.spec.ts", "./response.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-iana/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./language.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-lazy/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./lazy.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]

packages/alfa-list/test/tsconfig.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "."
+    "noEmit": true
   },
   "files": ["./list.spec.ts"],
   "references": [{ "path": "../src" }, { "path": "../../alfa-test" }]