Support schema in YAML

Author: jdesrosiers

README.md

@@ -1,9 +1,9 @@
 # Hyperjump - JSON Schema Test Coverage
 
 This package provides tools for testing JSON Schemas and providing test coverage
-for schema files in your code base. Integration is provided for Vitest, but the
-component for collecting the coverage data is also exposed if you want to
-do some other integration.
+for schema files in JSON or YAML in your code base. Integration is provided for
+Vitest, but the component for collecting the coverage data is also exposed if
+you want to do some other integration.
 
 Validation is done by `@hyperjump/json-schema`, so you can use any version of
 JSON Schema supported by that package.
@@ -28,9 +28,7 @@ All files    |   81.81 |    66.66 |      80 |   88.88 |
 
 The following are known limitations I'm hopeful can be addressed.
 
-- Coverage can only be reported for `**/*.schema.json` and `**/schema.json`
-  files.
-- Schemas in YAML aren't supported.
+- Coverage can only be reported for `*.schema.(json|yaml|yml)` files.
 
 ## Vitest
 

package.json

@@ -28,6 +28,7 @@
   },
   "devDependencies": {
     "@stylistic/eslint-plugin": "*",
+    "@types/content-type": "^1.1.9",
     "@types/istanbul-lib-coverage": "^2.0.6",
     "@types/istanbul-reports": "^3.0.4",
     "@types/moo": "^0.5.10",
@@ -42,13 +43,16 @@
   "dependencies": {
     "@hyperjump/json-schema": "^1.16.0",
     "@hyperjump/uri": "^1.3.1",
+    "content-type": "^1.0.5",
     "ignore": "^7.0.5",
     "istanbul-lib-coverage": "^3.2.2",
     "istanbul-lib-report": "^3.0.1",
     "istanbul-reports": "^3.1.7",
     "moo": "^0.5.2",
     "pathe": "^2.0.3",
     "tinyglobby": "^0.2.14",
-    "vfile": "^6.0.3"
+    "vfile": "^6.0.3",
+    "yaml": "^2.8.0",
+    "yaml-unist-parser": "^2.0.5"
   }
 }

src/coverage-util.d.ts

@@ -0,0 +1,8 @@
+import type { CompiledSchema } from "@hyperjump/json-schema/experimental";
+import type { CoverageMapData } from "istanbul-lib-coverage";
+import type { JsonNode } from "./jsonast.js";
+
+export const astToCoverageMap: (compiledSchema: CompiledSchema, schemaPath: string, schemaNodes: Record<string, JsonNode>) => CoverageMapData;
+
+export const registerSchema: (filePath: string) => Promise<void>;
+export const parseToAst: (schemaPath: string) => Promise<JsonNode>;

src/coverage-util.js

@@ -1,15 +1,20 @@
+import { readFile } from "node:fs/promises";
+import { extname } from "node:path";
+import YAML from "yaml";
 import { getKeyword } from "@hyperjump/json-schema/experimental";
 import { parseIri, toAbsoluteIri } from "@hyperjump/uri";
-import { getNodeFromPointer } from "./json-util.js";
+import { registerSchema as register } from "./json-schema.js";
+import { fromJson, fromYaml, getNodeFromPointer } from "./json-util.js";
 
 /**
  * @import { Position } from "unist"
- * @import { CompiledSchema } from "@hyperjump/json-schema/experimental"
- * @import { CoverageMapData, FileCoverageData, Range } from "istanbul-lib-coverage"
- * @import { JsonNode } from "./jsonast.js"
+ * @import { FileCoverageData, Range } from "istanbul-lib-coverage"
+ * @import { SchemaObject } from "@hyperjump/json-schema"
+ * @import { JsonNode } from "./jsonast.d.ts"
+ * @import * as API from "./coverage-util.d.ts"
  */
 
-/** @type (compiledSchema: CompiledSchema, schemaPath: string, schemaNodes: Record<string, JsonNode>) => CoverageMapData */
+/** @type API.astToCoverageMap */
 export const astToCoverageMap = (compiledSchema, schemaPath, schemaNodes) => {
   /** @type FileCoverageData */
   const fileCoverage = {
@@ -109,3 +114,43 @@ const annotationKeywords = new Set([
   "https://json-schema.org/keyword/examples",
   "https://json-schema.org/keyword/format"
 ]);
+
+/** @type API.registerSchema */
+export const registerSchema = async (schemaPath) => {
+  const text = await readFile(schemaPath, "utf-8");
+  const extension = extname(schemaPath);
+
+  /** @type SchemaObject | boolean */
+  let schema;
+  switch (extension) {
+    case ".json":
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      schema = JSON.parse(text);
+      break;
+    case ".yaml":
+    case ".yml":
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      schema = YAML.parse(text);
+      break;
+    default:
+      throw Error(`File of type '${extension}' is not supported.`);
+  }
+
+  register(schema);
+};
+
+/** @type API.parseToAst */
+export const parseToAst = async (schemaPath) => {
+  const text = await readFile(schemaPath, "utf-8");
+  const extension = extname(schemaPath);
+
+  switch (extension) {
+    case ".json":
+      return fromJson(text);
+    case ".yaml":
+    case ".yml":
+      return fromYaml(text);
+    default:
+      throw Error(`File of type '${extension}' is not supported.`);
+  }
+};

src/index.d.ts

@@ -1 +1,2 @@
 export { TestCoverageEvaluationPlugin } from "./test-coverage-evaluation-plugin.d.ts";
+export * from "./coverage-util.d.ts";

src/index.js

@@ -1 +1,2 @@
 export { TestCoverageEvaluationPlugin } from "./test-coverage-evaluation-plugin.js";
+export * from "./coverage-util.js";

src/json-schema.js

@@ -0,0 +1,45 @@
+import "@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 "@hyperjump/json-schema/openapi-3-0";
+import "@hyperjump/json-schema/openapi-3-1";
+import { buildSchemaDocument } from "@hyperjump/json-schema/experimental";
+import { addMediaTypePlugin } from "@hyperjump/browser";
+import contentTypeParser from "content-type";
+import YAML from "yaml";
+
+/**
+ * @import { SchemaObject } from "@hyperjump/json-schema"
+ */
+
+addMediaTypePlugin("application/schema+json", {
+  parse: async (response) => {
+    const contentType = contentTypeParser.parse(response.headers.get("content-type") ?? "");
+    const contextDialectId = contentType.parameters.schema ?? contentType.parameters.profile;
+
+    /** @type SchemaObject */
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const json = await response.json();
+    return buildSchemaDocument(json, response.url, contextDialectId);
+  },
+  // eslint-disable-next-line @typescript-eslint/require-await
+  fileMatcher: async (path) => /\.json$/i.test(path)
+});
+
+addMediaTypePlugin("application/schema+yaml", {
+  parse: async (response) => {
+    const contentType = contentTypeParser.parse(response.headers.get("content-type") ?? "");
+    const contextDialectId = contentType.parameters.schema ?? contentType.parameters.profile;
+
+    /** @type SchemaObject */
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const yaml = YAML.parse(await response.text());
+    return buildSchemaDocument(yaml, response.url, contextDialectId);
+  },
+  // eslint-disable-next-line @typescript-eslint/require-await
+  fileMatcher: async (path) => /\.ya?ml$/i.test(path)
+});
+
+export * from "@hyperjump/json-schema/draft-2020-12";