Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files
xet
 Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
megalinter-descriptor.jsonschema.json
cli_config_extra_args
When a configuration file is used with the linter CLI, send these additional arguments
{"default": [], "examples": [["--no-eslintrc", "--no-ignore"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
cli_docker_args
Arguments for docker run before image name
{"default": [], "examples": [["-v", "`pwd`:`pwd`", "-w", "`pwd`"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
cli_docker_image_version
Version of the docker image to use for linting
{"default": "latest", "examples": ["0.42.0_swift-5.3.2"], "type": "string"}
megalinter-descriptor.jsonschema.json
cli_executable
Override if different from linter_name
{"type": "string"}
megalinter-descriptor.jsonschema.json
cli_executable_help
Override if different from cli executable used for linting
{"type": "string"}
megalinter-descriptor.jsonschema.json
cli_executable_version
Override if different from cli executable used for linting
{"type": "string"}
megalinter-descriptor.jsonschema.json
cli_help_extra_args
When linter CLI is call for help, send these additional arguments
{"items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
cli_help_extra_commands
When linter CLI is call for help, send these additional commands
{"items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
cli_lint_errors_count
Defines how to count errors from log file. regex_number, regex_count, regex_sum, or total_lines
{"enum": ["regex_number", "regex_count", "regex_sum", "total_lines", "sarif"], "examples": ["regex_number", "regex_count", "regex_sum", "total_lines"], "type": "string"}
megalinter-descriptor.jsonschema.json
cli_lint_errors_regex
Regex allowing to extract the number of errors from linter output logs
{"examples": ["Issues found: (.*) in .* files"], "type": "string"}
megalinter-descriptor.jsonschema.json
cli_lint_extra_args
When linter CLI is call for linting, send these additional arguments before config args
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
cli_lint_extra_args_after
When linter CLI is call for linting, send these additional arguments after config args
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
cli_lint_fix_remove_args
When linter CLI is call for fixing, remove these arguments
{"default": [], "examples": [["--check"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
cli_lint_ignore_arg_name
If the linter can use an ignore file, input here the related argument
{"examples": ["--secretlintignore", "--ignore-path"], "type": "string"}
megalinter-descriptor.jsonschema.json
cli_lint_mode
Defines how the linter is called: file, list_of_files, project
{"default": "file", "enum": ["file", "project", "list_of_files"], "type": "string"}
megalinter-descriptor.jsonschema.json
cli_sarif_args
Arguments to generate SARIF output
{"default": [], "examples": [["--format", "sarif", "--output", "{{SARIF_OUTPUT_FILE}}"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
cli_version_extra_args
When linter CLI is call for version, send these additional arguments
{"items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
config_file_name
An explanation about the purpose of this instance.
{"examples": [".eslintrc.yml", ".markdown-lint.yml", ".python-black"], "type": "string"}
megalinter-descriptor.jsonschema.json
deprecated
Shows if the linter is deprecated.
{"default": false, "type": "boolean"}
megalinter-descriptor.jsonschema.json
deprecated_description
Displays information on why it is deprecated and whether an alternative is available.
{"default": "", "type": "string"}
megalinter-descriptor.jsonschema.json
descriptor_flavors
MegaLinter flavors matching this linter
{"default": [], "examples": [["all_flavors", "java", "php"]], "items": {}, "type": "array"}
megalinter-descriptor.jsonschema.json
descriptor_flavors_exclude
MegaLinter flavors that must not contain this descriptor
{"default": [], "examples": [["all_flavors", "java", "php"]], "items": {}, "type": "array"}
megalinter-descriptor.jsonschema.json
disabled
Disable linter in MegaLinter next builds
{"default": false, "type": "boolean"}
megalinter-descriptor.jsonschema.json
downgraded_reason
Explanation about why the linter is downgraded
{"default": false, "type": "string"}
megalinter-descriptor.jsonschema.json
downgraded_version
Indicates that installation instructions does not use the latest release of the linter
{"default": false, "type": "boolean"}
megalinter-descriptor.jsonschema.json
examples
Please add an example with and without configuration file in the command. They will appear in documentation
{"examples": [["golangci-lint run myfile.go", "golangci-lint run -c .golangci.yml myfile.go"], ["eslint myfile.js", "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
file_extensions
File extension filters if different from the ones defined on parent descriptor
{"default": [], "examples": [[".py", ""]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
file_names_not_ends_with
List of strings to filter the files according to their end of file name
{"default": [], "examples": [["vault.yml", "galaxy.xml"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
file_names_regex
Regular expression list for filtering files by their base names using regex full match. Empty list includes all files. Can be overridden at linter level
{"default": [], "examples": [["Dockerfile(-.+)?", "Jenkinsfile"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
files_sub_directory
Set when a linter only lints a sub-directory
{"examples": [["ansible", "kubernetes"]], "type": "string"}
megalinter-descriptor.jsonschema.json
ide
List of IDE supporting the linter
{"type": "object"}
megalinter-descriptor.jsonschema.json
ignore_file_name
An explanation about the purpose of this instance.
{"examples": [".eslintignore", ".secretlintignore"], "type": "string"}
megalinter-descriptor.jsonschema.json
ignore_for_flavor_suggestions
If this property is set to true, this linter will be ignored for flavor suggestions
{"default": false, "examples": [".eslintignore", ".secretlintignore"], "type": "boolean"}
megalinter-descriptor.jsonschema.json
install
List of apk, dockerfile instructions, npm/pip/gem packages required to install the linter
{"default": {}, "examples": [{"dockerfile": ["FROM accurics/terrascan:latest as terrascan", "COPY --from=terrascan /go/bin/terrascan /usr/bin/", "RUN terrascan init"]}, {"npm": ["eslint", "eslint-config-airbnb", "eslint-config-prettier", "eslint-plugin-jest", "eslint-plugin-prettier", "babel-eslint"]}], "properties": {...
megalinter-descriptor.jsonschema.json
apk
APK packages identifiers (with or without version)
{"examples": [["perl", "perl-dev"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
cargo
Cargo packages identifiers (with or without version)
{"examples": [["clippy", "sarif-fmt"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
dockerfile
Will be automatically integrated in generated Dockerfile
{"examples": [["FROM accurics/terrascan:latest as terrascan", "COPY --from=terrascan /go/bin/terrascan /usr/bin/", "RUN terrascan init"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
gem
GEM packages identifiers (with or without version)
{"examples": [["rubocop:0.82.0", "rubocop-github:0.16.0", "rubocop-performance"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
npm
NPM packages identifiers (with or without version)
{"examples": [["eslint", "eslint-config-airbnb@3.2.1"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
pip
PIP packages identifiers (with or without version)
{"examples": [["flake8"]], "items": {"type": "string"}, "type": "array"}
megalinter-descriptor.jsonschema.json
is_formatter
If the linter is just a formatter, set to true so errors will count as warnings
{"default": false, "type": "boolean"}
megalinter-descriptor.jsonschema.json
is_sbom
If the linter is SBOM, set to true so extra properties will be returned
{"default": false, "type": "boolean"}
megalinter-descriptor.jsonschema.json
lint_all_files
If set to true, this linter will always lint all files, undepending their name/extensions/content
{"default": false, "type": "boolean"}
megalinter-descriptor.jsonschema.json
lint_all_other_linters_files
If set to true, this descriptor linters will lint one by one all files collected by all other linters
{"default": false, "type": "boolean"}
megalinter-descriptor.jsonschema.json
linter_banner_image_url
URL of an image used to build header of linter Markdown documentation
{"examples": ["https://github.com/stylelint/stylelint/raw/main/identity/stylelint-icon-and-text-white.png"], "format": "uri", "type": "string"}
megalinter-descriptor.jsonschema.json
linter_help_cache
If the linter is unable to return help content, hardcode it here
{"type": "string"}
megalinter-descriptor.jsonschema.json
linter_icon_png_url
URL of a PNG image representing the icon of the linter
{"examples": ["https://github.com/stylelint/stylelint/raw/main/identity/stylelint-icon-and-text-white.png"], "format": "uri", "type": "string"}
megalinter-descriptor.jsonschema.json
linter_image_url
URL of an image used in linter Markdown documentation
{"examples": ["https://raku.org/camelia-logo.png"], "format": "uri", "type": "string"}
megalinter-descriptor.jsonschema.json
linter_megalinter_ref_url
URL to linter documentation referring to MegaLinter
{"type": "string"}
megalinter-descriptor.jsonschema.json
linter_name
Name of the linter (same as cli command if possible)
{"examples": ["eslint"], "type": "string"}
megalinter-descriptor.jsonschema.json
linter_repo
URL of the linter repository home page
{"examples": ["https://github.com/eslint/eslint"], "format": "uri", "type": "string"}
megalinter-descriptor.jsonschema.json
linter_rules_configuration_url
URL to linter documentation explaining how to configure the linter
{"format": "uri", "type": "string"}
megalinter-descriptor.jsonschema.json
linter_rules_ignore_config_url
URL to linter documentation explaining how to ignore files
{"format": "uri", "type": "string"}
megalinter-descriptor.jsonschema.json
linter_rules_inline_disable_url
URL to linter documentation explaining how to disable rules directly with comments in files
{"format": "uri", "type": "string"}
megalinter-descriptor.jsonschema.json
linter_rules_url
URL to linter documentation listing all the rules that can be detected
{"format": "uri", "type": "string"}
megalinter-descriptor.jsonschema.json
linter_spdx_license
spdx license id of the linter
{"type": "string"}
megalinter-descriptor.jsonschema.json
linter_speed
Average speed of the linter (performances indicator). For 1 (very slow) to 5 (very fast)
{"enum": [1, 2, 3, 4, 5], "type": "number"}
megalinter-descriptor.jsonschema.json
linter_url
URL of the linter home page
{"examples": ["https://eslint.org"], "format": "uri", "type": "string"}
megalinter-descriptor.jsonschema.json
linter_version_cache
If the linter is unable to return a version number, hardcode it here
{"type": "string"}
megalinter-descriptor.jsonschema.json
name
When several linters in a descriptor, set a different name that will be used for configuration
{"examples": ["JAVASCRIPT_ES"], "type": "string"}
megalinter-descriptor.jsonschema.json
post_commands
Custom bash commands to run after linter
{"default": [], "examples": [[{"command": "npm install java-caller", "continue_if_failed": false, "cwd": "root"}, {"command": "echo \"linter post-run command has been called\"", "cwd": "workspace"}]], "items": {}, "type": "array"}
megalinter-descriptor.jsonschema.json
pre_commands
Custom bash commands to run before linter
{"default": [], "examples": [[{"command": "tflint --init", "continue_if_failed": false, "cwd": "root"}, {"command": "echo \"linter pre-run command has been called\"", "cwd": "workspace"}]], "items": {}, "type": "array"}
megalinter-descriptor.jsonschema.json
sarif_default_output_file
Path to find default SARIF output file when generated by linter
{"examples": [["./results.sarif"]], "type": "string"}
megalinter-descriptor.jsonschema.json
test_folder
Test folder containing _good_ and _bad_ files, if different from parent descriptor test_folder
{"examples": [["bash_shfmt", "terraform_terrascan"]], "type": "string"}
megalinter-descriptor.jsonschema.json
test_variables
List of variables to set before running tests
{"examples": [{"JAVASCRIPT_DEFAULT_STYLE": "prettier"}], "type": "object"}
megalinter-descriptor.jsonschema.json
variables
Try to not use this property except if you really have no choice
{"examples": [{"default_value": "false", "name": "ERROR_ON_MISSING_EXEC_BIT"}], "type": "array"}
megalinter-descriptor.jsonschema.json
examples
If set to `false`, the `bash-exec` linter will report a warning if a shell script is not executable. If set to `true`, the `bash-exec` linter will report an error instead
{"default_value": "false", "name": "ERROR_ON_MISSING_EXEC_BIT"}
megalinter-descriptor.jsonschema.json
version_extract_regex
If default regex to extract version from linter -v call, override it here
{"examples": ["(?<=npm-groovy-lint version )\\d+(\\.\\d+)+"], "type": "string"}
megalinter-descriptor.jsonschema.json
processing_order
If descriptor linters may be slow, put a negative processing order. If it is fast, put a positive one. If you don't know, do not set
{"default": 0, "examples": [[-9, 0, 9]], "type": "number"}
megalinter-descriptor.jsonschema.json
test_folder
Test folder containing _good_ and _bad_ files. Default: lowercase(descriptor_id)
{"examples": [["bash_shfmt", "terraform_terrascan"]], "type": "string"}
megalinter-configuration.jsonschema.json
MegaLinter configuration file
{"$schema": "http://json-schema.org/draft-07/schema", "additionalProperties": false, "definitions": {"command_info": {"properties": {"command": {"examples": ["npm run test", "echo \"This is a custom command\""], "type": "string"}, "continue_if_failed": {"default": true, "type": "boolean"}, "cwd": {"enum": ["root", "wor...
megalinter-configuration.jsonschema.json
command_info
Command information
{"properties": {"command": {"examples": ["npm run test", "echo \"This is a custom command\""], "type": "string"}, "continue_if_failed": {"default": true, "type": "boolean"}, "cwd": {"enum": ["root", "workspace"], "examples": ["root", "workspace"], "type": "string"}, "secured_env": {"default": true, "type": "boolean"}},...
megalinter-configuration.jsonschema.json
ACTION_ACTIONLINT_ARGUMENTS
ACTION_ACTIONLINT: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
ACTION_ACTIONLINT_COMMAND_REMOVE_ARGUMENTS
ACTION_ACTIONLINT: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
ACTION_ACTIONLINT_CONFIG_FILE
ACTION_ACTIONLINT: User custom config file name if different from default
{"default": "actionlint.yml", "type": "string"}
megalinter-configuration.jsonschema.json
ACTION_ACTIONLINT_RULES_PATH
ACTION_ACTIONLINT: Path where to find linter configuration file
{"type": "string"}
megalinter-configuration.jsonschema.json
ACTION_ACTIONLINT_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling ACTION_ACTIONLINT and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
ADDITIONAL_EXCLUDED_DIRECTORIES
List of additional excluded directory basenames to add to MegaLinter default excluded directories. They are excluded at any nested level.
{"examples": [["test"]], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
ANSIBLE_ANSIBLE_LINT_ARGUMENTS
ANSIBLE_ANSIBLE_LINT: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
ANSIBLE_ANSIBLE_LINT_COMMAND_REMOVE_ARGUMENTS
ANSIBLE_ANSIBLE_LINT: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
ANSIBLE_ANSIBLE_LINT_CONFIG_FILE
ANSIBLE_ANSIBLE_LINT: User custom config file name if different from default
{"default": ".ansible-lint", "type": "string"}
megalinter-configuration.jsonschema.json
ANSIBLE_ANSIBLE_LINT_FILE_NAME
ANSIBLE_ANSIBLE_LINT: User custom config file name if different from default
{"default": ".ansible-lint.yml", "type": "string"}
megalinter-configuration.jsonschema.json
ANSIBLE_ANSIBLE_LINT_RULES_PATH
ANSIBLE_ANSIBLE_LINT: Path where to find linter configuration file
{"type": "string"}
megalinter-configuration.jsonschema.json
ANSIBLE_ANSIBLE_LINT_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling ANSIBLE_ANSIBLE_LINT and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
APPLY_FIXES
'all' to apply formatting and auto-fixes of all linters, or a list of linter keys
{"default": "none", "examples": ["all", "none", ["JAVASCRIPT_ES", "MARKDOWN_MARKDOWNLINT"]], "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
ARM_ARM_TTK_ARGUMENTS
ARM_ARM_TTK: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
ARM_ARM_TTK_COMMAND_REMOVE_ARGUMENTS
ARM_ARM_TTK: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
ARM_ARM_TTK_CONFIG_FILE
ARM_ARM_TTK: User custom config file name if different from default
{"default": ".arm-ttk.psd1", "type": "string"}
megalinter-configuration.jsonschema.json
ARM_ARM_TTK_FILE_NAME
ARM_ARM_TTK: User custom config file name if different from default
{"default": ".arm-ttk.psd1", "type": "string"}
megalinter-configuration.jsonschema.json
ARM_ARM_TTK_RULES_PATH
ARM_ARM_TTK: Path where to find linter configuration file
{"type": "string"}
megalinter-configuration.jsonschema.json
ARM_ARM_TTK_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling ARM_ARM_TTK and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
AZURE_COMMENT_REPORTER
Posts MegaLinter results summary in the comments of the related pull request (if existing)
{"default": true, "type": "boolean"}
megalinter-configuration.jsonschema.json
BASH_EXEC_ARGUMENTS
BASH_EXEC: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
BASH_EXEC_COMMAND_REMOVE_ARGUMENTS
BASH_EXEC: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
BASH_EXEC_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling BASH_EXEC and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
BASH_SHELLCHECK_ARGUMENTS
BASH_SHELLCHECK: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
BASH_SHELLCHECK_COMMAND_REMOVE_ARGUMENTS
BASH_SHELLCHECK: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
BASH_SHELLCHECK_UNSECURED_ENV_VARIABLES
List of env variables explicitly not filtered before calling BASH_SHELLCHECK and its pre/post commands
{"default": [], "items": {"type": "string"}, "type": "array"}
megalinter-configuration.jsonschema.json
BASH_SHFMT_ARGUMENTS
BASH_SHFMT: User custom arguments to add in linter CLI call
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}
megalinter-configuration.jsonschema.json
BASH_SHFMT_COMMAND_REMOVE_ARGUMENTS
BASH_SHFMT: User custom arguments to remove before calling linter
{"examples:": ["--foo", "bar"], "items": {"type": "string"}, "type": ["array", "string"]}