Change registerSchema to take a file path

Author: jdesrosiers

README.md

@@ -28,10 +28,11 @@ All files    |   81.81 |    66.66 |      80 |   88.88 |
 
 The following are known limitations I'm hopeful can be addressed.
 
+- Coverage can't be reported for embedded schemas.
 - Coverage can only be reported for `**/*.schema.json` and `**/schema.json`
   files.
-- Coverage can't be reported for embedded schemas.
 - Schemas in YAML aren't supported.
+- TODO: Make sure types work
 
 ## Vitest
 
@@ -76,8 +77,35 @@ describe("Worksheet", () => {
 });
 ```
 
+Instead of referring to the file path, you can register the schema and use its
+`$id`. Another reason to register a schema is if your schema references another
+schema.
+
+```JavaScript
+import { describe, expect, test } from "vitest";
+import { registerSchema, unregisterSchema } from "@hyperjump/json-schema-coverage/vitest-matchers";
+
+describe("Worksheet", () => {
+  beforeEach(() => {
+    registerSchema("./schema.json");
+  });
+
+  afterEach(() => {
+    unregisterSchema("./schema.json");
+  });
+
+  test("matches with uri", async () => {
+    await expect({ foo: 42 }).toMatchJsonSchema("https://example.com/main");
+  });
+
+  test("doesn't match with uri", async () => {
+    await expect({ foo: null }).not.toMatchJsonSchema("https://example.com/main");
+  });
+});
+```
+
 You can also use the matcher with inline schemas, but you only get coverage for
-file-based schemas.
+schemas from files in your code base.
 
 ```JavaScript
 import { describe, expect, test } from "vitest";

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

@@ -1,8 +1,11 @@
 import type { SchemaObject } from "@hyperjump/json-schema";
+import type { AsyncExpectationResult } from "@vitest/expect";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const matchJsonSchema: (instance: any, uriOrSchema: string | SchemaObject | boolean) => AsyncExpectationResult;
 export const toMatchJsonSchema: typeof matchJsonSchema;
 
-export type { registerSchema, unregisterSchema } from "@hyperjump/json-schema/draft-2020-12";
+export const registerSchema: (filePath: string) => Promise<void>;
+
+export type { unregisterSchema } from "@hyperjump/json-schema/draft-2020-12";
 export type { loadDialect, defineVocabulary, addKeyword } from "@hyperjump/json-schema/experimental";

src/vitest/json-schema-matcher.js

@@ -1,7 +1,11 @@
 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 { readFile, writeFile } from "node:fs/promises";
+import {
+  registerSchema as register,
+  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";
@@ -13,10 +17,10 @@ import { TestCoverageEvaluationPlugin } from "../test-coverage-evaluation-plugin
 
 /**
  * @import { OutputUnit, SchemaObject } from "@hyperjump/json-schema"
- * @import { AsyncExpectationResult } from "@vitest/expect"
+ * @import * as API from "./json-schema-matcher.d.ts"
  */
 
-/** @type (instance: any, uriOrSchema: string | SchemaObject | boolean) => AsyncExpectationResult */
+/** @type API.matchJsonSchema */
 export const matchJsonSchema = async (instance, uriOrSchema) => {
   /** @type OutputUnit */
   let output;
@@ -43,7 +47,7 @@ export const matchJsonSchema = async (instance, uriOrSchema) => {
   } else {
     const schema = uriOrSchema;
     const uri = `urn:uuid:${randomUUID()}`;
-    registerSchema(schema, uri, "https://json-schema.org/draft/2020-12/schema");
+    register(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);
@@ -59,5 +63,15 @@ export const matchJsonSchema = async (instance, uriOrSchema) => {
 };
 
 export const toMatchJsonSchema = matchJsonSchema;
-export { registerSchema, unregisterSchema } from "@hyperjump/json-schema/draft-2020-12";
+
+/** @type API.registerSchema */
+export const registerSchema = async (filePath) => {
+  const json = await readFile(filePath, "utf-8");
+  /** @type SchemaObject */
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+  const schema = JSON.parse(json);
+  register(schema);
+};
+
+export { unregisterSchema } from "@hyperjump/json-schema/draft-2020-12";
 export { loadDialect, defineVocabulary, addKeyword } from "@hyperjump/json-schema/experimental";