Decouple matcher from matcher registration

Author: jdesrosiers

README.md

@@ -26,8 +26,9 @@ All files    |   81.81 |    66.66 |      80 |   88.88 |
 
 ## Vitest
 
-Integration with vitest is provided as `@hyperjump/json-schema-coverage/vitest`.
-You'll need a vitest config specifically for running schema coverage.
+Integration with vitest is provided. You'll need a vitest config specifically
+for running schema coverage. You can't run with coverage for both your js/ts
+code and schema at the same time.
 
 `vitest-schema.config.js`
 ```JavaScript
@@ -43,6 +44,10 @@ export default defineConfig({
 });
 ```
 
+```bash
+vitest run --config=vitest-schema.config.js --coverage
+```
+
 When you use the provided custom matcher `matchJsonSchema`/`toMatchJsonSchema`,
 if vitest has coverage is enabled, it will collect coverage data from those
 tests.

src/vitest/json-schema-matcher.d.ts

@@ -0,0 +1,5 @@
+import type { SchemaObject } from "@hyperjump/json-schema";
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const matchJsonSchema: (instance: any, uriOrSchema: string | SchemaObject | boolean) => AsyncExpectationResult;
+export const toMatchJsonSchema: typeof matchJsonSchema;

src/vitest/json-schema-matcher.js

@@ -0,0 +1,59 @@
+import { randomUUID } from "node:crypto";
+import { existsSync } from "node:fs";
+import { writeFile } from "node:fs/promises";
+import { registerSchema, unregisterSchema, validate } from "@hyperjump/json-schema/draft-2020-12";
+import "@hyperjump/json-schema/draft-2019-09";
+import "@hyperjump/json-schema/draft-07";
+import "@hyperjump/json-schema/draft-06";
+import "@hyperjump/json-schema/draft-04";
+import { BASIC } from "@hyperjump/json-schema/experimental";
+import { TestCoverageEvaluationPlugin } from "../test-coverage-evaluation-plugin.js";
+
+/**
+ * @import { OutputUnit, SchemaObject } from "@hyperjump/json-schema"
+ * @import { AsyncExpectationResult } from "@vitest/expect"
+ */
+
+/** @type (instance: any, uriOrSchema: string | SchemaObject | boolean) => AsyncExpectationResult */
+export const matchJsonSchema = async (instance, uriOrSchema) => {
+  /** @type OutputUnit */
+  let output;
+
+  if (typeof uriOrSchema === "string") {
+    const uri = uriOrSchema;
+
+    if (existsSync(".json-schema-coverage")) {
+      const testCoveragePlugin = new TestCoverageEvaluationPlugin();
+
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+      output = await validate(uri, instance, {
+        outputFormat: BASIC,
+        plugins: [testCoveragePlugin]
+      });
+
+      const coverageMapPath = `.json-schema-coverage/${randomUUID()}.json`;
+      const coverageMapJson = JSON.stringify(testCoveragePlugin.coverageMap);
+      await writeFile(coverageMapPath, coverageMapJson);
+    } else {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+      output = await validate(uri, instance, BASIC);
+    }
+  } else {
+    const schema = uriOrSchema;
+    const uri = `urn:uuid:${randomUUID()}`;
+    registerSchema(schema, uri, "https://json-schema.org/draft/2020-12/schema");
+    try {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+      output = await validate(uri, instance, BASIC);
+    } finally {
+      unregisterSchema(uri);
+    }
+  }
+
+  return {
+    pass: output.valid,
+    message: () => JSON.stringify(output, null, "  ")
+  };
+};
+
+export const toMatchJsonSchema = matchJsonSchema;

src/vitest/matchers.js

@@ -1,63 +1,7 @@
-import { randomUUID } from "node:crypto";
-import { existsSync } from "node:fs";
-import { writeFile } from "node:fs/promises";
 import { expect } from "vitest";
-import { registerSchema, unregisterSchema, validate } from "@hyperjump/json-schema/draft-2020-12";
-import "@hyperjump/json-schema/draft-2019-09";
-import "@hyperjump/json-schema/draft-07";
-import "@hyperjump/json-schema/draft-06";
-import "@hyperjump/json-schema/draft-04";
-import { BASIC } from "@hyperjump/json-schema/experimental";
-import { TestCoverageEvaluationPlugin } from "../test-coverage-evaluation-plugin.js";
-
-/**
- * @import { OutputUnit, SchemaObject } from "@hyperjump/json-schema"
- * @import { AsyncExpectationResult } from "@vitest/expect"
- */
-
-/** @type (instance: any, uriOrSchema: string | SchemaObject | boolean) => AsyncExpectationResult */
-const schemaMatcher = async (instance, uriOrSchema) => {
-  /** @type OutputUnit */
-  let output;
-
-  if (typeof uriOrSchema === "string") {
-    const uri = uriOrSchema;
-
-    if (existsSync(".json-schema-coverage")) {
-      const testCoveragePlugin = new TestCoverageEvaluationPlugin();
-
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-      output = await validate(uri, instance, {
-        outputFormat: BASIC,
-        plugins: [testCoveragePlugin]
-      });
-
-      const coverageMapPath = `.json-schema-coverage/${randomUUID()}.json`;
-      const coverageMapJson = JSON.stringify(testCoveragePlugin.coverageMap);
-      await writeFile(coverageMapPath, coverageMapJson);
-    } else {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-      output = await validate(uri, instance, BASIC);
-    }
-  } else {
-    const schema = uriOrSchema;
-    const uri = `urn:uuid:${randomUUID()}`;
-    registerSchema(schema, uri, "https://json-schema.org/draft/2020-12/schema");
-    try {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-      output = await validate(uri, instance, BASIC);
-    } finally {
-      unregisterSchema(uri);
-    }
-  }
-
-  return {
-    pass: output.valid,
-    message: () => JSON.stringify(output, null, "  ")
-  };
-};
+import { matchJsonSchema } from "./json-schema-matcher.js";
 
 expect.extend({
-  matchJsonSchema: schemaMatcher,
-  toMatchJsonSchema: schemaMatcher
+  matchJsonSchema: matchJsonSchema,
+  toMatchJsonSchema: matchJsonSchema
 });