v8r
v8r checks the validity of JSON/YAML files if they have a matching schema defined on schemastore.org
v8r documentation
- Version in MegaLinter: 2.1.0
- Visit Official Web Site
- See Index of problems detected by v8r
Configuration in MegaLinter
- Enable v8r by adding
YAML_V8R
in ENABLE_LINTERS variable - Disable v8r by adding
YAML_V8R
in DISABLE_LINTERS variable
Variable | Description | Default value |
---|---|---|
YAML_V8R_ARGUMENTS | User custom arguments to add in linter CLI call Ex: -s --foo "bar" |
|
YAML_V8R_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter Ex: -s --foo "bar" |
|
YAML_V8R_FILTER_REGEX_INCLUDE | Custom regex including filter Ex: (src\|lib) |
Include every file |
YAML_V8R_FILTER_REGEX_EXCLUDE | Custom regex excluding filter Ex: (test\|examples) |
Exclude no file |
YAML_V8R_CLI_LINT_MODE | Override default CLI lint mode - file : Calls the linter for each file- list_of_files : Call the linter with the list of files as argument- project : Call the linter from the root of the project |
list_of_files |
YAML_V8R_FILE_EXTENSIONS | Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all filesEx: [".py", ""] |
[".yml", ".yaml"] |
YAML_V8R_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: ["Dockerfile(-.+)?", "Jenkinsfile"] |
Include every file |
YAML_V8R_PRE_COMMANDS | List of bash commands to run before the linter | None |
YAML_V8R_POST_COMMANDS | List of bash commands to run after the linter | None |
YAML_V8R_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling YAML_V8R and its pre/post commands | None |
YAML_V8R_CONFIG_FILE | v8r configuration file nameUse LINTER_DEFAULT to let the linter find it |
.v8rrc.yml |
YAML_V8R_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules |
YAML_V8R_DISABLE_ERRORS | Run linter but consider errors as warnings | false |
YAML_V8R_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | 0 |
YAML_V8R_CLI_EXECUTABLE | Override CLI executable | ['v8r'] |
IDE Integration
Use v8r in your favorite IDE to catch errors before MegaLinter !
IDE | Extension Name | Install | |
---|---|---|---|
Eclipse | native support | Visit Web Site | |
IDEA | native support | Visit Web Site | |
vim | vison | Visit Web Site | |
Visual Studio Code | native support | Visit Web Site |
MegaLinter Flavours
This linter is available in the following flavours
Flavor | Description | Embedded linters | Info | |
---|---|---|---|---|
![]() |
all | Default MegaLinter Flavor | 118 | |
c_cpp | Optimized for pure C/C++ projects | 53 | ||
ci_light | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 22 | ||
cupcake | MegaLinter for the most commonly used languages | 85 | ||
documentation | MegaLinter for documentation projects | 51 | ||
dotnet | Optimized for C, C++, C# or VB based projects | 63 | ||
dotnetweb | Optimized for C, C++, C# or VB based projects with JS/TS | 72 | ||
go | Optimized for GO based projects | 53 | ||
java | Optimized for JAVA based projects | 55 | ||
javascript | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 60 | ||
php | Optimized for PHP based projects | 54 | ||
python | Optimized for PYTHON based projects | 62 | ||
ruby | Optimized for RUBY based projects | 51 | ||
rust | Optimized for RUST based projects | 51 | ||
salesforce | Optimized for Salesforce based projects | 55 | ||
swift | Optimized for SWIFT based projects | 51 | ||
terraform | Optimized for TERRAFORM based projects | 55 |
Behind the scenes
How are identified applicable files
- File extensions:
.yml
,.yaml
How the linting is performed
- v8r is called once with the list of files as arguments (
list_of_files
CLI lint mode)
Example calls
v8r --ignore-errors myfile.yml
v8r --ignore-errors myfile.yaml
Help content
ℹ No config file found
v8r <patterns..>
Validate local json/yaml files against schema(s)
Positionals:
patterns One or more filenames or glob patterns describing local file or file
s to validate
Options:
--help Show help [boolean]
--version Show version number [boolean]
-v, --verbose Run with verbose logging. Can be stacked e.g: -vv -vvv
[count]
-s, --schema Local path or URL of a schema to validate against. If not
supplied, we will attempt to find an appropriate schema
on schemastore.org using the filename. If passed with glo
b pattern(s) matching multiple files, all matching files
will be validated against this schema [string]
-c, --catalogs Local path or URL of custom catalogs to use prior to sche
mastore.org [array]
--ignore-errors Exit with code 0 even if an error was encountered. Passin
g this flag means a non-zero exit code is only issued if
validation could be completed successfully and one or mor
e files were invalid [boolean] [default: false]
--cache-ttl Remove cached HTTP responses older than <cache-ttl> secon
ds old. Passing 0 clears and disables cache completely
[number] [default: 600]
--format Output format for validation results
[string] [choices: "text", "json"] [default: "text"]
Examples:
v8r file.json Validate a single file
v8r file1.json file2.json Validate multiple files
v8r 'dir/*.yml' 'dir/*.yaml' Specify files to validate with glob patterns
Installation on mega-linter Docker image
- NPM packages (node.js):