v8r 4.3.0 → 4.4.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 📦 [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

@@ -3,6 +3,13 @@
   "$schema": "https://json-schema.org/draft/2019-09/schema",
   "type": "object",
   "additionalProperties": false,
+  "allOf": [
+    {
+      "not": {
+        "required": ["format", "outputFormat"]
+      }
+    }
+  ],
   "properties": {
     "cacheTtl": {
       "description": "Remove cached HTTP responses older than cacheTtl seconds old. Specifying 0 clears and disables cache completely",
@@ -57,10 +64,15 @@
         }
       }
     },
-    "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"
     },
+    "format": {
+      "description": "Output format for validation results. 'text' and 'json' are always valid. Plugins may define additional values which are valid here.",
+      "type": "string",
+      "deprecated": true
+    },
     "ignoreErrors": {
       "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"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "v8r",
-  "version": "4.3.0",
+  "version": "4.4.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\"",

package/src/bootstrap.js

@@ -53,6 +53,8 @@ function mergeConfigs(args, config) {
   if (config.filepath) {
     mergedConfig.configFileRelativePath = getRelativeFilePath(config);
   }
+  // https://github.com/chris48s/v8r/issues/494
+  delete mergedConfig.format;
   return mergedConfig;
 }
 
@@ -120,6 +122,13 @@ function parseArgs(argv, config, documentFormats, outputFormats) {
         if (args.ignore === undefined) {
           args.ignore = true;
         }
+
+        // https://github.com/chris48s/v8r/issues/494
+        if (process.argv.includes("--format")) {
+          logger.warning(
+            "In v8r version 5 the --format argument will be removed. Switch to using --output-format",
+          );
+        }
       },
     )
     .version(
@@ -177,11 +186,14 @@ 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",
-      describe: "Output format for validation results",
+      // https://github.com/chris48s/v8r/issues/494
+      describe:
+        "Output format for validation results. The '--format' alias is deprecated.",
+      alias: "format",
     })
     .example([
       ["$0 file.json", "Validate a single file"],
@@ -193,7 +205,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,
@@ -239,6 +251,14 @@ async function bootstrap(argv, config, cosmiconfigOptions = {}) {
   const configFile = await getCosmiConfig(cosmiconfigOptions);
   validateConfigAgainstSchema(configFile);
 
+  // https://github.com/chris48s/v8r/issues/494
+  if (configFile.config.format) {
+    logger.warning(
+      "In v8r version 5 the 'format' config file key will be removed. Switch to using 'outputFormat'",
+    );
+    configFile.config.outputFormat = configFile.config.format;
+  }
+
   // load both core and user plugins
   let plugins = resolveUserPlugins(configFile.config.plugins || []);
   const { allLoadedPlugins, loadedCorePlugins, loadedUserPlugins } =
@@ -254,6 +274,11 @@ async function bootstrap(argv, config, cosmiconfigOptions = {}) {
   // parse command line arguments
   const args = parseArgs(argv, configFile, documentFormats, outputFormats);
 
+  // https://github.com/chris48s/v8r/issues/599
+  logger.warning(
+    "Starting from v8r version 5, v8r will ignore patterns in .gitignore by default.",
+  );
+
   return {
     config: mergeConfigs(args, configFile),
     allLoadedPlugins,

package/src/cli.js

@@ -145,7 +145,7 @@ async function validateFile(filename, config, plugins, cache) {
       const message = plugin.getSingleResultLogMessage(
         result,
         filename,
-        config.format,
+        config.outputFormat,
       );
       if (message != null) {
         logger.log(message);
@@ -191,7 +191,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/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.js

@@ -1,4 +1,5 @@
 import path from "node:path";
+import logger from "./logger.js";
 
 /**
  * Base class for all v8r plugins.
@@ -53,8 +54,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
    */
@@ -80,7 +81,7 @@ class BasePlugin {
    *   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
@@ -102,7 +103,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
@@ -123,7 +124,11 @@ class Document {
   }
 }
 
-function validatePlugin(plugin) {
+function hasProperty(plugin, prop) {
+  return Object.prototype.hasOwnProperty.call(plugin.prototype, prop);
+}
+
+function validatePlugin(plugin, warnings) {
   if (
     typeof plugin.name !== "string" ||
     !plugin.name.startsWith("v8r-plugin-")
@@ -150,6 +155,29 @@ function validatePlugin(plugin) {
       );
     }
   }
+
+  if (warnings === true) {
+    // https://github.com/chris48s/v8r/issues/500
+    if (hasProperty(plugin, "getSingleResultLogMessage")) {
+      logger.warning(
+        "In v8r version 5 the fileLocation argument of getSingleResultLogMessage will be removed.\n" +
+          "  The signature will become getSingleResultLogMessage(result, format).\n" +
+          `  ${plugin.name} will need to be updated`,
+      );
+    }
+
+    // https://github.com/chris48s/v8r/issues/600
+    if (
+      hasProperty(plugin, "getSingleResultLogMessage") ||
+      hasProperty(plugin, "getAllResultsLogMessage") ||
+      hasProperty(plugin, "parseInputFile")
+    ) {
+      logger.warning(
+        "Starting from v8r version 5 file paths will no longer be passed to plugins in dot-relative notation.\n" +
+          `  ${plugin.name} may need to be updated`,
+      );
+    }
+  }
 }
 
 function resolveUserPlugins(userPlugins) {
@@ -165,19 +193,19 @@ function resolveUserPlugins(userPlugins) {
   return plugins;
 }
 
-async function loadPlugins(plugins) {
+async function loadPlugins(plugins, warnings) {
   let loadedPlugins = [];
   for (const plugin of plugins) {
     loadedPlugins.push(await import(plugin));
   }
   loadedPlugins = loadedPlugins.map((plugin) => plugin.default);
-  loadedPlugins.forEach((plugin) => validatePlugin(plugin));
+  loadedPlugins.forEach((plugin) => validatePlugin(plugin, warnings));
   loadedPlugins = loadedPlugins.map((plugin) => new plugin());
   return loadedPlugins;
 }
 
 async function loadAllPlugins(userPlugins) {
-  const loadedUserPlugins = await loadPlugins(userPlugins);
+  const loadedUserPlugins = await loadPlugins(userPlugins, true);
 
   const corePlugins = [
     "./plugins/parser-json.js",
@@ -187,7 +215,7 @@ async function loadAllPlugins(userPlugins) {
     "./plugins/output-text.js",
     "./plugins/output-json.js",
   ];
-  const loadedCorePlugins = await loadPlugins(corePlugins);
+  const loadedCorePlugins = await loadPlugins(corePlugins, false);
 
   return {
     allLoadedPlugins: loadedUserPlugins.concat(loadedCorePlugins),