v8r 4.2.0 → 4.3.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 📦 [4.3.0](https://www.npmjs.com/package/v8r/v/4.3.0) - 2025-04-21
+
+* Add ignore patern files. v8r now looks for ignore patterns in `.v8rignore` by default.
+  More info: https://chris48s.github.io/v8r/ignoring-files/
+* Include the prop name in `additionalProperty` log message.
+* Allow config file to contain `$schema` key.
+* Fix: Clear the cache on init if TTL is 0.
+
+## 📦 [4.2.1](https://www.npmjs.com/package/v8r/v/4.2.1) - 2024-12-14
+
+* Upgrade to flat-cache 6.
+  This release revamps how cache is stored and invalidated internally
+  but should have no user-visible impact
+
 ## 📦 [4.2.0](https://www.npmjs.com/package/v8r/v/4.2.0) - 2024-10-24
 
 * Add `V8R_CONFIG_FILE` environment variable.

package/config-schema.json

@@ -65,6 +65,14 @@
       "description": "Exit with code 0 even if an error was encountered. True means a non-zero exit code is only issued if validation could be completed successfully and one or more files were invalid",
       "type": "boolean"
     },
+    "ignorePatternFiles": {
+      "description": "A list of files containing glob patterns to ignore",
+      "uniqueItems": true,
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
     "patterns": {
       "type": "array",
       "description": "One or more filenames or glob patterns describing local file or files to validate",
@@ -87,6 +95,9 @@
         "type": "string",
         "pattern": "^(package:|file:)"
       }
+    },
+    "$schema": {
+      "type": "string"
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "v8r",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "A command-line JSON, YAML and TOML validator that's on your wavelength",
   "scripts": {
     "test": "V8R_CACHE_NAME=v8r-test c8 --reporter=text mocha \"src/**/*.spec.js\"",
@@ -33,10 +33,11 @@
     "chalk": "^5.0.0",
     "cosmiconfig": "^9.0.0",
     "decamelize": "^6.0.0",
-    "flat-cache": "^5.0.0",
+    "flat-cache": "^6.1.4",
     "glob": "^10.1.0",
     "global-agent": "^3.0.0",
     "got": "^13.0.0",
+    "ignore": "^7.0.0",
     "is-url": "^1.2.4",
     "js-yaml": "^4.0.0",
     "json5": "^2.2.0",
@@ -47,13 +48,13 @@
   "devDependencies": {
     "c8": "^10.1.2",
     "eslint": "^9.9.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^10.1.2",
     "eslint-plugin-jsdoc": "^50.2.2",
     "eslint-plugin-mocha": "^10.0.3",
     "eslint-plugin-prettier": "^5.0.0",
-    "mocha": "^10.7.3",
+    "mocha": "^11.0.1",
     "mock-cwd": "^1.0.0",
-    "nock": "^13.0.4",
+    "nock": "^14.0.4",
     "prettier": "^3.0.0",
     "prettier-plugin-jsdoc": "^1.3.0"
   },

package/src/bootstrap.js

@@ -76,13 +76,51 @@ function parseArgs(argv, config, documentFormats, outputFormats) {
     )} (from config file ${getRelativeFilePath(config)})`;
   }
 
+  const ignoreFilesOpts = {
+    describe: "A list of files containing glob patterns to ignore",
+  };
+  let ignoreFilesDefault = [".v8rignore"];
+  ignoreFilesOpts.defaultDescription = `${JSON.stringify(ignoreFilesDefault)}`;
+  if (Object.keys(config.config).includes("ignorePatternFiles")) {
+    ignoreFilesDefault = config.config.ignorePatternFiles;
+    ignoreFilesOpts.defaultDescription = `${JSON.stringify(
+      ignoreFilesDefault,
+    )} (from config file ${getRelativeFilePath(config)})`;
+  }
+
   parser
     .command(
+      // command
       command,
+
+      // description
       `Validate local ${documentFormats.join("/")} files against schema(s)`,
+
+      // builder
       (yargs) => {
         yargs.positional("patterns", patternsOpts);
       },
+
+      // handler
+      (args) => {
+        /*
+        Yargs doesn't allow .conflicts() with an argument that has a default
+        value (it considers the arg "set" even if we just use the default)
+        so we need to apply the default values here.
+        */
+        if (args.ignorePatternFiles === undefined) {
+          args.ignorePatternFiles = args["ignore-pattern-files"] =
+            ignoreFilesDefault;
+        }
+
+        if (args.ignore === false) {
+          args.ignorePatternFiles = args["ignore-pattern-files"] = [];
+        }
+
+        if (args.ignore === undefined) {
+          args.ignore = true;
+        }
+      },
     )
     .version(
       // Workaround for https://github.com/yargs/yargs/issues/1934
@@ -110,7 +148,7 @@ function parseArgs(argv, config, documentFormats, outputFormats) {
       alias: "c",
       array: true,
       describe:
-        "Local path or URL of custom catalogs to use prior to schemastore.org",
+        "A list of local paths or URLs of custom catalogs to use prior to schemastore.org",
     })
     .conflicts("schema", "catalogs")
     .option("ignore-errors", {
@@ -121,6 +159,17 @@ function parseArgs(argv, config, documentFormats, outputFormats) {
         "means a non-zero exit code is only issued if validation could be " +
         "completed successfully and one or more files were invalid",
     })
+    .option("ignore-pattern-files", {
+      type: "string",
+      array: true,
+      describe: "A list of files containing glob patterns to ignore",
+      ...ignoreFilesOpts,
+    })
+    .option("no-ignore", {
+      type: "boolean",
+      describe: "Disable all ignore files",
+    })
+    .conflicts("ignore-pattern-files", "no-ignore")
     .option("cache-ttl", {
       type: "number",
       default: 600,

package/src/cache.js

@@ -3,26 +3,14 @@ import logger from "./logger.js";
 import { parseSchema } from "./parser.js";
 
 class Cache {
-  constructor(flatCache, ttl) {
+  constructor(flatCache) {
     this.cache = flatCache;
-    this.ttl = ttl;
+    this.ttl = this.cache._cache.ttl || 0;
     this.callCounter = {};
     this.callLimit = 10;
-  }
-
-  expire() {
-    Object.entries(this.cache.all()).forEach(
-      function ([url, cachedResponse]) {
-        if (!("timestamp" in cachedResponse) || !("body" in cachedResponse)) {
-          logger.debug(`Cache error: deleting malformed response`);
-          this.cache.removeKey(url);
-        } else if (Date.now() > cachedResponse.timestamp + this.ttl) {
-          logger.debug(`Cache stale: deleting cached response from ${url}`);
-          this.cache.removeKey(url);
-        }
-        this.cache.save(true);
-      }.bind(this),
-    );
+    if (this.ttl === 0) {
+      this.cache.clear();
+    }
   }
 
   limitDepth(url) {
@@ -51,7 +39,6 @@ class Cache {
 
   async fetch(url) {
     this.limitDepth(url);
-    this.expire();
     const cachedResponse = this.cache.getKey(url);
     if (cachedResponse !== undefined) {
       logger.debug(`Cache hit: using cached response from ${url}`);
@@ -63,7 +50,7 @@ class Cache {
       const resp = await got(url);
       const parsedBody = parseSchema(resp.body, url);
       if (this.ttl > 0) {
-        this.cache.setKey(url, { timestamp: Date.now(), body: parsedBody });
+        this.cache.setKey(url, { body: parsedBody });
         this.cache.save(true);
       }
       return parsedBody;

package/src/cli.js

@@ -1,13 +1,13 @@
 import fs from "node:fs";
 import os from "node:os";
 import path from "node:path";
-import flatCache from "flat-cache";
+import { FlatCache } from "flat-cache";
 import isUrl from "is-url";
 import { validate } from "./ajv.js";
 import { bootstrap } from "./bootstrap.js";
 import { Cache } from "./cache.js";
 import { getCatalogs, getMatchForFilename } from "./catalogs.js";
-import { getFiles } from "./glob.js";
+import { getFiles, NotFound } from "./glob.js";
 import { getFromUrlOrFile } from "./io.js";
 import logger from "./logger.js";
 import { getDocumentLocation } from "./output-formatters.js";
@@ -27,11 +27,15 @@ function secondsToMilliseconds(seconds) {
   return seconds * 1000;
 }
 
-function getFlatCache() {
+function getFlatCache(ttl) {
+  let cache;
   if (process.env.V8R_CACHE_NAME) {
-    return flatCache.load(process.env.V8R_CACHE_NAME);
+    cache = new FlatCache({ cacheId: process.env.V8R_CACHE_NAME, ttl: ttl });
+  } else {
+    cache = new FlatCache({ cacheId: "v8rv2", cacheDir: CACHE_DIR, ttl: ttl });
   }
-  return flatCache.load("v8r", CACHE_DIR);
+  cache.load();
+  return cache;
 }
 
 async function validateDocument(
@@ -166,21 +170,18 @@ function resultsToStatusCode(results, ignoreErrors) {
 function Validator() {
   return async function (config, plugins) {
     let filenames = [];
-    for (const pattern of config.patterns) {
-      const matches = await getFiles(pattern);
-      if (matches.length === 0) {
-        logger.error(`Pattern '${pattern}' did not match any files`);
+    try {
+      filenames = await getFiles(config.patterns, config.ignorePatternFiles);
+    } catch (e) {
+      if (e instanceof NotFound) {
+        logger.error(e.message);
         return EXIT.NOT_FOUND;
       }
-      filenames = filenames.concat(matches);
+      throw e;
     }
 
-    // de-dupe and sort
-    filenames = [...new Set(filenames)];
-    filenames.sort((a, b) => a.localeCompare(b));
-
     const ttl = secondsToMilliseconds(config.cacheTtl || 0);
-    const cache = new Cache(getFlatCache(), ttl);
+    const cache = new Cache(getFlatCache(ttl));
 
     let results = [];
     for (const filename of filenames) {

package/src/glob.js

@@ -1,13 +1,90 @@
+import fs from "node:fs";
+import path from "node:path";
 import { glob } from "glob";
+import ignore from "ignore";
 import logger from "./logger.js";
 
-async function getFiles(pattern) {
+class NotFound extends Error {}
+
+async function getMatches(pattern) {
   try {
-    return await glob(pattern, { dot: true, dotRelative: true });
+    return await glob(pattern, { dot: true });
   } catch (e) {
     logger.error(e.message);
     return [];
   }
 }
 
-export { getFiles };
+async function exists(path) {
+  try {
+    await fs.promises.access(path);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+async function filterIgnores(filenames, ignorePatterns) {
+  const ig = ignore();
+  for (const patterns of ignorePatterns) {
+    ig.add(patterns);
+  }
+  return ig.filter(filenames);
+}
+
+async function readIgnoreFiles(filenames) {
+  let content = [];
+  for (const filename of filenames) {
+    const abspath = path.join(process.cwd(), filename);
+    if (await exists(abspath)) {
+      content.push(await fs.promises.readFile(abspath, "utf8"));
+    }
+  }
+  return content;
+}
+
+function getSeparator() {
+  return process.platform == "win32" ? "\\" : "/";
+}
+
+async function getFiles(patterns, ignorePatternFiles) {
+  let filenames = [];
+
+  // find all the files matching input globs
+  for (const pattern of patterns) {
+    const matches = await getMatches(pattern);
+    if (matches.length === 0) {
+      throw new NotFound(`Pattern '${pattern}' did not match any files`);
+    }
+    filenames = filenames.concat(matches);
+  }
+
+  // de-dupe
+  filenames = [...new Set(filenames)];
+
+  // process ignores
+  const ignorePatterns = await readIgnoreFiles(ignorePatternFiles);
+  let filteredFilenames = await filterIgnores(filenames, ignorePatterns);
+
+  const diff = filenames.filter((x) => filteredFilenames.indexOf(x) < 0);
+  if (diff.length > 0) {
+    logger.debug(
+      `Ignoring file(s):\n    ${diff.join("\n    ")}\nbased on ignore patterns in\n    ${ignorePatternFiles.join("\n    ")}`,
+    );
+  }
+
+  // finally, sort
+  filteredFilenames.sort((a, b) => a.localeCompare(b));
+
+  if (filteredFilenames.length === 0) {
+    throw new NotFound(`Could not find any files to validate`);
+  }
+
+  const sep = getSeparator();
+  filteredFilenames = filteredFilenames.map((fn) =>
+    !fn.startsWith(".." + sep) ? "." + sep + fn : fn,
+  );
+  return filteredFilenames;
+}
+
+export { getFiles, NotFound };

package/src/output-formatters.js

@@ -9,8 +9,25 @@ function getDocumentLocation(result) {
 
 function formatErrors(location, errors) {
   const ajv = new Ajv();
+  let formattedErrors = [];
+
+  if (errors) {
+    formattedErrors = errors.map(function (error) {
+      if (
+        error.keyword === "additionalProperties" &&
+        typeof error.params.additionalProperty === "string"
+      ) {
+        return {
+          ...error,
+          message: `${error.message}, found additional property '${error.params.additionalProperty}'`,
+        };
+      }
+      return error;
+    });
+  }
+
   return (
-    ajv.errorsText(errors, {
+    ajv.errorsText(formattedErrors, {
       separator: "\n",
       dataVar: location + "#",
     }) + "\n"

package/src/plugins.js

@@ -37,10 +37,9 @@ class BasePlugin {
    *
    * @param {string} contents - The unparsed file content.
    * @param {string} fileLocation - The file path. Filenames are resolved and
-   *   normalised by [glob](https://www.npmjs.com/package/glob) using the
-   *   `dotRelative` option. This means relative paths in the current directory
-   *   will be prefixed with `./` (or `.\` on Windows) even if this was not
-   *   present in the input filename or pattern.
+   *   normalised using dot-relative notation. This means relative paths in the
+   *   current directory will be prefixed with `./` (or `.\` on Windows) even if
+   *   this was not present in the input filename or pattern.
    * @param {string | undefined} parser - If the user has specified a parser to
    *   use for this file in a custom schema, this will be passed to
    *   `parseInputFile` in the `parser` param.
@@ -77,10 +76,9 @@ class BasePlugin {
    * @param {ValidationResult} result - Result of attempting to validate this
    *   document.
    * @param {string} fileLocation - The document file path. Filenames are
-   *   resolved and normalised by [glob](https://www.npmjs.com/package/glob)
-   *   using the `dotRelative` option. This means relative paths in the current
-   *   directory will be prefixed with `./` (or `.\` on Windows) even if this
-   *   was not present in the input filename or pattern.
+   *   resolved and normalised using dot-relative notation. This means relative
+   *   paths in the current directory will be prefixed with `./` (or `.\` on
+   *   Windows) even if this was not present in the input filename or pattern.
    * @param {string} format - The user's requested output format as specified in
    *   the config file or via the `--format` command line argument.
    * @returns {string | undefined} Log message
@@ -201,11 +199,10 @@ async function loadAllPlugins(userPlugins) {
 /**
  * @typedef {object} ValidationResult
  * @property {string} fileLocation - Path of the document that was validated.
- *   Filenames are resolved and normalised by
- *   [glob](https://www.npmjs.com/package/glob) using the `dotRelative` option.
- *   This means relative paths in the current directory will be prefixed with
- *   `./` (or `.\` on Windows) even if this was not present in the input
- *   filename or pattern.
+ *   Filenames are resolved and normalised using dot-relative notation. This
+ *   means relative paths in the current directory will be prefixed with `./`
+ *   (or `.\` on Windows) even if this was not present in the input filename or
+ *   pattern.
  * @property {number | null} documentIndex - Some file formats allow multiple
  *   documents to be embedded in one file (e.g:
  *   [yaml](https://www.yaml.info/learn/document.html)). In these cases,

package/src/test-helpers.js

@@ -1,4 +1,4 @@
-import flatCache from "flat-cache";
+import { clearCacheById } from "flat-cache";
 import logger from "./logger.js";
 
 const origWriteOut = logger.writeOut;
@@ -7,7 +7,7 @@ const testCacheName = process.env.V8R_CACHE_NAME;
 const env = process.env;
 
 function setUp() {
-  flatCache.clearCacheById(testCacheName);
+  clearCacheById(testCacheName);
   logger.resetStdout();
   logger.resetStderr();
   logger.writeOut = function () {};
@@ -16,7 +16,7 @@ function setUp() {
 }
 
 function tearDown() {
-  flatCache.clearCacheById(testCacheName);
+  clearCacheById(testCacheName);
   logger.resetStdout();
   logger.resetStderr();
   logger.writeOut = origWriteOut;