Skip to content

v8r

v8r checks the validity of JSON/YAML files if they have a matching schema defined on schemastore.org

v8r documentation

v8r - GitHub

Configuration in MegaLinter

Variable Description Default value
YAML_V8R_ARGUMENTS User custom arguments to add in linter CLI call
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
file
YAML_V8R_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".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_DISABLE_ERRORS Run linter but consider errors as warnings false
YAML_V8R_DISABLE_ERRORS_IF_LESS_THAN Maximum number of errors allowed 0

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 97 Docker Image Size (tag) Docker Pulls
ci_light Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML 16 Docker Image Size (tag) Docker Pulls
dart Optimized for DART based projects 42 Docker Image Size (tag) Docker Pulls
documentation MegaLinter for documentation projects 41 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 49 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 43 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 43 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 50 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 46 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 49 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 42 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 42 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 44 Docker Image Size (tag) Docker Pulls
scala Optimized for SCALA based projects 42 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 42 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 47 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .yml, .yaml

How the linting is performed

  • v8r is called one time by identified file

Example calls

v8r --ignore-errors myfile.yml
v8r --ignore-errors myfile.yaml

Help content

v8r <filename>

Validate a local json/yaml file against a schema

Positionals:
  filename  Local file 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 schema to validate file against. If
                       not supplied, we will attempt to find an appropriate
                       schema on schemastore.org using the filename     [string]
  -c, --catalogs       Local path or URL of custom catalogs to use prior to
                       schemastore.org                                   [array]
      --ignore-errors  Exit with code 0 even if an error was encountered.
                       Passing this flag means a non-zero exit code is only
                       issued if validation could be completed successfully and
                       the file was invalid           [boolean] [default: false]
      --cache-ttl      Remove cached HTTP responses older than <cache-ttl>
                       seconds old. Passing 0 clears and disables cache
                       completely                        [number] [default: 600]

Installation on mega-linter Docker image