jsonlint
jsonlint documentation
- Version in Mega-Linter: 1.6.3
- Visit Official Web Site
Configuration in Mega-Linter
- Enable jsonlint by adding
JSON_JSONLINT
in ENABLE_LINTERS variable - Disable jsonlint by adding
JSON_JSONLINT
in DISABLE_LINTERS variable
Variable | Description | Default value |
---|---|---|
JSON_JSONLINT_ARGUMENTS | User custom arguments to add in linter CLI call Ex: -s --foo "bar" |
|
JSON_JSONLINT_FILTER_REGEX_INCLUDE | Custom regex including filter Ex: (src\|lib) |
Include every file |
JSON_JSONLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter Ex: (test\|examples) |
Exclude no file |
JSON_JSONLINT_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 |
{linter.cli_lint_mode} |
JSON_JSONLINT_FILE_EXTENSIONS | Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all filesEx: [".py", ""] |
[".json"] |
JSON_JSONLINT_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_JSONLINT_PRE_COMMANDS | List of bash commands to run before the linter | None |
JSON_JSONLINT_POST_COMMANDS | List of bash commands to run after the linter | None |
JSON_JSONLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | false |
JSON_JSONLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | 0 |
Mega-Linter Flavours
This linter is available in the following flavours
Flavor | Description | Embedded linters | Info | |
---|---|---|---|---|
all | Default Mega-Linter Flavor | 93 | ||
ci_light | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 13 | ||
dart | Optimized for DART based projects | 40 | ||
documentation | Mega-Linter for documentation projects | 39 | ||
dotnet | Optimized for C, C++, C# or VB based projects | 46 | ||
go | Optimized for GO based projects | 41 | ||
java | Optimized for JAVA based projects | 41 | ||
javascript | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 48 | ||
php | Optimized for PHP based projects | 43 | ||
python | Optimized for PYTHON based projects | 48 | ||
ruby | Optimized for RUBY based projects | 40 | ||
rust | Optimized for RUST based projects | 40 | ||
salesforce | Optimized for Salesforce based projects | 42 | ||
scala | Optimized for SCALA based projects | 40 | ||
swift | Optimized for SWIFT based projects | 40 | ||
terraform | Optimized for TERRAFORM based projects | 44 |
Behind the scenes
How are identified applicable files
- File extensions:
.json
How the linting is performed
- jsonlint is called one time by identified file
Example calls
jsonlint myfile.json
Help content
Usage: jsonlint [file] [options]
file file to parse; otherwise uses stdin
Options:
-v, --version print version and exit
-s, --sort-keys sort object keys
-i, --in-place overwrite the file
-t CHAR, --indent CHAR character(s) to use for indentation [ ]
-c, --compact compact error display
-V, --validate a JSON schema to use for validation
-e, --environment which specification of JSON Schema the validation file uses [json-schema-draft-03]
-q, --quiet do not print the parsed json to STDOUT [false]
-p, --pretty-print force pretty printing even if invalid
Installation on mega-linter Docker image
- NPM packages (node.js):
Example success log
Results of jsonlint linter (version 1.6.3)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/json_jsonlint/
-----------------------------------------------
[SUCCESS] .automation/test/json/json_good_1.json
{
"arrow_spacing": {
"level": "ignore"
},
"braces_spacing": {
"level": "ignore",
"spaces": 0,
"empty_object_spaces": 0
}
}
Example error log
Results of jsonlint linter (version 1.6.3)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/json_jsonlint/
-----------------------------------------------
[ERROR] .automation/test/json/json_bad_1.json
Error: Parse error on line 6:
...ng": { "level": 'ignore', "space
----------------------^
Expecting 'STRING', 'NUMBER', 'NULL', 'TRUE', 'FALSE', '{', '[', got 'undefined'
at Object.parseError (/node_modules/jsonlint/lib/jsonlint.js:55:11)
at Object.parse (/node_modules/jsonlint/lib/jsonlint.js:132:22)
at parse (/node_modules/jsonlint/lib/cli.js:82:14)
at main (/node_modules/jsonlint/lib/cli.js:135:14)
at Object.<anonymous> (/node_modules/jsonlint/lib/cli.js:179:1)
at Module._compile (internal/modules/cjs/loader.js:1201:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:1221:10)
at Module.load (internal/modules/cjs/loader.js:1050:32)
at Function.Module._load (internal/modules/cjs/loader.js:938:14)
at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:71:12)