Changelog
📦 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:
--format
CLI argument and format
config file key have been removed.
Switch to using --output-format
and outputFormat
..gitignore
by default.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
.getSingleResultLogMessage
, getAllResultsLogMessage
and parseInputFile
plugin hooks may need to be updated.Other changes in this release:
Changelog
📦 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
--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..gitignore
by default.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
.getSingleResultLogMessage
, getAllResultsLogMessage
and parseInputFile
plugin hooks may need to be updated.Changelog
📦 4.3.0 - 2025-04-21
.v8rignore
by default.
More info: https://chris48s.github.io/v8r/ignoring-files/additionalProperty
log message.$schema
key.Changelog
📦 4.1.0 - 2024-08-25
parseInputFile()
plugin hook may now conditionally return an array of Document
objectsValidationResult
object now contains a documentIndex
property.
This identifies the document when a multi-doc file has been validated.Changelog
📦 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:
{
"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:
{
"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