v8r 0.13.0 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 📦 [0.14.0](https://www.npmjs.com/package/v8r/v/0.14.0) - 2023-01-28
+
+* Throw an error if multiple versions of a schema are found in the catalog,
+  instead of assuming the latest version
+
+## 📦 [0.13.1](https://www.npmjs.com/package/v8r/v/0.13.1) - 2022-12-10
+
+* Resolve external `$ref`s in local schemas
+
 ## 📦 [0.13.0](https://www.npmjs.com/package/v8r/v/0.13.0) - 2022-06-11
 
 * Overhaul of CLI output/machine-readable output. Validation results are sent to stdout. Log messages are now sent to stderr only. Pass `--format [text|json] (default: text)` to specify what is sent to stdout.

package/README.md

@@ -6,7 +6,7 @@
 ![license](https://raw.githubusercontent.com/chris48s/v8r/badges/.badges/main/package-license.svg)
 ![node](https://raw.githubusercontent.com/chris48s/v8r/badges/.badges/main/package-node-version.svg)
 
-A command-line JSON and YAML validator that's on your wavelength.
+v8r is a command-line JSON and YAML validator that uses [Schema Store](https://www.schemastore.org/) to detect a suitable schema for your input files based on the filename.
 
 ## Getting Started
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "v8r",
-  "version": "0.13.0",
+  "version": "0.14.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\"",
@@ -15,6 +15,11 @@
   },
   "main": "src/index.js",
   "exports": "./src/index.js",
+  "files": [
+    "src/**/!(*.spec).js",
+    "config-schema.json",
+    "CHANGELOG.md"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/chris48s/v8r.git"
@@ -27,7 +32,7 @@
     "ajv-draft-04": "^1.0.0",
     "ajv-formats": "^2.1.1",
     "chalk": "^5.0.0",
-    "cosmiconfig": "^7.0.1",
+    "cosmiconfig": "^8.0.0",
     "decamelize": "^6.0.0",
     "flat-cache": "^3.0.4",
     "glob": "^8.0.1",
@@ -35,7 +40,7 @@
     "is-url": "^1.2.4",
     "js-yaml": "^4.0.0",
     "json5": "^2.2.0",
-    "minimatch": "^5.0.1",
+    "minimatch": "^6.1.6",
     "yargs": "^17.0.1"
   },
   "devDependencies": {

package/src/ajv.js

@@ -9,8 +9,12 @@ import Ajv2019 from "ajv/dist/2019.js";
 import Ajv2020 from "ajv/dist/2020.js";
 import addFormats from "ajv-formats";
 
-function _ajvFactory(schema, strictMode, cache) {
-  const resolver = (url) => cache.fetch(url);
+function _ajvFactory(
+  schema,
+  strictMode,
+  cache,
+  resolver = (url) => cache.fetch(url)
+) {
   const opts = { allErrors: true, loadSchema: resolver, strict: strictMode };
 
   if (
@@ -53,8 +57,8 @@ function _ajvFactory(schema, strictMode, cache) {
   */
 }
 
-async function validate(data, schema, strictMode, cache) {
-  const ajv = _ajvFactory(schema, strictMode, cache);
+async function validate(data, schema, strictMode, cache, resolver) {
+  const ajv = _ajvFactory(schema, strictMode, cache, resolver);
   addFormats(ajv);
   const validateFn = await ajv.compileAsync(schema);
   const valid = validateFn(data);

package/src/catalogs.js

@@ -39,6 +39,41 @@ function getCatalogs(config) {
   return catalogs;
 }
 
+function getMatchLogMessage(match) {
+  let outStr = "";
+  outStr += `  ${match.name}\n`;
+  if (match.description) {
+    outStr += `  ${match.description}\n`;
+  }
+  outStr += `  ${match.url || match.location}\n`;
+  return outStr;
+}
+
+function getVersionLogMessage(match, versionId, versionSchemaUrl) {
+  let outStr = "";
+  outStr += `  ${match.name} (${versionId})\n`;
+  if (match.description) {
+    outStr += `  ${match.description}\n`;
+  }
+  outStr += `  ${versionSchemaUrl}\n`;
+  return outStr;
+}
+
+function getMultipleMatchesLogMessage(matches) {
+  return matches
+    .map(function (match) {
+      if (Object.keys(match.versions || {}).length > 1) {
+        return Object.entries(match.versions)
+          .map(function ([versionId, versionSchemaUrl]) {
+            return getVersionLogMessage(match, versionId, versionSchemaUrl);
+          })
+          .join("\n");
+      }
+      return getMatchLogMessage(match);
+    })
+    .join("\n");
+}
+
 async function getMatchForFilename(catalogs, filename, cache) {
   for (const [i, rec] of catalogs.entries()) {
     const catalogLocation = rec.location;
@@ -67,32 +102,36 @@ async function getMatchForFilename(catalogs, filename, cache) {
     const { schemas } = catalog;
     const matches = getSchemaMatchesForFilename(schemas, filename);
     logger.debug(`Searching for schema in ${catalogLocation} ...`);
-    if (matches.length === 1) {
+
+    if (
+      (matches.length === 1 && matches[0].versions == null) ||
+      (matches.length === 1 && Object.keys(matches[0].versions).length === 1)
+    ) {
       logger.info(`Found schema in ${catalogLocation} ...`);
-      return coerceMatch(matches[0]); // Match found. We're done.
+      return coerceMatch(matches[0]); // Exactly one match found. We're done.
     }
+
     if (matches.length === 0 && i < catalogs.length - 1) {
-      continue; // No match found. Try the next catalog in the array.
+      continue; // No matches found. Try the next catalog in the array.
     }
-    if (matches.length > 1) {
+
+    if (
+      matches.length > 1 ||
+      (matches.length === 1 &&
+        Object.keys(matches[0].versions || {}).length > 1)
+    ) {
       // We found >1 matches in the same catalog. This is always a hard error.
-      const matchesLog = matches
-        .map(function (match) {
-          let outStr = "";
-          outStr += `  ${match.name}\n`;
-          if (match.description) {
-            outStr += `  ${match.description}\n`;
-          }
-          outStr += `  ${match.url || match.location}\n`;
-          return outStr;
-        })
-        .join("\n");
+      const matchesLog = getMultipleMatchesLogMessage(matches);
       logger.info(
-        `Found multiple possible schemas for ${filename}. Possible matches:\n${matchesLog}`
+        `Found multiple possible matches for ${filename}. Possible matches:\n\n${matchesLog}`
+      );
+      throw new Error(
+        `Found multiple possible schemas to validate ${filename}`
       );
     }
-    // Either we found >1 matches in the same catalog or we found 0 matches
-    // in the last catalog and there are no more catalogs left to try.
+
+    // We found 0 matches in the last catalog
+    // and there are no more catalogs left to try
     throw new Error(`Could not find a schema to validate ${filename}`);
   }
 }

package/src/cli.js

@@ -2,6 +2,7 @@ import flatCache from "flat-cache";
 import fs from "fs";
 import os from "os";
 import path from "path";
+import isUrl from "is-url";
 import { validate } from "./ajv.js";
 import { Cache } from "./cache.js";
 import { getCatalogs, getMatchForFilename } from "./catalogs.js";
@@ -60,7 +61,17 @@ async function validateFile(filename, config, cache) {
     );
 
     const strictMode = config.verbose >= 2 ? "log" : false;
-    const { valid, errors } = await validate(data, schema, strictMode, cache);
+    const resolver = isUrl(schemaLocation)
+      ? (location) => getFromUrlOrFile(location, cache)
+      : (location) =>
+          getFromUrlOrFile(location, cache, path.dirname(schemaLocation));
+    const { valid, errors } = await validate(
+      data,
+      schema,
+      strictMode,
+      cache,
+      resolver
+    );
     result.valid = valid;
     result.errors = errors;
     if (valid) {

package/src/io.js

@@ -1,10 +1,18 @@
 import fs from "fs";
+import path from "path";
 import isUrl from "is-url";
 
-async function getFromUrlOrFile(location, cache) {
-  return isUrl(location)
-    ? await cache.fetch(location)
-    : JSON.parse(await fs.promises.readFile(location, "utf8"));
+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 JSON.parse(await fs.promises.readFile(location, "utf8"));
 }
 
 export { getFromUrlOrFile };

package/src/test-helpers.js

@@ -0,0 +1,58 @@
+import chai from "chai";
+import chaiAsPromised from "chai-as-promised";
+import flatCache from "flat-cache";
+import logger from "./logger.js";
+
+chai.use(chaiAsPromised);
+
+const origWriteOut = logger.writeOut;
+const origWriteErr = logger.writeErr;
+const testCacheName = process.env.V8R_CACHE_NAME;
+
+function setUp() {
+  flatCache.clearCacheById(testCacheName);
+  logger.resetStdout();
+  logger.resetStderr();
+  logger.writeOut = function () {};
+  logger.writeErr = function () {};
+}
+
+function tearDown() {
+  flatCache.clearCacheById(testCacheName);
+  logger.resetStdout();
+  logger.resetStderr();
+  logger.writeOut = origWriteOut;
+  logger.writeErr = origWriteErr;
+}
+
+function isString(el) {
+  return typeof el === "string" || el instanceof String;
+}
+
+function logContainsSuccess(expectedString, expectedCount = 1) {
+  const counter = (count, el) =>
+    count + (isString(el) && el.includes("✔") && el.includes(expectedString));
+  return logger.stderr.reduce(counter, 0) === expectedCount;
+}
+
+function logContainsInfo(expectedString, expectedCount = 1) {
+  const counter = (count, el) =>
+    count + (isString(el) && el.includes("ℹ") && el.includes(expectedString));
+  return logger.stderr.reduce(counter, 0) === expectedCount;
+}
+
+function logContainsError(expectedString, expectedCount = 1) {
+  const counter = (count, el) =>
+    count + (isString(el) && el.includes("✖") && el.includes(expectedString));
+  return logger.stderr.reduce(counter, 0) === expectedCount;
+}
+
+export {
+  chai,
+  testCacheName,
+  setUp,
+  tearDown,
+  logContainsSuccess,
+  logContainsInfo,
+  logContainsError,
+};