Fixes for supporting vocabularies

Author: jdesrosiers

README.md

@@ -7,7 +7,7 @@ some other integration. It uses the [istanbul] coverage format, so you can
 generate any reports that support [istanbul].
 
 Validation is done by [@hyperjump/json-schema], so you can use any version of
-JSON Schema.
+JSON Schema, or provide your own custom keywords, vocabularies, and dialects.
 
 ```
 -------------|---------|----------|---------|---------|-------------------
@@ -50,14 +50,13 @@ code and schema code at the same time.
 
 By default, it will track coverage for any file with a `*.schema.json`,
 `*.schema.yaml`, or `*.schema.yml` extension. You can change this with the
-`include` option.
+`include` option. For example, if you keep your schemas in a folder called
+`schemas` and they just have plain extensions (`*.json`) instead of schema
+extensions `*.schema.json`, you could use `["schemas/**/*.json"]`.
 
-**Options**
-
-- **include** -- An array of paths of schemas you want to track coverage for.
-  For example, if you keep your schemas in a folder called `schemas` and they
-  just have plain extensions (`*.json`) instead of schema extensions
-  `*.schema.json`, you could use `["schemas/**/*.json"]`.
+If you use custom keywords, vocabularies, and dialects, you'll need to
+register them with a [globalSetup](https://vitest.dev/config/#globalsetup)
+script.
 
 `vitest-schema.config.js`
 ```TypeScript
@@ -66,7 +65,8 @@ import type { JsonSchemaCoverageProviderOptions } from "@hyperjump/json-schema-c
 
 export default defineConfig({
   test: {
-    include: ["schema-tests/"],
+    globalSetup: ["./register-my-dialect.ts"], // Optional
+    include: ["schema-tests/"], // Optional
     coverage: {
       provider: "custom",
       customProviderModule: "@hyperjump/json-schema-coverage/vitest/coverage-provider",
@@ -150,7 +150,7 @@ describe("Worksheet", () => {
 });
 ```
 
-## Vitest API
+### Vitest API
 
 These are the functions available when working with the vitest integration.
 
@@ -182,24 +182,6 @@ import { ... } from "@hyperjump/json-schema-coverage/vitest"
 
     _**NOTE**: This is **not** the same as the function from
     [@hyperjump/json-schema] that takes the schema's `$id`._
-- **defineVocabulary**: (vocabularyUri: string, keywords: Record<string, string>) => void
-
-    If your schemas use a custom vocabulary, you can register your vocabulary
-    with this function.
-
-    _**NOTE**: This is the same as the function from [@hyperjump/json-schema]_
-- **addKeyword**: (keywordHandler: Keyword) => void
-
-    If your schemas use a custom vocabulary, you can register your custom
-    keywords with this function.
-
-    _**NOTE**: This is the same as the function from [@hyperjump/json-schema]_
-- **loadDialect**: (dialectUri: string, dialect: Record<string, boolean>, allowUnknowKeywords?: boolean) => void
-
-    If your schemas use a custom dialect, you can register it with this
-    function.
-
-    _**NOTE**: This is the same as the function from [@hyperjump/json-schema]_
 
 ## Low-Level API
 

src/vitest/build-coverage-maps.js

@@ -0,0 +1,58 @@
+import { existsSync } from "node:fs";
+import { readFile } from "node:fs/promises";
+import { resolve } from "node:path";
+import { glob } from "tinyglobby";
+import ignore from "ignore";
+import { registerSchema } from "./json-schema-matchers.js";
+import { FileCoverageMapService } from "./file-coverage-map-service.js";
+
+/**
+ * @import { TestProject } from "vitest/node"
+ */
+
+/** @type (projects: TestProject) => Promise<void> */
+export const setup = async (projects) => {
+  const config = projects.vitest.config;
+
+  const coverageService = new FileCoverageMapService(".json-schema-coverage/maps");
+
+  // If --project filter is set pick only roots of resolved projects
+  const roots = config.project?.length
+    ? [...new Set(projects.vitest.projects.map((project) => project.config.root))]
+    : [config.root];
+
+  const include = "include" in config.coverage
+    ? /** @type string[] */ (config.coverage.include)
+    : ["**/*.schema.(json|yaml|yml)"];
+
+  // Build coverage maps
+  for (const root of roots) {
+    const i = ignore();
+    const gitignorePath = resolve(root, ".gitignore");
+    if (existsSync(gitignorePath)) {
+      const gitignore = await readFile(gitignorePath, "utf-8");
+      i.add(gitignore);
+    }
+
+    let includedFiles = await glob(include, {
+      cwd: root,
+      dot: true,
+      onlyFiles: true
+    });
+
+    const files = i
+      .filter(includedFiles)
+      .map((file) => resolve(root, file));
+
+    for (const schemaPath of files) {
+      try {
+        await registerSchema(schemaPath);
+      } catch (_error) {
+      }
+    }
+
+    for (const file of files) {
+      await coverageService.addFromFile(file);
+    }
+  }
+};

src/vitest/coverage-provider.js

@@ -4,12 +4,9 @@ import path from "node:path";
 import coverage from "istanbul-lib-coverage";
 import libReport from "istanbul-lib-report";
 import reports from "istanbul-reports";
-import ignore from "ignore";
-import { glob } from "tinyglobby";
 import { resolve } from "pathe";
 import c from "tinyrainbow";
 import { coverageConfigDefaults } from "vitest/config";
-import { registerSchema } from "./json-schema-matchers.js";
 import { FileCoverageMapService } from "./file-coverage-map-service.js";
 
 /**
@@ -45,11 +42,6 @@ class JsonSchemaCoverageProvider {
   coverageFilesDirectory = ".json-schema-coverage";
   coverageService = new FileCoverageMapService(".json-schema-coverage/maps");
 
-  /** @type string[] */
-  roots = [];
-
-  include = ["**/*.schema.json", "**/*.schema.yaml", "**/*.schema.yml"];
-
   /** @type CoverageProvider["initialize"] */
   initialize(ctx) {
     this.ctx = ctx;
@@ -73,14 +65,8 @@ class JsonSchemaCoverageProvider {
       reporter: resolveCoverageReporters(config.reporter || coverageConfigDefaults.reporter)
     };
 
-    // If --project filter is set pick only roots of resolved projects
-    this.roots = ctx.config.project?.length
-      ? [...new Set(ctx.projects.map((project) => project.config.root))]
-      : [ctx.config.root];
-
-    if ("include" in config) {
-      this.include = config.include;
-    }
+    const buildScriptPath = path.resolve(import.meta.dirname, "./build-coverage-maps.js");
+    /** @type string[] */ (ctx.config.globalSetup).push(buildScriptPath);
   }
 
   /** @type CoverageProvider["resolveOptions"] */
@@ -109,37 +95,6 @@ class JsonSchemaCoverageProvider {
     await this.coverageService.open();
 
     await fs.mkdir(this.coverageFilesDirectory, { recursive: true });
-
-    // Build coverage maps
-    for (const root of this.roots) {
-      const i = ignore();
-      const gitignorePath = path.resolve(root, ".gitignore");
-      if (existsSync(gitignorePath)) {
-        const gitignore = await fs.readFile(gitignorePath, "utf-8");
-        i.add(gitignore);
-      }
-
-      let includedFiles = await glob(this.include, {
-        cwd: root,
-        dot: true,
-        onlyFiles: true
-      });
-
-      const files = i
-        .filter(includedFiles)
-        .map((file) => path.resolve(root, file));
-
-      for (const schemaPath of files) {
-        try {
-          await registerSchema(schemaPath);
-        } catch (_error) {
-        }
-      }
-
-      for (const file of files) {
-        await this.coverageService.addFromFile(file);
-      }
-    }
   }
 
   /** @type () => Promise<void> */

src/vitest/index.d.ts

@@ -38,5 +38,3 @@ export const unregisterSchema: (filePath: string) => Promise<void>;
 // 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 { loadDialect, defineVocabulary, addKeyword } from "@hyperjump/json-schema/experimental";

src/vitest/index.js

@@ -8,4 +8,3 @@ expect.extend({
 });
 
 export * from "./json-schema-matchers.js";
-export { loadDialect, defineVocabulary, addKeyword } from "@hyperjump/json-schema/experimental";