schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
travis.json | items | Alias defined in source whitelist | {"type": "string"} |
travis.json | packages | To install packages from the package whitelist before your custom build steps | {"type": "array", "items": {"type": "string"}} |
travis.json | hosts | If your build requires setting up custom hostnames, you can specify a single host or a list of them. Travis CI will automatically setup the hostnames in /etc/hosts for both IPv4 and IPv6. | {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]} |
travis.json | ssh_known_hosts | Travis CI can add entries to ~/.ssh/known_hosts prior to cloning your git repository, which is necessary if there are git submodules from domains other than github.com, gist.github.com, or ssh.github.com. | {} |
travis.json | working_dir | If you'd like to upload file from a specific directory, you can change your working directory | {"type": "string"} |
travis.json | debug | If you'd like to see more detail about what the artifacts addon is doing | {"type": "boolean"} |
travis.json | firefox | Firefox addon | {"anyOf": [{"type": "string", "enum": ["latest", "latest-esr", "latest-beta", "latest-dev", "latest-nightly", "latest-unsigned"]}, {}]} |
travis.json | chrome | Chrome addon | {"type": "string", "enum": ["stable", "beta"]} |
travis.json | rethinkdb | RethinkDB addon | {"type": "string"} |
travis.json | postgresql | PostgreSQL addon | {"type": "string"} |
travis.json | mariadb | MariaDB addon | {"type": "string"} |
travis.json | sauce_connect | Sauce Connect addon | {"oneOf": [{"type": "object", "properties": {"username": {"type": "string"}, "access_key": {"type": "string"}}}, {"type": "boolean"}]} |
travis.json | sonarcloud | SonarCloud addon | {"type": "object", "properties": {"organization": {"type": "string"}, "token": {}}} |
travis.json | coverity_scan | Coverity Scan addon | {"type": "object", "properties": {"project": {"type": "object", "properties": {"name": {"type": "string"}, "version": {"type": "number"}}, "required": ["name"]}, "notification_email": {"type": "string"}, "build_command_prepend": {"type": "string"}, "build_command": {"type": "string"}, "branch_pattern": {"type": "string"}}} |
travis.json | project | GitHub project metadata | {"type": "object", "properties": {"name": {"type": "string"}, "version": {"type": "number"}}, "required": ["name"]} |
travis.json | notification_email | Where email notification of build analysis results will be sent | {"type": "string"} |
travis.json | build_command_prepend | Commands to prepare for build_command | {"type": "string"} |
travis.json | build_command | The command that will be added as an argument to 'cov-build' to compile your project for analysis | {"type": "string"} |
travis.json | branch_pattern | Pattern to match selecting branches that will run analysis. We recommend leaving this set to 'coverity_scan' | {"type": "string"} |
travis.json | homebrew | Homebrew addon | {"type": "object", "additionalProperties": false, "properties": {"taps": {}, "packages": {}, "casks": {}, "brewfile": {"oneOf": [{}, {"type": "boolean", "default": true}]}, "update": {"type": "boolean", "default": true}}} |
travis.json | srcclr | SourceClear addon | {"oneOf": [{"type": "boolean", "default": true}, {"type": "object", "additionalProperties": false, "properties": {"debug": {"type": "boolean", "default": true}}}]} |
travis.json | snaps | Snaps addon | {"oneOf": [{}, {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"oneOf": [{}, {"type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {}, "channel": {}, "classic": {"type": "boolean"}, "confinement": {"enum": ["classic", "devmode"]}}}]}}]} |
travis.json | classic | 'classic:' is deprecated, use 'confinement:' | {"type": "boolean"} |
travis.json | browserstack | BrowserStack addon | {"type": "object", "properties": {"username": {}, "access_key": {}, "app_path": {}, "proxyHost": {}, "proxyPort": {}, "proxyUser": {}, "proxyPass": {}, "forcelocal": {"type": "boolean"}, "only": {}}} |
travis.json | timeout | Upload timeout in seconds | {"type": "number", "default": 1800} |
travis.json | depth | Set the git clone depth | {"type": "integer", "default": 50} |
travis.json | quiet | Travis CI clones repositories without the quiet flag (-q) by default. Enabling the quiet flag can be useful if you're trying to avoid log file size limits or even if you just don't need to include it. | {"type": "boolean"} |
travis.json | submodules | Control whether submodules should be cloned | {"type": "boolean"} |
travis.json | lfs_skip_smudge | Skip fetching the git-lfs files during the initial git clone (equivalent to git lfs smudge --skip), | {"type": "boolean"} |
travis.json | clone | In some work flows, like build stages, it might be beneficial to skip the automatic git clone step. | {"type": "boolean"} |
travis.json | sparse_checkout | Is a path to the existing file in the current repository with data you'd like to put into $GIT_DIR/info/sparse-checkout file of format described in Git documentation. | {} |
travis.json | autocrlf | Specify handling of line endings when cloning repository | {"oneOf": [{"type": "boolean"}, {"type": "string", "enum": ["input"]}]} |
travis.json | branches | Specify which branches to build | {"type": "object", "properties": {"except": {"type": "array", "items": {"type": "string"}}, "only": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false} |
travis.json | tags | Tell Travis CI to only deploy on tagged commits | {"oneOf": [{"type": "boolean"}, {"type": "string"}]} |
travis.json | skip_cleanup | After your tests ran and before the release, Travis CI will clean up any additional files and changes you made. Maybe that is not what you want, as you might generate some artifacts that are supposed to be released, too. | {"type": "boolean"} |
travis.json | condition | if [[ <condition> ]]; then <deploy>; fi | {"type": "string"} |
travis.json | overwrite | If you need to overwrite existing files | {"type": "boolean"} |
travis.json | deployment | deploy to heroku, to see https://docs.travis-ci.com/user/deployment/heroku/ | {"type": "object", "properties": {"provider": {"enum": ["heroku"]}, "api_key": {"anyOf": [{}, {"type": "object", "additionalProperties": {}}]}, "app": {"oneOf": [{"type": "string"}, {"type": "object", "additionalProperties": {"type": "string"}}]}, "run": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "skip_cleanup": {"type": "boolean"}, "strategy": {"enum": ["api", "git"]}}, "required": ["provider", "api_key"]} |
travis.json | api_key | heroku auth token | {"anyOf": [{}, {"type": "object", "additionalProperties": {}}]} |
travis.json | app | Deploy master branch to heroku app | {"type": "string"} |
travis.json | app | Deploy the different branch to the different heroku app | {"type": "object", "additionalProperties": {"type": "string"}} |
travis.json | run | to run a command on Heroku after a successful deploy | {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]} |
travis.json | skip_cleanup | Travis CI default will clean up any additional files and changes you made, you can by it to skip the clean up | {"type": "boolean"} |
travis.json | strategy | Travis CI supports different mechanisms for deploying to Heroku: api is default | {"enum": ["api", "git"]} |
travis.json | source | The source to import build config from | {} |
travis.json | mode | How to merge the imported config into the target config (defaults to deep_merge_append) | {"type": "string", "enum": ["merge", "deep_merge", "deep_merge_append", "deep_merge_prepend"]} |
travis.json | if | Specifies a condition for the import | {} |
prometheus.rules.test.json | Prometheus rules test file. See https://prometheus.io/docs/prometheus/latest/configuration/unit_testing_rules/ for details. | {"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"alert": {"properties": {"exp_annotations": {}, "exp_labels": {}}, "required": ["exp_labels"], "type": "object"}, "alert_test_case": {"additionalProperties": false, "properties": {"alertname": {"type": "string"}, "eval_time": {}, "exp_alerts": {"items": {}, "type": "array"}}, "required": ["eval_time", "alertname"], "type": "object"}, "duration": {"minLength": 1, "pattern": "^([0-9]+y)?([0-9]+w)?([0-9]+d)?([0-9]+h)?([0-9]+m)?([0-9]+s)?([0-9]+ms)?$", "type": ["string", "null"]}, "label_value": {"type": "string"}, "labels": {"additionalProperties": false, "patternProperties": {"^[a-zA-Z_][a-zA-Z0-9_]*$": {}}, "type": ["object", "null"]}, "promql_test_case": {"additionalProperties": false, "properties": {"eval_time": {}, "exp_samples": {"items": {}, "type": "array"}, "expr": {"type": "string"}}, "required": ["expr", "eval_time"], "type": "object"}, "sample": {"properties": {"labels": {"type": "string"}, "value": {"type": "number"}}, "required": ["labels", "value"], "type": "object"}, "series": {"additionalProperties": false, "properties": {"series": {"type": "string"}, "values": {"type": "string"}}, "required": ["series", "values"], "type": "object"}, "test_group": {"additionalProperties": false, "properties": {"alert_rule_test": {"items": {}, "type": "array"}, "external_labels": {}, "external_url": {"type": "string"}, "input_series": {"items": {}, "type": "array"}, "interval": {}, "name": {"type": "string"}, "promql_expr_test": {"items": {}, "type": "array"}}, "required": ["interval", "input_series"], "type": "object"}}, "properties": {"evaluation_interval": {"default": "1m", "type": ["string", "null"]}, "group_eval_order": {"items": {"type": "string"}, "type": ["array", "null"]}, "rule_files": {"items": {"type": "string"}, "type": "array"}, "tests": {"items": {}, "type": "array"}}, "type": "object"} |
|
prometheus.rules.test.json | exp_annotations | Expanded annotations of the expected alert | {} |
prometheus.rules.test.json | exp_labels | Expanded labels and annotations of the expected alert. This also include the labels of the sample associated with the alert (same as what you see in `/alerts`, without series `__name__` and `alertname`). | {} |
prometheus.rules.test.json | alertname | Name of the alert to be tested. | {"type": "string"} |
prometheus.rules.test.json | eval_time | The time elapsed from time=0s when the alerts have to be checked. | {} |
prometheus.rules.test.json | exp_alerts | List of expected alerts firing under the given alertname at the given evaluation time | {"items": {}, "type": "array"} |
prometheus.rules.test.json | eval_time | The time elapsed from time=0s when the expression has to be evaluated. | {} |
prometheus.rules.test.json | exp_samples | Expected samples at the given evaluation time. | {"items": {}, "type": "array"} |
prometheus.rules.test.json | expr | PromQL expression to evaluate | {"type": "string"} |
prometheus.rules.test.json | labels | Labels of the sample in the usual series notation '<metric name>{<label name>=<label value>, ...}' | {"type": "string"} |
prometheus.rules.test.json | value | Expected value of the PromQL expression. | {"type": "number"} |
prometheus.rules.test.json | series | This follows the usual series notation '<metric name>{<label name>=<label value>, ...}'. | {"type": "string"} |
prometheus.rules.test.json | values | This uses expanded notation to project time series. There are also the special `_` and `stale` values to indicate missing or stale samples | {"type": "string"} |
prometheus.rules.test.json | alert_rule_test | Unit tests for alerting rules. We only consider the alerting rules from the input files. | {"items": {}, "type": "array"} |
prometheus.rules.test.json | external_labels | External labels accessible to the alert template. | {} |
prometheus.rules.test.json | external_url | External URL accessible to the alert template. Usually set using --web.external-url. | {"type": "string"} |
prometheus.rules.test.json | input_series | A list of time series | {"items": {}, "type": "array"} |
prometheus.rules.test.json | interval | The time elapsed from time=0s when the alerts have to be checked. | {} |
prometheus.rules.test.json | name | Name of the test group | {"type": "string"} |
prometheus.rules.test.json | promql_expr_test | Unit tests for PromQL expressions | {"items": {}, "type": "array"} |
prometheus.rules.test.json | evaluation_interval | The evaluation interval for the tests. [duration] format. | {"default": "1m", "type": ["string", "null"]} |
prometheus.rules.test.json | group_eval_order | The order in which group names are listed below will be the order of evaluation of rule groups (at a given evaluation time). | {"items": {"type": "string"}, "type": ["array", "null"]} |
prometheus.rules.test.json | rule_files | List of rule files to consider for testing. Globs are supported. | {"items": {"type": "string"}, "type": "array"} |
prometheus.rules.test.json | items | All the tests are listed here. | {} |
megalinter-descriptor.jsonschema.json | Descriptor definition for MegaLinter | {"$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", "workspace"], "examples": ["root", "workspace"], "type": "string"}}, "required": [], "type": "object"}, "enum_flavors": {"enum": ["all_flavors", "all", "ci_light", "cupcake", "documentation", "dotnet", "dotnetweb", "go", "java", "javascript", "php", "python", "ruby", "rust", "salesforce", "security", "swift", "terraform"], "type": "string"}}, "properties": {"active_only_if_file_found": {"examples": [[".editorconfig", ".eslintrc.json"]], "items": {"type": "string"}, "type": "array"}, "descriptor_flavors": {"default": [], "examples": [["all_flavors", "java", "php"]], "items": {}, "type": "array"}, "descriptor_flavors_exclude": {"default": [], "examples": [["all_flavors", "java", "php"]], "items": {}, "type": "array"}, "descriptor_id": {"default": "", "examples": ["PYTHON", "XML", "OPENAPI"], "type": "string"}, "descriptor_label": {"default": "", "examples": ["C++", "Visual Basic .NET"], "type": "string"}, "descriptor_type": {"default": "", "enum": ["language", "format", "tooling_format", "other"], "examples": ["language", "format", "tooling_format", "other"], "type": "string"}, "file_contains_regex": {"default": [], "examples": [["AWSTemplateFormatVersion", "(AWS|Alexa|Custom)::"]], "items": {"type": "string"}, "type": "array"}, "file_contains_regex_extensions": {"default": [], "examples": [["", ".json"]], "items": {"type": "string"}, "type": "array"}, "file_extensions": {"default": [], "examples": [[".py", ""]], "items": {"type": "string"}, "type": "array"}, "file_names_not_ends_with": {"default": [], "examples": [["vault.yml", "galaxy.xml"]], "items": {"type": "string"}, "type": "array"}, "file_names_regex": {"default": [], "examples": [["Dockerfile(-.+)?", "Jenkinsfile"]], "items": {"type": "string"}, "type": "array"}, "files_sub_directory": {"examples": [["ansible", "kubernetes"]], "type": "string"}, "install": {"default": {}, "examples": [{"apk": ["openjdk11"]}, {"dockerfile": ["ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk", "ENV PATH=\"$JAVA_HOME/bin:${PATH}\""]}, {"npm": ["sfdx-cli"]}], "properties": {"apk": {"examples": [["openjdk11"]], "items": {"type": "string"}, "type": "array"}, "cargo": {"items": {"type": "string"}, "type": "array"}, "dockerfile": {"examples": [["ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk", "ENV PATH=\"$JAVA_HOME/bin:${PATH}\""]], "items": {"type": "string"}, "type": "array"}, "gem": {"items": {"type": "string"}, "type": "array"}, "npm": {"examples": [["sfdx-cli"]], "items": {"type": "string"}, "type": "array"}, "pip": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "lint_all_files": {"default": false, "type": "boolean"}, "lint_all_other_linters_files": {"default": false, "type": "boolean"}, "linters": {"examples": [[{"cli_config_extra_args": ["--no-eslintrc", "--no-ignore"], "config_file_name": ".eslintrc.yml", "examples": ["eslint myfile.js", "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"], "install": {"npm": ["eslint", "eslint-config-airbnb", "eslint-config-prettier", "eslint-plugin-jest", "eslint-plugin-prettier", "@babel/eslint-parser"]}, "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png", "linter_name": "eslint", "linter_url": "https://eslint.org", "name": "JAVASCRIPT_ES"}, {"examples": ["standard myfile.js"], "install": {"npm": ["standard"]}, "linter_banner_image_url": "https://github.com/standard/standard/raw/master/sticker.png", "linter_name": "standard", "linter_url": "https://github.com/standard/standard", "name": "JAVASCRIPT_STANDARD"}]], "items": {"additionalProperties": false, "examples": [{"cli_config_extra_args": ["--no-eslintrc", "--no-ignore"], "config_file_name": ".eslintrc.yml", "examples": ["eslint myfile.js", "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"], "install": {"npm": ["eslint", "eslint-config-airbnb", "eslint-config-prettier", "eslint-plugin-jest", "eslint-plugin-prettier", "babel-eslint"]}, "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png", "linter_name": "eslint", "linter_url": "https://eslint.org", "name": "JAVASCRIPT_ES"}], "properties": {"activation_rules": {"default": [], "examples": [[{"default_value": "standard", "expected_value": "prettier", "type": "variable", "variable": "JAVASCRIPT_DEFAULT_STYLE"}]], "items": {"type": "object"}, "type": "array"}, "active_only_if_file_found": {"examples": [[".editorconfig", ".eslintrc.json"]], "items": {"type": "string"}, "type": "array"}, "can_output_sarif": {"default": false, "type": "boolean"}, "class": {"examples": ["CSpellLinter", "DotnetFormatLinter", "RakuLinter"], "type": "string"}, "cli_config_arg_name": {"type": "string"}, "cli_config_default_value": {"type": "string"}, "cli_config_extra_args": {"default": [], "examples": [["--no-eslintrc", "--no-ignore"]], "items": {"type": "string"}, "type": "array"}, "cli_docker_args": {"default": [], "examples": [["-v", "`pwd`:`pwd`", "-w", "`pwd`"]], "items": {"type": "string"}, "type": "array"}, "cli_docker_image": {"examples": ["norionomura/swiftlint"], "type": "string"}, "cli_docker_image_version": {"default": "latest", "examples": ["0.42.0_swift-5.3.2"], "type": "string"}, "cli_executable": {"type": "string"}, "cli_executable_help": {"type": "string"}, "cli_executable_version": {"type": "string"}, "cli_help_arg_name": {"type": "string"}, "cli_help_extra_args": {"items": {"type": "string"}, "type": "array"}, "cli_help_extra_commands": {"items": {"type": "string"}, "type": "array"}, "cli_lint_errors_count": {"enum": ["regex_number", "regex_count", "regex_sum", "total_lines", "sarif"], "examples": ["regex_number", "regex_count", "regex_sum", "total_lines"], "type": "string"}, "cli_lint_errors_regex": {"examples": ["Issues found: (.*) in .* files"], "type": "string"}, "cli_lint_extra_args": {"default": [], "items": {"type": "string"}, "type": "array"}, "cli_lint_extra_args_after": {"default": [], "items": {"type": "string"}, "type": "array"}, "cli_lint_fix_arg_name": {"examples": ["--fix", "--format"], "type": "string"}, "cli_lint_fix_remove_args": {"default": [], "examples": [["--check"]], "items": {"type": "string"}, "type": "array"}, "cli_lint_ignore_arg_name": {"examples": ["--secretlintignore", "--ignore-path"], "type": "string"}, "cli_lint_mode": {"default": "file", "enum": ["file", "project", "list_of_files"], "type": "string"}, "cli_sarif_args": {"default": [], "examples": [["--format", "sarif", "--output", "{{SARIF_OUTPUT_FILE}}"]], "items": {"type": "string"}, "type": "array"}, "cli_version_arg_name": {"type": "string"}, "cli_version_extra_args": {"items": {"type": "string"}, "type": "array"}, "config_file_name": {"examples": [".eslintrc.yml", ".markdown-lint.yml", ".python-black"], "type": "string"}, "deprecated": {"default": false, "type": "boolean"}, "deprecated_description": {"default": "", "type": "string"}, "descriptor_flavors": {"default": [], "examples": [["all_flavors", "java", "php"]], "items": {}, "type": "array"}, "descriptor_flavors_exclude": {"default": [], "examples": [["all_flavors", "java", "php"]], "items": {}, "type": "array"}, "disabled": {"default": false, "type": "boolean"}, "downgraded_reason": {"default": false, "type": "string"}, "downgraded_version": {"default": false, "type": "boolean"}, "examples": {"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"}, "file_extensions": {"default": [], "examples": [[".py", ""]], "items": {"type": "string"}, "type": "array"}, "file_names_not_ends_with": {"default": [], "examples": [["vault.yml", "galaxy.xml"]], "items": {"type": "string"}, "type": "array"}, "file_names_regex": {"default": [], "examples": [["Dockerfile(-.+)?", "Jenkinsfile"]], "items": {"type": "string"}, "type": "array"}, "files_sub_directory": {"examples": [["ansible", "kubernetes"]], "type": "string"}, "help_command_return_code": {"type": "number"}, "ide": {"type": "object"}, "ignore_file_name": {"examples": [".eslintignore", ".secretlintignore"], "type": "string"}, "ignore_for_flavor_suggestions": {"default": false, "examples": [".eslintignore", ".secretlintignore"], "type": "boolean"}, "install": {"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": {"apk": {"examples": [["perl", "perl-dev"]], "items": {"type": "string"}, "type": "array"}, "cargo": {"examples": [["clippy", "sarif-fmt"]], "items": {"type": "string"}, "type": "array"}, "dockerfile": {"examples": [["FROM accurics/terrascan:latest as terrascan", "COPY --from=terrascan /go/bin/terrascan /usr/bin/", "RUN terrascan init"]], "items": {"type": "string"}, "type": "array"}, "gem": {"examples": [["rubocop:0.82.0", "rubocop-github:0.16.0", "rubocop-performance"]], "items": {"type": "string"}, "type": "array"}, "npm": {"examples": [["eslint", "[email protected]"]], "items": {"type": "string"}, "type": "array"}, "pip": {"examples": [["flake8"]], "items": {"type": "string"}, "type": "array"}}, "type": "object"}, "is_formatter": {"default": false, "type": "boolean"}, "is_sbom": {"default": false, "type": "boolean"}, "lint_all_files": {"default": false, "type": "boolean"}, "lint_all_other_linters_files": {"default": false, "type": "boolean"}, "linter_banner_image_url": {"examples": ["https://github.com/stylelint/stylelint/raw/main/identity/stylelint-icon-and-text-white.png"], "format": "uri", "type": "string"}, "linter_help_cache": {"type": "string"}, "linter_icon_png_url": {"examples": ["https://github.com/stylelint/stylelint/raw/main/identity/stylelint-icon-and-text-white.png"], "format": "uri", "type": "string"}, "linter_image_url": {"examples": ["https://raku.org/camelia-logo.png"], "format": "uri", "type": "string"}, "linter_megalinter_ref_url": {"type": "string"}, "linter_name": {"examples": ["eslint"], "type": "string"}, "linter_repo": {"examples": ["https://github.com/eslint/eslint"], "format": "uri", "type": "string"}, "linter_rules_configuration_url": {"format": "uri", "type": "string"}, "linter_rules_ignore_config_url": {"format": "uri", "type": "string"}, "linter_rules_inline_disable_url": {"format": "uri", "type": "string"}, "linter_rules_url": {"format": "uri", "type": "string"}, "linter_spdx_license": {"type": "string"}, "linter_speed": {"enum": [1, 2, 3, 4, 5], "type": "number"}, "linter_text": {"type": "string"}, "linter_url": {"examples": ["https://eslint.org"], "format": "uri", "type": "string"}, "linter_version_cache": {"type": "string"}, "name": {"examples": ["JAVASCRIPT_ES"], "type": "string"}, "post_commands": {"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"}, "pre_commands": {"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"}, "sarif_default_output_file": {"examples": [["./results.sarif"]], "type": "string"}, "test_folder": {"examples": [["bash_shfmt", "terraform_terrascan"]], "type": "string"}, "test_variables": {"examples": [{"JAVASCRIPT_DEFAULT_STYLE": "prettier"}], "type": "object"}, "variables": {"examples": [{"default_value": "false", "name": "ERROR_ON_MISSING_EXEC_BIT"}], "type": "array"}, "version_command_return_code": {"type": "number"}, "version_extract_regex": {"examples": ["(?<=npm-groovy-lint version )\\d+(\\.\\d+)+"], "type": "string"}}, "required": ["linter_name", "linter_url", "examples"], "type": "object"}, "type": "array"}, "processing_order": {"default": 0, "examples": [[-9, 0, 9]], "type": "number"}, "test_folder": {"examples": [["bash_shfmt", "terraform_terrascan"]], "type": "string"}}, "required": ["descriptor_id", "descriptor_type", "linters"], "type": "object"} |
|
megalinter-descriptor.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"}}, "required": [], "type": "object"} |
megalinter-descriptor.jsonschema.json | active_only_if_file_found | Names of the config files to be found (at least one), else descriptor will be deactivated | {"examples": [[".editorconfig", ".eslintrc.json"]], "items": {"type": "string"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | descriptor_flavors | MegaLinter flavors matching this descriptor | {"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 | descriptor_id | Uppercase unique identifier for the language, tooling format or identifier | {"default": "", "examples": ["PYTHON", "XML", "OPENAPI"], "type": "string"} |
megalinter-descriptor.jsonschema.json | descriptor_label | Label for descriptor documentation, if different from Id. Ex: C++ for CPP | {"default": "", "examples": ["C++", "Visual Basic .NET"], "type": "string"} |
megalinter-descriptor.jsonschema.json | descriptor_type | Descriptor type: language, format or tooling format | {"default": "", "enum": ["language", "format", "tooling_format", "other"], "examples": ["language", "format", "tooling_format", "other"], "type": "string"} |
megalinter-descriptor.jsonschema.json | file_contains_regex | Regular expression list for filtering files by their content | {"default": [], "examples": [["AWSTemplateFormatVersion", "(AWS|Alexa|Custom)::"]], "items": {"type": "string"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | file_contains_regex_extensions | If file_contains_regex is set, use this property to filter extensions of the files that will be checked | {"default": [], "examples": [["", ".json"]], "items": {"type": "string"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | file_extensions | File extension filters. Empty list excludes all files. Can be overridden at linter level | {"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 | install | List of apk, dockerfile instructions, npm/pip/gem packages required to use the descriptor linters | {"default": {}, "examples": [{"apk": ["openjdk11"]}, {"dockerfile": ["ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk", "ENV PATH=\"$JAVA_HOME/bin:${PATH}\""]}, {"npm": ["sfdx-cli"]}], "properties": {"apk": {"examples": [["openjdk11"]], "items": {"type": "string"}, "type": "array"}, "cargo": {"items": {"type": "string"}, "type": "array"}, "dockerfile": {"examples": [["ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk", "ENV PATH=\"$JAVA_HOME/bin:${PATH}\""]], "items": {"type": "string"}, "type": "array"}, "gem": {"items": {"type": "string"}, "type": "array"}, "npm": {"examples": [["sfdx-cli"]], "items": {"type": "string"}, "type": "array"}, "pip": {"items": {"type": "string"}, "type": "array"}}, "type": "object"} |
megalinter-descriptor.jsonschema.json | apk | APK packages identifiers (with or without version) | {"examples": [["openjdk11"]], "items": {"type": "string"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | cargo | Cargo packages identifiers (with or without version) | {"items": {"type": "string"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | dockerfile | Will be automatically integrated in generated Dockerfile | {"examples": [["ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk", "ENV PATH=\"$JAVA_HOME/bin:${PATH}\""]], "items": {"type": "string"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | gem | GEM packages identifiers (with or without version) | {"items": {"type": "string"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | npm | NPM packages identifiers (with or without version) | {"examples": [["sfdx-cli"]], "items": {"type": "string"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | pip | PIP packages identifiers (with or without version) | {"items": {"type": "string"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | lint_all_files | If set to true, this descriptor linters 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 | linters | List of linter definitions associated to the descriptor | {"examples": [[{"cli_config_extra_args": ["--no-eslintrc", "--no-ignore"], "config_file_name": ".eslintrc.yml", "examples": ["eslint myfile.js", "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"], "install": {"npm": ["eslint", "eslint-config-airbnb", "eslint-config-prettier", "eslint-plugin-jest", "eslint-plugin-prettier", "@babel/eslint-parser"]}, "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png", "linter_name": "eslint", "linter_url": "https://eslint.org", "name": "JAVASCRIPT_ES"}, {"examples": ["standard myfile.js"], "install": {"npm": ["standard"]}, "linter_banner_image_url": "https://github.com/standard/standard/raw/master/sticker.png", "linter_name": "standard", "linter_url": "https://github.com/standard/standard", "name": "JAVASCRIPT_STANDARD"}]], "items": {"additionalProperties": false, "examples": [{"cli_config_extra_args": ["--no-eslintrc", "--no-ignore"], "config_file_name": ".eslintrc.yml", "examples": ["eslint myfile.js", "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"], "install": {"npm": ["eslint", "eslint-config-airbnb", "eslint-config-prettier", "eslint-plugin-jest", "eslint-plugin-prettier", "babel-eslint"]}, "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png", "linter_name": "eslint", "linter_url": "https://eslint.org", "name": "JAVASCRIPT_ES"}], "properties": {"activation_rules": {"default": [], "examples": [[{"default_value": "standard", "expected_value": "prettier", "type": "variable", "variable": "JAVASCRIPT_DEFAULT_STYLE"}]], "items": {"type": "object"}, "type": "array"}, "active_only_if_file_found": {"examples": [[".editorconfig", ".eslintrc.json"]], "items": {"type": "string"}, "type": "array"}, "can_output_sarif": {"default": false, "type": "boolean"}, "class": {"examples": ["CSpellLinter", "DotnetFormatLinter", "RakuLinter"], "type": "string"}, "cli_config_arg_name": {"type": "string"}, "cli_config_default_value": {"type": "string"}, "cli_config_extra_args": {"default": [], "examples": [["--no-eslintrc", "--no-ignore"]], "items": {"type": "string"}, "type": "array"}, "cli_docker_args": {"default": [], "examples": [["-v", "`pwd`:`pwd`", "-w", "`pwd`"]], "items": {"type": "string"}, "type": "array"}, "cli_docker_image": {"examples": ["norionomura/swiftlint"], "type": "string"}, "cli_docker_image_version": {"default": "latest", "examples": ["0.42.0_swift-5.3.2"], "type": "string"}, "cli_executable": {"type": "string"}, "cli_executable_help": {"type": "string"}, "cli_executable_version": {"type": "string"}, "cli_help_arg_name": {"type": "string"}, "cli_help_extra_args": {"items": {"type": "string"}, "type": "array"}, "cli_help_extra_commands": {"items": {"type": "string"}, "type": "array"}, "cli_lint_errors_count": {"enum": ["regex_number", "regex_count", "regex_sum", "total_lines", "sarif"], "examples": ["regex_number", "regex_count", "regex_sum", "total_lines"], "type": "string"}, "cli_lint_errors_regex": {"examples": ["Issues found: (.*) in .* files"], "type": "string"}, "cli_lint_extra_args": {"default": [], "items": {"type": "string"}, "type": "array"}, "cli_lint_extra_args_after": {"default": [], "items": {"type": "string"}, "type": "array"}, "cli_lint_fix_arg_name": {"examples": ["--fix", "--format"], "type": "string"}, "cli_lint_fix_remove_args": {"default": [], "examples": [["--check"]], "items": {"type": "string"}, "type": "array"}, "cli_lint_ignore_arg_name": {"examples": ["--secretlintignore", "--ignore-path"], "type": "string"}, "cli_lint_mode": {"default": "file", "enum": ["file", "project", "list_of_files"], "type": "string"}, "cli_sarif_args": {"default": [], "examples": [["--format", "sarif", "--output", "{{SARIF_OUTPUT_FILE}}"]], "items": {"type": "string"}, "type": "array"}, "cli_version_arg_name": {"type": "string"}, "cli_version_extra_args": {"items": {"type": "string"}, "type": "array"}, "config_file_name": {"examples": [".eslintrc.yml", ".markdown-lint.yml", ".python-black"], "type": "string"}, "deprecated": {"default": false, "type": "boolean"}, "deprecated_description": {"default": "", "type": "string"}, "descriptor_flavors": {"default": [], "examples": [["all_flavors", "java", "php"]], "items": {}, "type": "array"}, "descriptor_flavors_exclude": {"default": [], "examples": [["all_flavors", "java", "php"]], "items": {}, "type": "array"}, "disabled": {"default": false, "type": "boolean"}, "downgraded_reason": {"default": false, "type": "string"}, "downgraded_version": {"default": false, "type": "boolean"}, "examples": {"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"}, "file_extensions": {"default": [], "examples": [[".py", ""]], "items": {"type": "string"}, "type": "array"}, "file_names_not_ends_with": {"default": [], "examples": [["vault.yml", "galaxy.xml"]], "items": {"type": "string"}, "type": "array"}, "file_names_regex": {"default": [], "examples": [["Dockerfile(-.+)?", "Jenkinsfile"]], "items": {"type": "string"}, "type": "array"}, "files_sub_directory": {"examples": [["ansible", "kubernetes"]], "type": "string"}, "help_command_return_code": {"type": "number"}, "ide": {"type": "object"}, "ignore_file_name": {"examples": [".eslintignore", ".secretlintignore"], "type": "string"}, "ignore_for_flavor_suggestions": {"default": false, "examples": [".eslintignore", ".secretlintignore"], "type": "boolean"}, "install": {"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": {"apk": {"examples": [["perl", "perl-dev"]], "items": {"type": "string"}, "type": "array"}, "cargo": {"examples": [["clippy", "sarif-fmt"]], "items": {"type": "string"}, "type": "array"}, "dockerfile": {"examples": [["FROM accurics/terrascan:latest as terrascan", "COPY --from=terrascan /go/bin/terrascan /usr/bin/", "RUN terrascan init"]], "items": {"type": "string"}, "type": "array"}, "gem": {"examples": [["rubocop:0.82.0", "rubocop-github:0.16.0", "rubocop-performance"]], "items": {"type": "string"}, "type": "array"}, "npm": {"examples": [["eslint", "[email protected]"]], "items": {"type": "string"}, "type": "array"}, "pip": {"examples": [["flake8"]], "items": {"type": "string"}, "type": "array"}}, "type": "object"}, "is_formatter": {"default": false, "type": "boolean"}, "is_sbom": {"default": false, "type": "boolean"}, "lint_all_files": {"default": false, "type": "boolean"}, "lint_all_other_linters_files": {"default": false, "type": "boolean"}, "linter_banner_image_url": {"examples": ["https://github.com/stylelint/stylelint/raw/main/identity/stylelint-icon-and-text-white.png"], "format": "uri", "type": "string"}, "linter_help_cache": {"type": "string"}, "linter_icon_png_url": {"examples": ["https://github.com/stylelint/stylelint/raw/main/identity/stylelint-icon-and-text-white.png"], "format": "uri", "type": "string"}, "linter_image_url": {"examples": ["https://raku.org/camelia-logo.png"], "format": "uri", "type": "string"}, "linter_megalinter_ref_url": {"type": "string"}, "linter_name": {"examples": ["eslint"], "type": "string"}, "linter_repo": {"examples": ["https://github.com/eslint/eslint"], "format": "uri", "type": "string"}, "linter_rules_configuration_url": {"format": "uri", "type": "string"}, "linter_rules_ignore_config_url": {"format": "uri", "type": "string"}, "linter_rules_inline_disable_url": {"format": "uri", "type": "string"}, "linter_rules_url": {"format": "uri", "type": "string"}, "linter_spdx_license": {"type": "string"}, "linter_speed": {"enum": [1, 2, 3, 4, 5], "type": "number"}, "linter_text": {"type": "string"}, "linter_url": {"examples": ["https://eslint.org"], "format": "uri", "type": "string"}, "linter_version_cache": {"type": "string"}, "name": {"examples": ["JAVASCRIPT_ES"], "type": "string"}, "post_commands": {"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"}, "pre_commands": {"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"}, "sarif_default_output_file": {"examples": [["./results.sarif"]], "type": "string"}, "test_folder": {"examples": [["bash_shfmt", "terraform_terrascan"]], "type": "string"}, "test_variables": {"examples": [{"JAVASCRIPT_DEFAULT_STYLE": "prettier"}], "type": "object"}, "variables": {"examples": [{"default_value": "false", "name": "ERROR_ON_MISSING_EXEC_BIT"}], "type": "array"}, "version_command_return_code": {"type": "number"}, "version_extract_regex": {"examples": ["(?<=npm-groovy-lint version )\\d+(\\.\\d+)+"], "type": "string"}}, "required": ["linter_name", "linter_url", "examples"], "type": "object"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | items | Parameters defining behaviour and installation of a linter | {"additionalProperties": false, "examples": [{"cli_config_extra_args": ["--no-eslintrc", "--no-ignore"], "config_file_name": ".eslintrc.yml", "examples": ["eslint myfile.js", "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"], "install": {"npm": ["eslint", "eslint-config-airbnb", "eslint-config-prettier", "eslint-plugin-jest", "eslint-plugin-prettier", "babel-eslint"]}, "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png", "linter_name": "eslint", "linter_url": "https://eslint.org", "name": "JAVASCRIPT_ES"}], "properties": {"activation_rules": {"default": [], "examples": [[{"default_value": "standard", "expected_value": "prettier", "type": "variable", "variable": "JAVASCRIPT_DEFAULT_STYLE"}]], "items": {"type": "object"}, "type": "array"}, "active_only_if_file_found": {"examples": [[".editorconfig", ".eslintrc.json"]], "items": {"type": "string"}, "type": "array"}, "can_output_sarif": {"default": false, "type": "boolean"}, "class": {"examples": ["CSpellLinter", "DotnetFormatLinter", "RakuLinter"], "type": "string"}, "cli_config_arg_name": {"type": "string"}, "cli_config_default_value": {"type": "string"}, "cli_config_extra_args": {"default": [], "examples": [["--no-eslintrc", "--no-ignore"]], "items": {"type": "string"}, "type": "array"}, "cli_docker_args": {"default": [], "examples": [["-v", "`pwd`:`pwd`", "-w", "`pwd`"]], "items": {"type": "string"}, "type": "array"}, "cli_docker_image": {"examples": ["norionomura/swiftlint"], "type": "string"}, "cli_docker_image_version": {"default": "latest", "examples": ["0.42.0_swift-5.3.2"], "type": "string"}, "cli_executable": {"type": "string"}, "cli_executable_help": {"type": "string"}, "cli_executable_version": {"type": "string"}, "cli_help_arg_name": {"type": "string"}, "cli_help_extra_args": {"items": {"type": "string"}, "type": "array"}, "cli_help_extra_commands": {"items": {"type": "string"}, "type": "array"}, "cli_lint_errors_count": {"enum": ["regex_number", "regex_count", "regex_sum", "total_lines", "sarif"], "examples": ["regex_number", "regex_count", "regex_sum", "total_lines"], "type": "string"}, "cli_lint_errors_regex": {"examples": ["Issues found: (.*) in .* files"], "type": "string"}, "cli_lint_extra_args": {"default": [], "items": {"type": "string"}, "type": "array"}, "cli_lint_extra_args_after": {"default": [], "items": {"type": "string"}, "type": "array"}, "cli_lint_fix_arg_name": {"examples": ["--fix", "--format"], "type": "string"}, "cli_lint_fix_remove_args": {"default": [], "examples": [["--check"]], "items": {"type": "string"}, "type": "array"}, "cli_lint_ignore_arg_name": {"examples": ["--secretlintignore", "--ignore-path"], "type": "string"}, "cli_lint_mode": {"default": "file", "enum": ["file", "project", "list_of_files"], "type": "string"}, "cli_sarif_args": {"default": [], "examples": [["--format", "sarif", "--output", "{{SARIF_OUTPUT_FILE}}"]], "items": {"type": "string"}, "type": "array"}, "cli_version_arg_name": {"type": "string"}, "cli_version_extra_args": {"items": {"type": "string"}, "type": "array"}, "config_file_name": {"examples": [".eslintrc.yml", ".markdown-lint.yml", ".python-black"], "type": "string"}, "deprecated": {"default": false, "type": "boolean"}, "deprecated_description": {"default": "", "type": "string"}, "descriptor_flavors": {"default": [], "examples": [["all_flavors", "java", "php"]], "items": {}, "type": "array"}, "descriptor_flavors_exclude": {"default": [], "examples": [["all_flavors", "java", "php"]], "items": {}, "type": "array"}, "disabled": {"default": false, "type": "boolean"}, "downgraded_reason": {"default": false, "type": "string"}, "downgraded_version": {"default": false, "type": "boolean"}, "examples": {"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"}, "file_extensions": {"default": [], "examples": [[".py", ""]], "items": {"type": "string"}, "type": "array"}, "file_names_not_ends_with": {"default": [], "examples": [["vault.yml", "galaxy.xml"]], "items": {"type": "string"}, "type": "array"}, "file_names_regex": {"default": [], "examples": [["Dockerfile(-.+)?", "Jenkinsfile"]], "items": {"type": "string"}, "type": "array"}, "files_sub_directory": {"examples": [["ansible", "kubernetes"]], "type": "string"}, "help_command_return_code": {"type": "number"}, "ide": {"type": "object"}, "ignore_file_name": {"examples": [".eslintignore", ".secretlintignore"], "type": "string"}, "ignore_for_flavor_suggestions": {"default": false, "examples": [".eslintignore", ".secretlintignore"], "type": "boolean"}, "install": {"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": {"apk": {"examples": [["perl", "perl-dev"]], "items": {"type": "string"}, "type": "array"}, "cargo": {"examples": [["clippy", "sarif-fmt"]], "items": {"type": "string"}, "type": "array"}, "dockerfile": {"examples": [["FROM accurics/terrascan:latest as terrascan", "COPY --from=terrascan /go/bin/terrascan /usr/bin/", "RUN terrascan init"]], "items": {"type": "string"}, "type": "array"}, "gem": {"examples": [["rubocop:0.82.0", "rubocop-github:0.16.0", "rubocop-performance"]], "items": {"type": "string"}, "type": "array"}, "npm": {"examples": [["eslint", "[email protected]"]], "items": {"type": "string"}, "type": "array"}, "pip": {"examples": [["flake8"]], "items": {"type": "string"}, "type": "array"}}, "type": "object"}, "is_formatter": {"default": false, "type": "boolean"}, "is_sbom": {"default": false, "type": "boolean"}, "lint_all_files": {"default": false, "type": "boolean"}, "lint_all_other_linters_files": {"default": false, "type": "boolean"}, "linter_banner_image_url": {"examples": ["https://github.com/stylelint/stylelint/raw/main/identity/stylelint-icon-and-text-white.png"], "format": "uri", "type": "string"}, "linter_help_cache": {"type": "string"}, "linter_icon_png_url": {"examples": ["https://github.com/stylelint/stylelint/raw/main/identity/stylelint-icon-and-text-white.png"], "format": "uri", "type": "string"}, "linter_image_url": {"examples": ["https://raku.org/camelia-logo.png"], "format": "uri", "type": "string"}, "linter_megalinter_ref_url": {"type": "string"}, "linter_name": {"examples": ["eslint"], "type": "string"}, "linter_repo": {"examples": ["https://github.com/eslint/eslint"], "format": "uri", "type": "string"}, "linter_rules_configuration_url": {"format": "uri", "type": "string"}, "linter_rules_ignore_config_url": {"format": "uri", "type": "string"}, "linter_rules_inline_disable_url": {"format": "uri", "type": "string"}, "linter_rules_url": {"format": "uri", "type": "string"}, "linter_spdx_license": {"type": "string"}, "linter_speed": {"enum": [1, 2, 3, 4, 5], "type": "number"}, "linter_text": {"type": "string"}, "linter_url": {"examples": ["https://eslint.org"], "format": "uri", "type": "string"}, "linter_version_cache": {"type": "string"}, "name": {"examples": ["JAVASCRIPT_ES"], "type": "string"}, "post_commands": {"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"}, "pre_commands": {"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"}, "sarif_default_output_file": {"examples": [["./results.sarif"]], "type": "string"}, "test_folder": {"examples": [["bash_shfmt", "terraform_terrascan"]], "type": "string"}, "test_variables": {"examples": [{"JAVASCRIPT_DEFAULT_STYLE": "prettier"}], "type": "object"}, "variables": {"examples": [{"default_value": "false", "name": "ERROR_ON_MISSING_EXEC_BIT"}], "type": "array"}, "version_command_return_code": {"type": "number"}, "version_extract_regex": {"examples": ["(?<=npm-groovy-lint version )\\d+(\\.\\d+)+"], "type": "string"}}, "required": ["linter_name", "linter_url", "examples"], "type": "object"} |
megalinter-descriptor.jsonschema.json | activation_rules | List of rules to check to activate linter | {"default": [], "examples": [[{"default_value": "standard", "expected_value": "prettier", "type": "variable", "variable": "JAVASCRIPT_DEFAULT_STYLE"}]], "items": {"type": "object"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | active_only_if_file_found | Names of the config files to be found (at least one), else descriptor will be deactivated | {"examples": [[".editorconfig", ".eslintrc.json"]], "items": {"type": "string"}, "type": "array"} |
megalinter-descriptor.jsonschema.json | can_output_sarif | Shows if the linter is capable of output SARIF report within MegaLinter | {"default": false, "type": "boolean"} |
megalinter-descriptor.jsonschema.json | class | If MegaLinter core is not enough, use a custom class inheriting from Linter class | {"examples": ["CSpellLinter", "DotnetFormatLinter", "RakuLinter"], "type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.