v8r 4.3.0 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+## 📦 [5.0.0](https://www.npmjs.com/package/v8r/v/5.0.0) - 2025-05-10
+
+Following on from the deprecations in version 4.4.0,
+version 5.0.0 contains a number of breaking changes:
+
+* The `--format` CLI argument and `format` config file key have been removed.
+  Switch to using `--output-format` and `outputFormat`.
+* v8r now ignores patterns in `.gitignore` by default.
+* The `fileLocation` argument of `getSingleResultLogMessage` has been removed.
+  The signature is now `getSingleResultLogMessage(result, format)`.
+  Plugins implementing the `getSingleResultLogMessage` hook will need to to update
+  the signature.
+  If you are using `fileLocation` in the `getSingleResultLogMessage` function body,
+  switch to using `result.fileLocation`.
+* File paths are no longer passed to plugins in dot-relative notation.
+  Plugins implementing the `getSingleResultLogMessage`, `getAllResultsLogMessage` and `parseInputFile`
+  plugin hooks may need to be updated.
+* The minimum compatible node version is now Node 20.
+
+Other changes in this release:
+
+* v8r is now tested on node 24
+* Upgrade to latest major versions of core packages (got, glob, minimatch, etc)
+
+## 📦 [4.4.0](https://www.npmjs.com/package/v8r/v/4.4.0) - 2025-04-26
+
+Version 4.4.0 is a deprecation release. This release adds deprecation warnings for
+upcoming breaking changes that will be made in version 5.0
+
+* This release adds the `--output-format` CLI argument and `outputFormat` config file key.
+  In v8r 4.4.0 `--format` and `format` can still be used as aliases.
+  In version 5 `--format` and `format` will be removed.
+  It is recommended to switch to using `--output-format` and `outputFormat` now.
+* Starting from v8r version 5, v8r will ignore patterns in `.gitignore` by default.
+* In v8r version 5 the `fileLocation` argument of `getSingleResultLogMessage` will be removed.
+  The signature will become `getSingleResultLogMessage(result, format)`.
+  Plugins implementing the `getSingleResultLogMessage` plugin hook will need to to update
+  the signature to be compatible with version 5.
+  If you are using `fileLocation` in the `getSingleResultLogMessage` function body,
+  switch to using `result.fileLocation`.
+* Starting from v8r version 5 file paths will no longer be passed to plugins in dot-relative notation.
+  Plugins implementing the `getSingleResultLogMessage`, `getAllResultsLogMessage` and `parseInputFile`
+  plugin hooks may need to be updated.
+
 ## 📦 [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.

package/config-schema.json

@@ -57,7 +57,7 @@
         }
       }
     },
-    "format": {
+    "outputFormat": {
       "description": "Output format for validation results. 'text' and 'json' are always valid. Plugins may define additional values which are valid here.",
       "type": "string"
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "v8r",
-  "version": "4.3.0",
+  "version": "5.0.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\"",
@@ -34,14 +34,14 @@
     "cosmiconfig": "^9.0.0",
     "decamelize": "^6.0.0",
     "flat-cache": "^6.1.4",
-    "glob": "^10.1.0",
+    "glob": "^11.0.0",
     "global-agent": "^3.0.0",
-    "got": "^13.0.0",
+    "got": "^14.0.0",
     "ignore": "^7.0.0",
     "is-url": "^1.2.4",
     "js-yaml": "^4.0.0",
     "json5": "^2.2.0",
-    "minimatch": "^9.0.0",
+    "minimatch": "^10.0.0",
     "smol-toml": "^1.0.1",
     "yargs": "^17.0.1"
   },
@@ -50,7 +50,7 @@
     "eslint": "^9.9.0",
     "eslint-config-prettier": "^10.1.2",
     "eslint-plugin-jsdoc": "^50.2.2",
-    "eslint-plugin-mocha": "^10.0.3",
+    "eslint-plugin-mocha": "^11.0.0",
     "eslint-plugin-prettier": "^5.0.0",
     "mocha": "^11.0.1",
     "mock-cwd": "^1.0.0",
@@ -59,7 +59,7 @@
     "prettier-plugin-jsdoc": "^1.3.0"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "type": "module",
   "keywords": [

package/src/bootstrap.js

@@ -79,7 +79,7 @@ function parseArgs(argv, config, documentFormats, outputFormats) {
   const ignoreFilesOpts = {
     describe: "A list of files containing glob patterns to ignore",
   };
-  let ignoreFilesDefault = [".v8rignore"];
+  let ignoreFilesDefault = [".v8rignore", ".gitignore"];
   ignoreFilesOpts.defaultDescription = `${JSON.stringify(ignoreFilesDefault)}`;
   if (Object.keys(config.config).includes("ignorePatternFiles")) {
     ignoreFilesDefault = config.config.ignorePatternFiles;
@@ -177,7 +177,7 @@ function parseArgs(argv, config, documentFormats, outputFormats) {
         "Remove cached HTTP responses older than <cache-ttl> seconds old. " +
         "Passing 0 clears and disables cache completely",
     })
-    .option("format", {
+    .option("output-format", {
       type: "string",
       choices: outputFormats,
       default: "text",
@@ -193,7 +193,7 @@ function parseArgs(argv, config, documentFormats, outputFormats) {
     ]);
 
   for (const [key, value] of Object.entries(config.config)) {
-    if (["cacheTtl", "format", "ignoreErrors", "verbose"].includes(key)) {
+    if (["cacheTtl", "outputFormat", "ignoreErrors", "verbose"].includes(key)) {
       parser.default(
         decamelize(key, { separator: "-" }),
         value,

package/src/cli.js

@@ -144,8 +144,7 @@ async function validateFile(filename, config, plugins, cache) {
     for (const plugin of plugins) {
       const message = plugin.getSingleResultLogMessage(
         result,
-        filename,
-        config.format,
+        config.outputFormat,
       );
       if (message != null) {
         logger.log(message);
@@ -191,7 +190,10 @@ function Validator() {
     }
 
     for (const plugin of plugins) {
-      const message = plugin.getAllResultsLogMessage(results, config.format);
+      const message = plugin.getAllResultsLogMessage(
+        results,
+        config.outputFormat,
+      );
       if (message != null) {
         logger.log(message);
         break;

package/src/glob.js

@@ -43,10 +43,6 @@ async function readIgnoreFiles(filenames) {
   return content;
 }
 
-function getSeparator() {
-  return process.platform == "win32" ? "\\" : "/";
-}
-
 async function getFiles(patterns, ignorePatternFiles) {
   let filenames = [];
 
@@ -80,10 +76,6 @@ async function getFiles(patterns, ignorePatternFiles) {
     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;
 }
 

package/src/logger.js

@@ -47,6 +47,12 @@ class Logger {
     this.writeErr(formatedMessage);
   }
 
+  warning(message) {
+    const formatedMessage = chalk.yellow.bold("▲ ") + message;
+    this.stderr.push(formatedMessage);
+    this.writeErr(formatedMessage);
+  }
+
   error(message) {
     const formatedMessage = chalk.red.bold("✖ ") + message;
     this.stderr.push(formatedMessage);

package/src/plugins/output-text.js

@@ -8,7 +8,7 @@ class TextOutput extends BasePlugin {
     return ["text"];
   }
 
-  getSingleResultLogMessage(result, fileLocation, format) {
+  getSingleResultLogMessage(result, format) {
     if (result.valid === false && format === "text") {
       return formatErrors(getDocumentLocation(result), result.errors);
     }

package/src/plugins.js

@@ -36,10 +36,7 @@ class BasePlugin {
    * Document object or an array of Document objects.
    *
    * @param {string} contents - The unparsed file content.
-   * @param {string} fileLocation - The file path. 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.
+   * @param {string} fileLocation - The file path.
    * @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.
@@ -53,8 +50,8 @@ class BasePlugin {
   /**
    * Use the `registerOutputFormats` hook to tell v8r about additional output
    * formats that can be generated. Any formats registered with this hook become
-   * valid values for the `format` property in the config file and the
-   * `--format` command line argument.
+   * valid values for the `outputFormat` property in the config file and the
+   * `--output-format` command line argument.
    *
    * @returns {string[]} Output formats to register
    */
@@ -75,16 +72,12 @@ class BasePlugin {
    *
    * @param {ValidationResult} result - Result of attempting to validate this
    *   document.
-   * @param {string} fileLocation - The document file path. 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.
    * @param {string} format - The user's requested output format as specified in
-   *   the config file or via the `--format` command line argument.
+   *   the config file or via the `--output-format` command line argument.
    * @returns {string | undefined} Log message
    */
   // eslint-disable-next-line no-unused-vars
-  getSingleResultLogMessage(result, fileLocation, format) {
+  getSingleResultLogMessage(result, format) {
     return undefined;
   }
 
@@ -102,7 +95,7 @@ class BasePlugin {
    * @param {ValidationResult[]} results - Results of attempting to validate
    *   these documents.
    * @param {string} format - The user's requested output format as specified in
-   *   the config file or via the `--format` command line argument.
+   *   the config file or via the `--output-format` command line argument.
    * @returns {string | undefined} Log message
    */
   // eslint-disable-next-line no-unused-vars
@@ -199,10 +192,6 @@ async function loadAllPlugins(userPlugins) {
 /**
  * @typedef {object} ValidationResult
  * @property {string} fileLocation - Path of the document that was validated.
- *   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,