# 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.
  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.
  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 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.

## 📦 [4.0.1](https://www.npmjs.com/package/v8r/v/4.0.1) - 2024-08-19

* De-duplicate and sort files before validating

## 📦 [4.0.0](https://www.npmjs.com/package/v8r/v/4.0.0) - 2024-08-19

* **Breaking:** Change to the JSON output format. The `results` key is now an array instead of an object.
  In v8r <4, `results` was an object mapping filename to result object. For example:
  ```json
  {
    "results": {
      "./package.json": {
        "fileLocation": "./package.json",
        "schemaLocation": "https://json.schemastore.org/package.json",
        "valid": true,
        "errors": [],
        "code": 0
      }
    }
  }
  ```

  In v8r >=4 `results` is now an array of result objects. For example:
  ```json
  {
    "results": [
      {
        "fileLocation": "./package.json",
        "schemaLocation": "https://json.schemastore.org/package.json",
        "valid": true,
        "errors": [],
        "code": 0
      }
    ]
  }
  ```
* Plugin system: It is now possible to extend the functionality of v8r by using or writing plugins. See https://chris48s.github.io/v8r/category/plugins/ for further information
* Documentation improvements

## 📦 [3.1.1](https://www.npmjs.com/package/v8r/v/3.1.1) - 2024-08-03

* Allow 'toml' as an allowed value for parser in custom catalog

## 📦 [3.1.0](https://www.npmjs.com/package/v8r/v/3.1.0) - 2024-06-03

* Add ability to configure a proxy using global-agent

## 📦 [3.0.0](https://www.npmjs.com/package/v8r/v/3.0.0) - 2024-01-25

* **Breaking:** Drop compatibility with node 16
* Add ability to validate Toml documents

## 📦 [2.1.0](https://www.npmjs.com/package/v8r/v/2.1.0) - 2023-10-23

* Add compatibility with JSON schemas serialized as Yaml

## 📦 [2.0.0](https://www.npmjs.com/package/v8r/v/2.0.0) - 2023-05-02

* **Breaking:** Drop compatibility with node 14
* Upgrade glob and minimatch to latest versions
* Tested on node 20

## 📦 [1.0.0](https://www.npmjs.com/package/v8r/v/1.0.0) - 2023-03-12

Version 1.0.0 contains no new features and no bug fixes.
The one change in this release is that the project now publishes a
[SemVer compatibility statement](https://github.com/chris48s/v8r/blob/main/README.md#versioning).

## 📦 [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.

## 📦 [0.12.0](https://www.npmjs.com/package/v8r/v/0.12.0) - 2022-05-07

* Add config file. See https://github.com/chris48s/v8r/blob/main/README.md#configuration for more details.

## 📦 [0.11.1](https://www.npmjs.com/package/v8r/v/0.11.1) - 2022-03-03

* Fix: call minimatch with `{dot: true}`, fixes [#174](https://github.com/chris48s/v8r/issues/174)

## 📦 [0.11.0](https://www.npmjs.com/package/v8r/v/0.11.0) - 2022-02-27

* Drop compatibility with node 12, now requires node `^14.13.1 || >=15.0.0`
* Upgrade to got 12 internally
* Call ajv with `allErrors` flag

## 📦 [0.10.1](https://www.npmjs.com/package/v8r/v/0.10.1) - 2022-01-06

* Fix `--version` flag when installed globally in some environments

## 📦 [0.10.0](https://www.npmjs.com/package/v8r/v/0.10.0) - 2022-01-03

* Accept multiple filenames or globs as positional args. e.g:
  ```bash
  v8r file1.json file2.json 'dir/*.yaml'
  ```

## 📦 [0.9.0](https://www.npmjs.com/package/v8r/v/0.9.0) - 2021-12-27

* Accept glob pattern instead of filename. It is now possible to validate multiple files at once. e.g:
  ```bash
  v8r '{file1.json,file2.json}'
  v8r 'files/*'
  ```
* Improvements to terminal output styling
* `.jsonc` and `.json5` files can now be validated

## 📦 [0.8.1](https://www.npmjs.com/package/v8r/v/0.8.1) - 2021-12-25

* Fix `--version` flag when installed globally

## 📦 [0.8.0](https://www.npmjs.com/package/v8r/v/0.8.0) - 2021-12-25

* Switch from CommonJS to ESModules internally
* Requires node `^12.20.0 || ^14.13.1 || >=15.0.0`

## 📦 [0.7.0](https://www.npmjs.com/package/v8r/v/0.7.0) - 2021-11-30

* Upgrade to ajv 8 internally
  Adds compatibility for JSON Schema draft 2019-09 and draft 2020-12
* Docs/logging improvements to clarify behaviour of `--catalogs` param

## 📦 [0.6.1](https://www.npmjs.com/package/v8r/v/0.6.1) - 2021-08-06

* Refactor cache module to remove global state

## 📦 [0.6.0](https://www.npmjs.com/package/v8r/v/0.6.0) - 2021-07-28

* Add the ability to search custom schema catalogs using the `--catalogs` param

## 📦 [0.5.0](https://www.npmjs.com/package/v8r/v/0.5.0) - 2021-01-13

* Allow validation against a local schema
* Move cache file to OS temp dir

## 📦 [0.4.0](https://www.npmjs.com/package/v8r/v/0.4.0) - 2020-12-30

* Resolve external references in schemas

## 📦 [0.3.0](https://www.npmjs.com/package/v8r/v/0.3.0) - 2020-12-29

* Cache HTTP responses locally to improve performance
* Add `--verbose` flag

## 📦 [0.2.0](https://www.npmjs.com/package/v8r/v/0.2.0) - 2020-12-24

* Find schemas using paths and glob patterns
* Add `--ignore-errors` flag

## 📦 [0.1.1](https://www.npmjs.com/package/v8r/v/0.1.1) - 2020-11-08

* Add Documentation
* Recognise `.geojson` and `.jsonld` as JSON files

## 📦 [0.1.0](https://www.npmjs.com/package/v8r/v/0.1.0) - 2020-11-08

* First Release