v8r 4.1.0 → 4.2.0

package/CHANGELOG.md

@@ -1,10 +1,16 @@
 # Changelog
 
+## 📦 [4.2.0](https://www.npmjs.com/package/v8r/v/4.2.0) - 2024-10-24
+
+* Add `V8R_CONFIG_FILE` environment variable.
+  This allows loading a config file from a location other than the directory v8r is invoked from.
+  More info: https://chris48s.github.io/v8r/configuration/
+
 ## 📦 [4.1.0](https://www.npmjs.com/package/v8r/v/4.1.0) - 2024-08-25
 
 * v8r can now parse and validate files that contain multiple yaml documents
   More info: https://chris48s.github.io/v8r/usage-examples/#files-containing-multiple-documents
-* The `parseInputFile()` plugin hook may now tionally return an array of `Document` objects
+* The `parseInputFile()` plugin hook may now conditionally return an array of `Document` objects
 * The `ValidationResult` object now contains a `documentIndex` property.
   This identifies the document when a multi-doc file has been validated.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "v8r",
-  "version": "4.1.0",
+  "version": "4.2.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/ajv.js

@@ -1,4 +1,4 @@
-import { createRequire } from "module";
+import { createRequire } from "node:module";
 // TODO: once JSON modules is stable these requires could become imports
 // https://nodejs.org/api/esm.html#esm_experimental_json_modules
 const require = createRequire(import.meta.url);

package/src/bootstrap.js

@@ -1,12 +1,12 @@
-import { createRequire } from "module";
+import { createRequire } from "node:module";
 // TODO: once JSON modules is stable these requires could become imports
 // https://nodejs.org/api/esm.html#esm_experimental_json_modules
 const require = createRequire(import.meta.url);
 
+import fs from "node:fs";
+import path from "node:path";
 import { cosmiconfig } from "cosmiconfig";
 import decamelize from "decamelize";
-import isUrl from "is-url";
-import path from "path";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 import {
@@ -17,27 +17,28 @@ import {
 import logger from "./logger.js";
 import { loadAllPlugins, resolveUserPlugins } from "./plugins.js";
 
-function preProcessConfig(configFile) {
-  if (!configFile?.config?.customCatalog?.schemas) {
-    return;
-  }
-  for (const schema of configFile.config.customCatalog.schemas) {
-    if (!path.isAbsolute(schema.location) && !isUrl(schema.location)) {
-      schema.location = path.join(
-        path.dirname(configFile.filepath),
-        schema.location,
-      );
+async function getCosmiConfig(cosmiconfigOptions) {
+  let configFile;
+
+  if (process.env.V8R_CONFIG_FILE) {
+    if (!fs.existsSync(process.env.V8R_CONFIG_FILE)) {
+      throw new Error(`File ${process.env.V8R_CONFIG_FILE} does not exist.`);
     }
+    configFile = await cosmiconfig("v8r", cosmiconfigOptions).load(
+      process.env.V8R_CONFIG_FILE,
+    );
+  } else {
+    cosmiconfigOptions.stopDir = process.cwd();
+    configFile = (await cosmiconfig("v8r", cosmiconfigOptions).search(
+      process.cwd(),
+    )) || { config: {} };
   }
-}
 
-async function getCosmiConfig(cosmiconfigOptions) {
-  cosmiconfigOptions.stopDir = process.cwd();
-  const configFile = (await cosmiconfig("v8r", cosmiconfigOptions).search(
-    process.cwd(),
-  )) || { config: {} };
   if (configFile.filepath) {
     logger.info(`Loaded config file from ${getRelativeFilePath(configFile)}`);
+    logger.info(
+      `Patterns and relative paths will be resolved relative to current working directory: ${process.cwd()}`,
+    );
   } else {
     logger.info(`No config file found`);
   }
@@ -200,7 +201,6 @@ async function bootstrap(argv, config, cosmiconfigOptions = {}) {
   // we can finish validating and processing the config
   validateConfigDocumentParsers(configFile, documentFormats);
   validateConfigOutputFormats(configFile, outputFormats);
-  preProcessConfig(configFile);
 
   // parse command line arguments
   const args = parseArgs(argv, configFile, documentFormats, outputFormats);
@@ -213,10 +213,4 @@ async function bootstrap(argv, config, cosmiconfigOptions = {}) {
   };
 }
 
-export {
-  bootstrap,
-  getDocumentFormats,
-  getOutputFormats,
-  parseArgs,
-  preProcessConfig,
-};
+export { bootstrap, getDocumentFormats, getOutputFormats, parseArgs };

package/src/catalogs.js

@@ -1,5 +1,5 @@
+import path from "node:path";
 import { minimatch } from "minimatch";
-import path from "path";
 import { validate } from "./ajv.js";
 import { getFromUrlOrFile } from "./io.js";
 import logger from "./logger.js";

package/src/cli.js

@@ -1,7 +1,7 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
 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 { bootstrap } from "./bootstrap.js";

package/src/config-validators.js

@@ -1,4 +1,4 @@
-import { createRequire } from "module";
+import { createRequire } from "node:module";
 // TODO: once JSON modules is stable these requires could become imports
 // https://nodejs.org/api/esm.html#esm_experimental_json_modules
 const require = createRequire(import.meta.url);

package/src/io.js

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import isUrl from "is-url";
 import { parseSchema } from "./parser.js";
 

package/src/parser.js

@@ -1,4 +1,4 @@
-import path from "path";
+import path from "node:path";
 import yaml from "js-yaml";
 import { Document } from "./plugins.js";
 

package/src/plugins.js

@@ -1,4 +1,4 @@
-import path from "path";
+import path from "node:path";
 
 /**
  * Base class for all v8r plugins.

package/src/test-helpers.js

@@ -4,6 +4,7 @@ import logger from "./logger.js";
 const origWriteOut = logger.writeOut;
 const origWriteErr = logger.writeErr;
 const testCacheName = process.env.V8R_CACHE_NAME;
+const env = process.env;
 
 function setUp() {
   flatCache.clearCacheById(testCacheName);
@@ -11,6 +12,7 @@ function setUp() {
   logger.resetStderr();
   logger.writeOut = function () {};
   logger.writeErr = function () {};
+  process.env = { ...env };
 }
 
 function tearDown() {
@@ -19,6 +21,7 @@ function tearDown() {
   logger.resetStderr();
   logger.writeOut = origWriteOut;
   logger.writeErr = origWriteErr;
+  process.env = env;
 }
 
 function isString(el) {