Skip to content

v8r

GitHub stars GitHub release (latest SemVer) GitHub last commit GitHub commit activity GitHub contributors

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
JSON_V8R_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
JSON_V8R_COMMAND_REMOVE_ARGUMENTS User custom arguments to remove from command line before calling the linter
Ex: -s --foo "bar"
JSON_V8R_FILTER_REGEX_INCLUDE Custom regex including filter
Ex: (src\|lib)
Include every file
JSON_V8R_FILTER_REGEX_EXCLUDE Custom regex excluding filter
Ex: (test\|examples)
Exclude no file
JSON_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
JSON_V8R_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".py", ""]
[".json"]
JSON_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
JSON_V8R_PRE_COMMANDS List of bash commands to run before the linter None
JSON_V8R_POST_COMMANDS List of bash commands to run after the linter None
JSON_V8R_UNSECURED_ENV_VARIABLES List of env variables explicitly not filtered before calling JSON_V8R and its pre/post commands None
JSON_V8R_DISABLE_ERRORS Run linter but consider errors as warnings false
JSON_V8R_DISABLE_ERRORS_IF_LESS_THAN Maximum number of errors allowed 0
JSON_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 117 Docker Image Size (tag) Docker Pulls
ci_light Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML 22 Docker Image Size (tag) Docker Pulls
cupcake MegaLinter for the most commonly used languages 85 Docker Image Size (tag) Docker Pulls
documentation MegaLinter for documentation projects 51 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 63 Docker Image Size (tag) Docker Pulls
dotnetweb Optimized for C, C++, C# or VB based projects with JS/TS 72 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 53 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 55 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 60 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 54 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 62 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 51 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 51 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 54 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 51 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 55 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .json

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

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):