v8r 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 📦 [2.1.0](https://www.npmjs.com/package/v8r/v/2.1.0) - 2023-10-23
+
+* Add compatibility with JSON schemas serialized as Yaml
+
 ## 📦 [2.0.0](https://www.npmjs.com/package/v8r/v/2.0.0) - 2023-05-02
 
 * Drop compatibility with node 14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "v8r",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A command-line JSON and YAML validator that's on your wavelength",
   "scripts": {
     "test": "V8R_CACHE_NAME=v8r-test c8 --reporter=text mocha \"src/**/*.spec.js\"",
@@ -36,7 +36,7 @@
     "decamelize": "^6.0.0",
     "flat-cache": "^3.0.4",
     "glob": "^10.1.0",
-    "got": "^12.0.1",
+    "got": "^13.0.0",
     "is-url": "^1.2.4",
     "js-yaml": "^4.0.0",
     "json5": "^2.2.0",
@@ -44,17 +44,17 @@
     "yargs": "^17.0.1"
   },
   "devDependencies": {
-    "c8": "^7.10.0",
+    "c8": "^8.0.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.0.1",
-    "eslint-config-prettier": "^8.1.0",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-mocha": "^10.0.3",
-    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
     "mocha": "^10.0.0",
     "mock-cwd": "^1.0.0",
     "nock": "^13.0.4",
-    "prettier": "^2.1.2"
+    "prettier": "^3.0.0"
   },
   "engines": {
     "node": ">=16"

package/src/ajv.js

@@ -13,7 +13,7 @@ function _ajvFactory(
   schema,
   strictMode,
   cache,
-  resolver = (url) => cache.fetch(url)
+  resolver = (url) => cache.fetch(url),
 ) {
   const opts = { allErrors: true, loadSchema: resolver, strict: strictMode };
 
@@ -27,7 +27,7 @@ function _ajvFactory(
     } else if (schema["$schema"].includes("json-schema.org/draft-06/schema")) {
       const ajvDraft06 = new Ajv(opts);
       ajvDraft06.addMetaSchema(
-        require("ajv/lib/refs/json-schema-draft-06.json")
+        require("ajv/lib/refs/json-schema-draft-06.json"),
       );
       return ajvDraft06;
     } else if (schema["$schema"].includes("json-schema.org/draft-07/schema")) {

package/src/cache.js

@@ -1,5 +1,6 @@
 import got from "got";
 import logger from "./logger.js";
+import { parseSchema } from "./parser.js";
 
 class Cache {
   constructor(flatCache, ttl) {
@@ -20,7 +21,7 @@ class Cache {
           this.cache.removeKey(url);
         }
         this.cache.save(true);
-      }.bind(this)
+      }.bind(this),
     );
   }
 
@@ -39,7 +40,7 @@ class Cache {
     }
     if (this.callCounter[url] > this.callLimit) {
       throw new Error(
-        `Called ${url} >${this.callLimit} times. Possible circular reference.`
+        `Called ${url} >${this.callLimit} times. Possible circular reference.`,
       );
     }
   }
@@ -60,7 +61,7 @@ class Cache {
     try {
       logger.debug(`Cache miss: calling ${url}`);
       const resp = await got(url);
-      const parsedBody = JSON.parse(resp.body);
+      const parsedBody = parseSchema(resp.body, url);
       if (this.ttl > 0) {
         this.cache.setKey(url, { timestamp: Date.now(), body: parsedBody });
         this.cache.save(true);

package/src/catalogs.js

@@ -32,7 +32,7 @@ function getCatalogs(config) {
     catalogs = catalogs.concat(
       config.catalogs.map(function (loc) {
         return { location: loc };
-      })
+      }),
     );
   }
   catalogs.push({ location: SCHEMASTORE_CATALOG_URL });
@@ -83,7 +83,7 @@ async function getMatchForFilename(catalogs, filename, cache) {
     if (!rec.catalog) {
       const catalogSchema = await getFromUrlOrFile(
         SCHEMASTORE_CATALOG_SCHEMA_URL,
-        cache
+        cache,
       );
 
       // Validate the catalog
@@ -92,7 +92,7 @@ async function getMatchForFilename(catalogs, filename, cache) {
         catalog,
         catalogSchema,
         strictMode,
-        cache
+        cache,
       );
       if (!valid || catalog.schemas === undefined) {
         throw new Error(`Malformed catalog at ${catalogLocation}`);
@@ -123,10 +123,10 @@ async function getMatchForFilename(catalogs, filename, cache) {
       // We found >1 matches in the same catalog. This is always a hard error.
       const matchesLog = getMultipleMatchesLogMessage(matches);
       logger.info(
-        `Found multiple possible matches for ${filename}. Possible matches:\n\n${matchesLog}`
+        `Found multiple possible matches for ${filename}. Possible matches:\n\n${matchesLog}`,
       );
       throw new Error(
-        `Found multiple possible schemas to validate ${filename}`
+        `Found multiple possible schemas to validate ${filename}`,
       );
     }
 

package/src/cli.js

@@ -11,7 +11,7 @@ import { getFiles } from "./glob.js";
 import { getFromUrlOrFile } from "./io.js";
 import logger from "./logger.js";
 import { logErrors, resultsToJson } from "./output-formatters.js";
-import { parseFile } from "./parser.js";
+import { parseDocument } from "./parser.js";
 
 const EXIT = {
   VALID: 0,
@@ -52,12 +52,12 @@ async function validateFile(filename, config, cache) {
     result.schemaLocation = schemaLocation;
     const schema = await getFromUrlOrFile(schemaLocation, cache);
     logger.info(
-      `Validating ${filename} against schema from ${schemaLocation} ...`
+      `Validating ${filename} against schema from ${schemaLocation} ...`,
     );
 
-    const data = parseFile(
+    const data = parseDocument(
       await fs.promises.readFile(filename, "utf8"),
-      catalogMatch.parser ? `.${catalogMatch.parser}` : path.extname(filename)
+      catalogMatch.parser ? `.${catalogMatch.parser}` : path.extname(filename),
     );
 
     const strictMode = config.verbose >= 2 ? "log" : false;
@@ -70,7 +70,7 @@ async function validateFile(filename, config, cache) {
       schema,
       strictMode,
       cache,
-      resolver
+      resolver,
     );
     result.valid = valid;
     result.errors = errors;

package/src/config.js

@@ -21,7 +21,7 @@ function validateConfig(configFile) {
   if (!valid) {
     logErrors(
       configFile.filepath ? configFile.filepath : "",
-      validateFn.errors
+      validateFn.errors,
     );
     throw new Error("Malformed config file");
   }
@@ -36,7 +36,7 @@ function preProcessConfig(configFile) {
     if (!path.isAbsolute(schema.location) && !isUrl(schema.location)) {
       schema.location = path.join(
         path.dirname(configFile.filepath),
-        schema.location
+        schema.location,
       );
     }
   }
@@ -45,7 +45,7 @@ function preProcessConfig(configFile) {
 async function getCosmiConfig(cosmiconfigOptions) {
   cosmiconfigOptions.stopDir = process.cwd();
   const configFile = (await cosmiconfig("v8r", cosmiconfigOptions).search(
-    process.cwd()
+    process.cwd(),
   )) || { config: {} };
   if (configFile.filepath) {
     logger.info(`Loaded config file from ${getRelativeFilePath(configFile)}`);
@@ -84,7 +84,7 @@ function parseArgs(argv, config) {
     command = "$0 [patterns..]";
     patternsOpts.default = config.config.patterns;
     patternsOpts.defaultDescription = `${JSON.stringify(
-      config.config.patterns
+      config.config.patterns,
     )} (from config file ${getRelativeFilePath(config)})`;
   }
 
@@ -94,12 +94,12 @@ function parseArgs(argv, config) {
       "Validate local json/yaml files against schema(s)",
       (yargs) => {
         yargs.positional("patterns", patternsOpts);
-      }
+      },
     )
     .version(
       // Workaround for https://github.com/yargs/yargs/issues/1934
       // TODO: remove once fixed
-      require("../package.json").version
+      require("../package.json").version,
     )
     .option("verbose", {
       alias: "v",
@@ -160,7 +160,7 @@ function parseArgs(argv, config) {
       parser.default(
         decamelize(key, { separator: "-" }),
         value,
-        `${value} (from config file ${getRelativeFilePath(config)})`
+        `${value} (from config file ${getRelativeFilePath(config)})`,
       );
     }
   }

package/src/io.js

@@ -1,18 +1,20 @@
 import fs from "fs";
 import path from "path";
 import isUrl from "is-url";
+import { parseSchema } from "./parser.js";
 
 async function getFromUrlOrFile(location, cache, base = null) {
   if (isUrl(location)) {
     return await cache.fetch(location);
   } else {
     if (base != null) {
-      return JSON.parse(
-        await fs.promises.readFile(path.join(base, location), "utf8")
+      return parseSchema(
+        await fs.promises.readFile(path.join(base, location), "utf8"),
+        path.join(base, location),
       );
     }
   }
-  return JSON.parse(await fs.promises.readFile(location, "utf8"));
+  return parseSchema(await fs.promises.readFile(location, "utf8"), location);
 }
 
 export { getFromUrlOrFile };

package/src/output-formatters.js

@@ -7,7 +7,7 @@ function logErrors(filename, errors) {
     ajv.errorsText(errors, {
       separator: "\n",
       dataVar: filename + "#",
-    })
+    }),
   );
   logger.log("");
 }

package/src/parser.js

@@ -1,7 +1,7 @@
 import JSON5 from "json5";
 import yaml from "js-yaml";
 
-function parseFile(contents, format) {
+function parseDocument(contents, format) {
   switch (format) {
     case ".json":
     case ".geojson":
@@ -18,4 +18,16 @@ function parseFile(contents, format) {
   }
 }
 
-export { parseFile };
+function parseSchema(contents, location) {
+  if (location.endsWith(".yml") || location.endsWith(".yaml")) {
+    return yaml.load(contents);
+  }
+  /*
+  Always fall back and assume json even if no .json extension
+  Sometimes a JSON schema is served from a URL like
+  https://json-stat.org/format/schema/2.0/
+  */
+  return JSON.parse(contents);
+}
+
+export { parseDocument, parseSchema };