Type object
File match .mega-linter.yml .megalinter.yml *.mega-linter-config.yml *.megalinter-config.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/megalinter-configuration/latest.json
Source https://raw.githubusercontent.com/megalinter/megalinter/main/megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

MegaLinter configuration file

Properties

ACTION_ACTIONLINT_ARGUMENTS array | string

ACTION_ACTIONLINT: User custom arguments to add in linter CLI call

ACTION_ACTIONLINT_CLI_EXECUTABLE string[]

ACTION_ACTIONLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "actionlint"
  ]
]
ACTION_ACTIONLINT_CLI_LINT_MODE string

ACTION_ACTIONLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
ACTION_ACTIONLINT_COMMAND_REMOVE_ARGUMENTS array | string

ACTION_ACTIONLINT: User custom arguments to remove before calling linter

ACTION_ACTIONLINT_CONFIG_FILE string

ACTION_ACTIONLINT: User custom config file name if different from default

Default: "actionlint.yml"
ACTION_ACTIONLINT_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: ".github/workflows"
ACTION_ACTIONLINT_DISABLE_ERRORS boolean

ACTION_ACTIONLINT: If true, ACTION_ACTIONLINT doesn't make MegaLinter fail even if errors are found

Default: false
ACTION_ACTIONLINT_DISABLE_ERRORS_IF_LESS_THAN number

ACTION_ACTIONLINT: If the number of errors found is less than this value, ACTION_ACTIONLINT doesn't make MegaLinter fail

Default: 0
ACTION_ACTIONLINT_FILE_EXTENSIONS string[]

ACTION_ACTIONLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".yml",
  ".yaml"
]
Examples: ".py", ".myext"
ACTION_ACTIONLINT_FILE_NAMES_REGEX string[]

ACTION_ACTIONLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
ACTION_ACTIONLINT_FILTER_REGEX_EXCLUDE string

ACTION_ACTIONLINT: Custom regex excluding filter: files matching this regex will NOT be linted

ACTION_ACTIONLINT_FILTER_REGEX_INCLUDE string

ACTION_ACTIONLINT: Custom regex including filter: only files matching this regex will be linted

ACTION_ACTIONLINT_POST_COMMANDS command_info[]

ACTION_ACTIONLINT: Define bash commands to run after running ACTION_ACTIONLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
ACTION_ACTIONLINT_PRE_COMMANDS command_info[]

ACTION_ACTIONLINT: Define bash commands to run before running ACTION_ACTIONLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
ACTION_ACTIONLINT_RULES_PATH string

ACTION_ACTIONLINT: Path where to find linter configuration file

ACTION_ACTIONLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling ACTION_ACTIONLINT and its pre/post commands

Default:
[]
ACTION_FILTER_REGEX_EXCLUDE string

ACTION: Custom regex excluding filter: files matching this regex will NOT be linted

ACTION_FILTER_REGEX_INCLUDE string

ACTION: Custom regex including filter: only files matching this regex will be linted

ACTION_POST_COMMANDS command_info[]

ACTION: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
ACTION_PRE_COMMANDS command_info[]

ACTION: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
ADDITIONAL_EXCLUDED_DIRECTORIES string[]

List of additional excluded directory basenames to add to MegaLinter default excluded directories. They are excluded at any nested level.

Examples: ["test"]
ANSIBLE_ANSIBLE_LINT_ARGUMENTS array | string

ANSIBLE_ANSIBLE_LINT: User custom arguments to add in linter CLI call

ANSIBLE_ANSIBLE_LINT_CLI_EXECUTABLE string[]

ANSIBLE_ANSIBLE_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "ansible-lint"
  ]
]
ANSIBLE_ANSIBLE_LINT_CLI_LINT_MODE string

ANSIBLE_ANSIBLE_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
ANSIBLE_ANSIBLE_LINT_COMMAND_REMOVE_ARGUMENTS array | string

ANSIBLE_ANSIBLE_LINT: User custom arguments to remove before calling linter

ANSIBLE_ANSIBLE_LINT_CONFIG_FILE string

ANSIBLE_ANSIBLE_LINT: User custom config file name if different from default

Default: ".ansible-lint"
ANSIBLE_ANSIBLE_LINT_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: "ansible"
ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS boolean

ANSIBLE_ANSIBLE_LINT: If true, ANSIBLE_ANSIBLE_LINT doesn't make MegaLinter fail even if errors are found

Default: false
ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS_IF_LESS_THAN number

ANSIBLE_ANSIBLE_LINT: If the number of errors found is less than this value, ANSIBLE_ANSIBLE_LINT doesn't make MegaLinter fail

Default: 0
ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS string[]

ANSIBLE_ANSIBLE_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".yml",
  ".yaml"
]
Examples: ".py", ".myext"
ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX string[]

ANSIBLE_ANSIBLE_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
ANSIBLE_ANSIBLE_LINT_POST_COMMANDS command_info[]

ANSIBLE_ANSIBLE_LINT: Define bash commands to run after running ANSIBLE_ANSIBLE_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS command_info[]

ANSIBLE_ANSIBLE_LINT: Define bash commands to run before running ANSIBLE_ANSIBLE_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
ANSIBLE_ANSIBLE_LINT_RULES_PATH string

ANSIBLE_ANSIBLE_LINT: Path where to find linter configuration file

ANSIBLE_ANSIBLE_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling ANSIBLE_ANSIBLE_LINT and its pre/post commands

Default:
[]
ANSIBLE_DIRECTORY string
Default: "ansible"
ANSIBLE_FILTER_REGEX_EXCLUDE string

ANSIBLE: Custom regex excluding filter: files matching this regex will NOT be linted

ANSIBLE_FILTER_REGEX_INCLUDE string

ANSIBLE: Custom regex including filter: only files matching this regex will be linted

ANSIBLE_POST_COMMANDS command_info[]

ANSIBLE: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
ANSIBLE_PRE_COMMANDS command_info[]

ANSIBLE: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
API_FILTER_REGEX_EXCLUDE string

API: Custom regex excluding filter: files matching this regex will NOT be linted

API_FILTER_REGEX_INCLUDE string

API: Custom regex including filter: only files matching this regex will be linted

API_POST_COMMANDS command_info[]

API: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
API_PRE_COMMANDS command_info[]

API: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
API_SPECTRAL_ARGUMENTS array | string

API_SPECTRAL: User custom arguments to add in linter CLI call

API_SPECTRAL_CLI_EXECUTABLE string[]

API_SPECTRAL: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "spectral"
  ]
]
API_SPECTRAL_CLI_LINT_MODE string

API_SPECTRAL: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
API_SPECTRAL_COMMAND_REMOVE_ARGUMENTS array | string

API_SPECTRAL: User custom arguments to remove before calling linter

API_SPECTRAL_CONFIG_FILE string

API_SPECTRAL: User custom config file name if different from default

Default: ".spectral.yaml"
API_SPECTRAL_DISABLE_ERRORS boolean

API_SPECTRAL: If true, API_SPECTRAL doesn't make MegaLinter fail even if errors are found

Default: false
API_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN number

API_SPECTRAL: If the number of errors found is less than this value, API_SPECTRAL doesn't make MegaLinter fail

Default: 0
API_SPECTRAL_FILE_EXTENSIONS string[]

API_SPECTRAL: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".yml",
  ".yaml",
  ".json"
]
Examples: ".py", ".myext"
API_SPECTRAL_FILE_NAMES_REGEX string[]

API_SPECTRAL: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
API_SPECTRAL_FILTER_REGEX_EXCLUDE string

API_SPECTRAL: Custom regex excluding filter: files matching this regex will NOT be linted

API_SPECTRAL_FILTER_REGEX_INCLUDE string

API_SPECTRAL: Custom regex including filter: only files matching this regex will be linted

API_SPECTRAL_POST_COMMANDS command_info[]

API_SPECTRAL: Define bash commands to run after running API_SPECTRAL

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
API_SPECTRAL_PRE_COMMANDS command_info[]

API_SPECTRAL: Define bash commands to run before running API_SPECTRAL

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
API_SPECTRAL_RULES_PATH string

API_SPECTRAL: Path where to find linter configuration file

API_SPECTRAL_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling API_SPECTRAL and its pre/post commands

Default:
[]
APPLY_FIXES array | string

'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"]
ARM_ARM_TTK_ARGUMENTS array | string

ARM_ARM_TTK: User custom arguments to add in linter CLI call

ARM_ARM_TTK_CLI_EXECUTABLE string[]

ARM_ARM_TTK: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "arm-ttk"
  ]
]
ARM_ARM_TTK_CLI_LINT_MODE string

ARM_ARM_TTK: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
ARM_ARM_TTK_COMMAND_REMOVE_ARGUMENTS array | string

ARM_ARM_TTK: User custom arguments to remove before calling linter

ARM_ARM_TTK_CONFIG_FILE string

ARM_ARM_TTK: User custom config file name if different from default

Default: ".arm-ttk.psd1"
ARM_ARM_TTK_DISABLE_ERRORS boolean

ARM_ARM_TTK: If true, ARM_ARM_TTK doesn't make MegaLinter fail even if errors are found

Default: false
ARM_ARM_TTK_DISABLE_ERRORS_IF_LESS_THAN number

ARM_ARM_TTK: If the number of errors found is less than this value, ARM_ARM_TTK doesn't make MegaLinter fail

Default: 0
ARM_ARM_TTK_FILE_EXTENSIONS string[]

ARM_ARM_TTK: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".json"
]
Examples: ".py", ".myext"
ARM_ARM_TTK_FILE_NAMES_REGEX string[]

ARM_ARM_TTK: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
ARM_ARM_TTK_FILTER_REGEX_EXCLUDE string

ARM_ARM_TTK: Custom regex excluding filter: files matching this regex will NOT be linted

ARM_ARM_TTK_FILTER_REGEX_INCLUDE string

ARM_ARM_TTK: Custom regex including filter: only files matching this regex will be linted

ARM_ARM_TTK_POST_COMMANDS command_info[]

ARM_ARM_TTK: Define bash commands to run after running ARM_ARM_TTK

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
ARM_ARM_TTK_PRE_COMMANDS command_info[]

ARM_ARM_TTK: Define bash commands to run before running ARM_ARM_TTK

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
ARM_ARM_TTK_RULES_PATH string

ARM_ARM_TTK: Path where to find linter configuration file

ARM_ARM_TTK_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling ARM_ARM_TTK and its pre/post commands

Default:
[]
ARM_FILTER_REGEX_EXCLUDE string

ARM: Custom regex excluding filter: files matching this regex will NOT be linted

ARM_FILTER_REGEX_INCLUDE string

ARM: Custom regex including filter: only files matching this regex will be linted

ARM_POST_COMMANDS command_info[]

ARM: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
ARM_PRE_COMMANDS command_info[]

ARM: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
AZURE_COMMENT_REPORTER boolean

Posts MegaLinter results summary in the comments of the related pull request (if existing)

Default: true
BASH_EXEC_ARGUMENTS array | string

BASH_EXEC: User custom arguments to add in linter CLI call

BASH_EXEC_CLI_EXECUTABLE string[]

BASH_EXEC: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "bash-exec"
  ]
]
BASH_EXEC_CLI_LINT_MODE string

BASH_EXEC: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
BASH_EXEC_COMMAND_REMOVE_ARGUMENTS array | string

BASH_EXEC: User custom arguments to remove before calling linter

BASH_EXEC_DISABLE_ERRORS boolean

BASH_EXEC: If true, BASH_EXEC doesn't make MegaLinter fail even if errors are found

Default: false
BASH_EXEC_DISABLE_ERRORS_IF_LESS_THAN number

BASH_EXEC: If the number of errors found is less than this value, BASH_EXEC doesn't make MegaLinter fail

Default: 0
BASH_EXEC_FILE_EXTENSIONS string[]

BASH_EXEC: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  "",
  ".sh",
  ".bash",
  ".dash",
  ".ksh"
]
Examples: ".py", ".myext"
BASH_EXEC_FILE_NAMES_REGEX string[]

BASH_EXEC: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
BASH_EXEC_FILTER_REGEX_EXCLUDE string

BASH_EXEC: Custom regex excluding filter: files matching this regex will NOT be linted

BASH_EXEC_FILTER_REGEX_INCLUDE string

BASH_EXEC: Custom regex including filter: only files matching this regex will be linted

BASH_EXEC_POST_COMMANDS command_info[]

BASH_EXEC: Define bash commands to run after running BASH_EXEC

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
BASH_EXEC_PRE_COMMANDS command_info[]

BASH_EXEC: Define bash commands to run before running BASH_EXEC

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
BASH_EXEC_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling BASH_EXEC and its pre/post commands

Default:
[]
BASH_FILTER_REGEX_EXCLUDE string

BASH: Custom regex excluding filter: files matching this regex will NOT be linted

BASH_FILTER_REGEX_INCLUDE string

BASH: Custom regex including filter: only files matching this regex will be linted

BASH_POST_COMMANDS command_info[]

BASH: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
BASH_PRE_COMMANDS command_info[]

BASH: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
BASH_SHELLCHECK_ARGUMENTS array | string

BASH_SHELLCHECK: User custom arguments to add in linter CLI call

BASH_SHELLCHECK_CLI_EXECUTABLE string[]

BASH_SHELLCHECK: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "shellcheck"
  ]
]
BASH_SHELLCHECK_CLI_LINT_MODE string

BASH_SHELLCHECK: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
BASH_SHELLCHECK_COMMAND_REMOVE_ARGUMENTS array | string

BASH_SHELLCHECK: User custom arguments to remove before calling linter

BASH_SHELLCHECK_DISABLE_ERRORS boolean

BASH_SHELLCHECK: If true, BASH_SHELLCHECK doesn't make MegaLinter fail even if errors are found

Default: false
BASH_SHELLCHECK_DISABLE_ERRORS_IF_LESS_THAN number

BASH_SHELLCHECK: If the number of errors found is less than this value, BASH_SHELLCHECK doesn't make MegaLinter fail

Default: 0
BASH_SHELLCHECK_FILE_EXTENSIONS string[]

BASH_SHELLCHECK: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  "",
  ".sh",
  ".bash",
  ".dash",
  ".ksh"
]
Examples: ".py", ".myext"
BASH_SHELLCHECK_FILE_NAMES_REGEX string[]

BASH_SHELLCHECK: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
BASH_SHELLCHECK_FILTER_REGEX_EXCLUDE string

BASH_SHELLCHECK: Custom regex excluding filter: files matching this regex will NOT be linted

BASH_SHELLCHECK_FILTER_REGEX_INCLUDE string

BASH_SHELLCHECK: Custom regex including filter: only files matching this regex will be linted

BASH_SHELLCHECK_POST_COMMANDS command_info[]

BASH_SHELLCHECK: Define bash commands to run after running BASH_SHELLCHECK

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
BASH_SHELLCHECK_PRE_COMMANDS command_info[]

BASH_SHELLCHECK: Define bash commands to run before running BASH_SHELLCHECK

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
BASH_SHELLCHECK_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling BASH_SHELLCHECK and its pre/post commands

Default:
[]
BASH_SHFMT_ARGUMENTS array | string

BASH_SHFMT: User custom arguments to add in linter CLI call

BASH_SHFMT_CLI_EXECUTABLE string[]

BASH_SHFMT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "shfmt"
  ]
]
BASH_SHFMT_CLI_LINT_MODE string

BASH_SHFMT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
BASH_SHFMT_COMMAND_REMOVE_ARGUMENTS array | string

BASH_SHFMT: User custom arguments to remove before calling linter

BASH_SHFMT_DISABLE_ERRORS boolean

BASH_SHFMT: If true, BASH_SHFMT doesn't make MegaLinter fail even if errors are found

Default: false
BASH_SHFMT_DISABLE_ERRORS_IF_LESS_THAN number

BASH_SHFMT: If the number of errors found is less than this value, BASH_SHFMT doesn't make MegaLinter fail

Default: 0
BASH_SHFMT_FILE_EXTENSIONS string[]

BASH_SHFMT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  "",
  ".sh",
  ".bash",
  ".dash",
  ".ksh"
]
Examples: ".py", ".myext"
BASH_SHFMT_FILE_NAMES_REGEX string[]

BASH_SHFMT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
BASH_SHFMT_FILTER_REGEX_EXCLUDE string

BASH_SHFMT: Custom regex excluding filter: files matching this regex will NOT be linted

BASH_SHFMT_FILTER_REGEX_INCLUDE string

BASH_SHFMT: Custom regex including filter: only files matching this regex will be linted

BASH_SHFMT_POST_COMMANDS command_info[]

BASH_SHFMT: Define bash commands to run after running BASH_SHFMT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
BASH_SHFMT_PRE_COMMANDS command_info[]

BASH_SHFMT: Define bash commands to run before running BASH_SHFMT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
BASH_SHFMT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling BASH_SHFMT and its pre/post commands

Default:
[]
BICEP_BICEP_LINTER_ARGUMENTS array | string

BICEP_BICEP_LINTER: User custom arguments to add in linter CLI call

BICEP_BICEP_LINTER_CLI_EXECUTABLE string[]

BICEP_BICEP_LINTER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "bicep"
  ]
]
BICEP_BICEP_LINTER_CLI_LINT_MODE string

BICEP_BICEP_LINTER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
BICEP_BICEP_LINTER_COMMAND_REMOVE_ARGUMENTS array | string

BICEP_BICEP_LINTER: User custom arguments to remove before calling linter

BICEP_BICEP_LINTER_DISABLE_ERRORS boolean

BICEP_BICEP_LINTER: If true, BICEP_BICEP_LINTER doesn't make MegaLinter fail even if errors are found

Default: false
BICEP_BICEP_LINTER_DISABLE_ERRORS_IF_LESS_THAN number

BICEP_BICEP_LINTER: If the number of errors found is less than this value, BICEP_BICEP_LINTER doesn't make MegaLinter fail

Default: 0
BICEP_BICEP_LINTER_FILE_EXTENSIONS string[]

BICEP_BICEP_LINTER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".bicep"
]
Examples: ".py", ".myext"
BICEP_BICEP_LINTER_FILE_NAMES_REGEX string[]

BICEP_BICEP_LINTER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
BICEP_BICEP_LINTER_FILTER_REGEX_EXCLUDE string

BICEP_BICEP_LINTER: Custom regex excluding filter: files matching this regex will NOT be linted

BICEP_BICEP_LINTER_FILTER_REGEX_INCLUDE string

BICEP_BICEP_LINTER: Custom regex including filter: only files matching this regex will be linted

BICEP_BICEP_LINTER_POST_COMMANDS command_info[]

BICEP_BICEP_LINTER: Define bash commands to run after running BICEP_BICEP_LINTER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
BICEP_BICEP_LINTER_PRE_COMMANDS command_info[]

BICEP_BICEP_LINTER: Define bash commands to run before running BICEP_BICEP_LINTER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
BICEP_BICEP_LINTER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling BICEP_BICEP_LINTER and its pre/post commands

Default:
[]
BICEP_FILTER_REGEX_EXCLUDE string

BICEP: Custom regex excluding filter: files matching this regex will NOT be linted

BICEP_FILTER_REGEX_INCLUDE string

BICEP: Custom regex including filter: only files matching this regex will be linted

BICEP_POST_COMMANDS command_info[]

BICEP: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
BICEP_PRE_COMMANDS command_info[]

BICEP: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
BITBUCKET_COMMENT_REPORTER boolean

Posts Mega-Linter results summary in the comments of the related pull request (if existing)

Default: true
BITBUCKET_COMMENT_REPORTER_OVERWRITE_COMMENT boolean

Set to false to disable the overwrite of existing MegaLinter Pull Request comment in case of new run

Default: true
CLEAR_REPORT_FOLDER boolean

Flag to clear files from report folder (usually megalinter-reports) before starting the linting process

Default: false
CLOJURE_CLJSTYLE_ARGUMENTS array | string

CLOJURE_CLJSTYLE: User custom arguments to add in linter CLI call

CLOJURE_CLJSTYLE_CLI_EXECUTABLE string[]

CLOJURE_CLJSTYLE: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "cljstyle"
  ]
]
CLOJURE_CLJSTYLE_CLI_LINT_MODE string

CLOJURE_CLJSTYLE: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
CLOJURE_CLJSTYLE_COMMAND_REMOVE_ARGUMENTS array | string

CLOJURE_CLJSTYLE: User custom arguments to remove before calling linter

CLOJURE_CLJSTYLE_CONFIG_FILE string

CLOJURE_CLJSTYLE: User custom config file name if different from default

Default: ".cljstyle"
CLOJURE_CLJSTYLE_DISABLE_ERRORS boolean

CLOJURE_CLJSTYLE: If true, CLOJURE_CLJSTYLE doesn't make MegaLinter fail even if errors are found

Default: false
CLOJURE_CLJSTYLE_DISABLE_ERRORS_IF_LESS_THAN number

CLOJURE_CLJSTYLE: If the number of errors found is less than this value, CLOJURE_CLJSTYLE doesn't make MegaLinter fail

Default: 0
CLOJURE_CLJSTYLE_FILE_EXTENSIONS string[]

CLOJURE_CLJSTYLE: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".clj",
  ".cljs",
  ".cljc",
  ".edn"
]
Examples: ".py", ".myext"
CLOJURE_CLJSTYLE_FILE_NAMES_REGEX string[]

CLOJURE_CLJSTYLE: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
CLOJURE_CLJSTYLE_FILTER_REGEX_EXCLUDE string

CLOJURE_CLJSTYLE: Custom regex excluding filter: files matching this regex will NOT be linted

CLOJURE_CLJSTYLE_FILTER_REGEX_INCLUDE string

CLOJURE_CLJSTYLE: Custom regex including filter: only files matching this regex will be linted

CLOJURE_CLJSTYLE_POST_COMMANDS command_info[]

CLOJURE_CLJSTYLE: Define bash commands to run after running CLOJURE_CLJSTYLE

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CLOJURE_CLJSTYLE_PRE_COMMANDS command_info[]

CLOJURE_CLJSTYLE: Define bash commands to run before running CLOJURE_CLJSTYLE

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
CLOJURE_CLJSTYLE_RULES_PATH string

CLOJURE_CLJSTYLE: Path where to find linter configuration file

CLOJURE_CLJSTYLE_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling CLOJURE_CLJSTYLE and its pre/post commands

Default:
[]
CLOJURE_CLJ_KONDO_ARGUMENTS array | string

CLOJURE_CLJ_KONDO: User custom arguments to add in linter CLI call

CLOJURE_CLJ_KONDO_CLI_EXECUTABLE string[]

CLOJURE_CLJ_KONDO: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "clj-kondo"
  ]
]
CLOJURE_CLJ_KONDO_CLI_LINT_MODE string

CLOJURE_CLJ_KONDO: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
CLOJURE_CLJ_KONDO_COMMAND_REMOVE_ARGUMENTS array | string

CLOJURE_CLJ_KONDO: User custom arguments to remove before calling linter

CLOJURE_CLJ_KONDO_CONFIG_FILE string

CLOJURE_CLJ_KONDO: User custom config file name if different from default

Default: ".clj-kondo/config.edn"
CLOJURE_CLJ_KONDO_DISABLE_ERRORS boolean

CLOJURE_CLJ_KONDO: If true, CLOJURE_CLJ_KONDO doesn't make MegaLinter fail even if errors are found

Default: false
CLOJURE_CLJ_KONDO_DISABLE_ERRORS_IF_LESS_THAN number

CLOJURE_CLJ_KONDO: If the number of errors found is less than this value, CLOJURE_CLJ_KONDO doesn't make MegaLinter fail

Default: 0
CLOJURE_CLJ_KONDO_FILE_EXTENSIONS string[]

CLOJURE_CLJ_KONDO: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".clj",
  ".cljs",
  ".cljc",
  ".edn"
]
Examples: ".py", ".myext"
CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX string[]

CLOJURE_CLJ_KONDO: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
CLOJURE_CLJ_KONDO_FILTER_REGEX_EXCLUDE string

CLOJURE_CLJ_KONDO: Custom regex excluding filter: files matching this regex will NOT be linted

CLOJURE_CLJ_KONDO_FILTER_REGEX_INCLUDE string

CLOJURE_CLJ_KONDO: Custom regex including filter: only files matching this regex will be linted

CLOJURE_CLJ_KONDO_POST_COMMANDS command_info[]

CLOJURE_CLJ_KONDO: Define bash commands to run after running CLOJURE_CLJ_KONDO

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CLOJURE_CLJ_KONDO_PRE_COMMANDS command_info[]

CLOJURE_CLJ_KONDO: Define bash commands to run before running CLOJURE_CLJ_KONDO

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
CLOJURE_CLJ_KONDO_RULES_PATH string

CLOJURE_CLJ_KONDO: Path where to find linter configuration file

CLOJURE_CLJ_KONDO_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling CLOJURE_CLJ_KONDO and its pre/post commands

Default:
[]
CLOJURE_FILTER_REGEX_EXCLUDE string

CLOJURE: Custom regex excluding filter: files matching this regex will NOT be linted

CLOJURE_FILTER_REGEX_INCLUDE string

CLOJURE: Custom regex including filter: only files matching this regex will be linted

CLOJURE_POST_COMMANDS command_info[]

CLOJURE: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CLOJURE_PRE_COMMANDS command_info[]

CLOJURE: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
CLOUDFORMATION_CFN_LINT_ARGUMENTS array | string

CLOUDFORMATION_CFN_LINT: User custom arguments to add in linter CLI call

CLOUDFORMATION_CFN_LINT_CLI_EXECUTABLE string[]

CLOUDFORMATION_CFN_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "cfn-lint"
  ]
]
CLOUDFORMATION_CFN_LINT_CLI_LINT_MODE string

CLOUDFORMATION_CFN_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
CLOUDFORMATION_CFN_LINT_COMMAND_REMOVE_ARGUMENTS array | string

CLOUDFORMATION_CFN_LINT: User custom arguments to remove before calling linter

CLOUDFORMATION_CFN_LINT_CONFIG_FILE string

CLOUDFORMATION_CFN_LINT: User custom config file name if different from default

Default: ".cfnlintrc.yml"
CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS boolean

CLOUDFORMATION_CFN_LINT: If true, CLOUDFORMATION_CFN_LINT doesn't make MegaLinter fail even if errors are found

Default: false
CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS_IF_LESS_THAN number

CLOUDFORMATION_CFN_LINT: If the number of errors found is less than this value, CLOUDFORMATION_CFN_LINT doesn't make MegaLinter fail

Default: 0
CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS string[]

CLOUDFORMATION_CFN_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".yml",
  ".yaml",
  ".json"
]
Examples: ".py", ".myext"
CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX string[]

CLOUDFORMATION_CFN_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
CLOUDFORMATION_CFN_LINT_FILTER_REGEX_EXCLUDE string

CLOUDFORMATION_CFN_LINT: Custom regex excluding filter: files matching this regex will NOT be linted

CLOUDFORMATION_CFN_LINT_FILTER_REGEX_INCLUDE string

CLOUDFORMATION_CFN_LINT: Custom regex including filter: only files matching this regex will be linted

CLOUDFORMATION_CFN_LINT_POST_COMMANDS command_info[]

CLOUDFORMATION_CFN_LINT: Define bash commands to run after running CLOUDFORMATION_CFN_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CLOUDFORMATION_CFN_LINT_PRE_COMMANDS command_info[]

CLOUDFORMATION_CFN_LINT: Define bash commands to run before running CLOUDFORMATION_CFN_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
CLOUDFORMATION_CFN_LINT_RULES_PATH string

CLOUDFORMATION_CFN_LINT: Path where to find linter configuration file

CLOUDFORMATION_CFN_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling CLOUDFORMATION_CFN_LINT and its pre/post commands

Default:
[]
CLOUDFORMATION_FILTER_REGEX_EXCLUDE string

CLOUDFORMATION: Custom regex excluding filter: files matching this regex will NOT be linted

CLOUDFORMATION_FILTER_REGEX_INCLUDE string

CLOUDFORMATION: Custom regex including filter: only files matching this regex will be linted

CLOUDFORMATION_POST_COMMANDS command_info[]

CLOUDFORMATION: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CLOUDFORMATION_PRE_COMMANDS command_info[]

CLOUDFORMATION: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
COFFEE_COFFEELINT_ARGUMENTS array | string

COFFEE_COFFEELINT: User custom arguments to add in linter CLI call

COFFEE_COFFEELINT_CLI_EXECUTABLE string[]

COFFEE_COFFEELINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "coffeelint"
  ]
]
COFFEE_COFFEELINT_CLI_LINT_MODE string

COFFEE_COFFEELINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
COFFEE_COFFEELINT_COMMAND_REMOVE_ARGUMENTS array | string

COFFEE_COFFEELINT: User custom arguments to remove before calling linter

COFFEE_COFFEELINT_CONFIG_FILE string

COFFEE_COFFEELINT: User custom config file name if different from default

Default: ".coffee-lint.json"
COFFEE_COFFEELINT_DISABLE_ERRORS boolean

COFFEE_COFFEELINT: If true, COFFEE_COFFEELINT doesn't make MegaLinter fail even if errors are found

Default: false
COFFEE_COFFEELINT_DISABLE_ERRORS_IF_LESS_THAN number

COFFEE_COFFEELINT: If the number of errors found is less than this value, COFFEE_COFFEELINT doesn't make MegaLinter fail

Default: 0
COFFEE_COFFEELINT_FILE_EXTENSIONS string[]

COFFEE_COFFEELINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".coffee"
]
Examples: ".py", ".myext"
COFFEE_COFFEELINT_FILE_NAMES_REGEX string[]

COFFEE_COFFEELINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
COFFEE_COFFEELINT_FILTER_REGEX_EXCLUDE string

COFFEE_COFFEELINT: Custom regex excluding filter: files matching this regex will NOT be linted

COFFEE_COFFEELINT_FILTER_REGEX_INCLUDE string

COFFEE_COFFEELINT: Custom regex including filter: only files matching this regex will be linted

COFFEE_COFFEELINT_POST_COMMANDS command_info[]

COFFEE_COFFEELINT: Define bash commands to run after running COFFEE_COFFEELINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
COFFEE_COFFEELINT_PRE_COMMANDS command_info[]

COFFEE_COFFEELINT: Define bash commands to run before running COFFEE_COFFEELINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
COFFEE_COFFEELINT_RULES_PATH string

COFFEE_COFFEELINT: Path where to find linter configuration file

COFFEE_COFFEELINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling COFFEE_COFFEELINT and its pre/post commands

Default:
[]
COFFEE_FILTER_REGEX_EXCLUDE string

COFFEE: Custom regex excluding filter: files matching this regex will NOT be linted

COFFEE_FILTER_REGEX_INCLUDE string

COFFEE: Custom regex including filter: only files matching this regex will be linted

COFFEE_POST_COMMANDS command_info[]

COFFEE: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
COFFEE_PRE_COMMANDS command_info[]

COFFEE: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
CONFIG_PROPERTIES_TO_APPEND string[]

List of configuration properties to append their values (instead of replacing them) in case of using EXTENDS.

Examples: ["ENABLE_LINTERS"]
CONFIG_REPORTER boolean

Generates a folder IDE-config located in report folder, containing default MegaLinter configuration files used during the linting, and updated VSCode extensions.js config file

Default: true
CONFIG_REPORTER_SUB_FOLDER string
Default: "IDE-config"
CONSOLE_REPORTER boolean
Default: true
CONSOLE_REPORTER_SECTIONS boolean

Define to false if you do not want logs to be organized in sections

Default: true
COPYPASTE_FILTER_REGEX_EXCLUDE string

COPYPASTE: Custom regex excluding filter: files matching this regex will NOT be linted

COPYPASTE_FILTER_REGEX_INCLUDE string

COPYPASTE: Custom regex including filter: only files matching this regex will be linted

COPYPASTE_JSCPD_ARGUMENTS array | string

COPYPASTE_JSCPD: User custom arguments to add in linter CLI call

COPYPASTE_JSCPD_CLI_EXECUTABLE string[]

COPYPASTE_JSCPD: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "jscpd"
  ]
]
COPYPASTE_JSCPD_CLI_LINT_MODE string

COPYPASTE_JSCPD: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
COPYPASTE_JSCPD_COMMAND_REMOVE_ARGUMENTS array | string

COPYPASTE_JSCPD: User custom arguments to remove before calling linter

COPYPASTE_JSCPD_CONFIG_FILE string

COPYPASTE_JSCPD: User custom config file name if different from default

Default: ".jscpd.json"
COPYPASTE_JSCPD_DISABLE_ERRORS boolean

COPYPASTE_JSCPD: If true, COPYPASTE_JSCPD doesn't make MegaLinter fail even if errors are found

Default: false
COPYPASTE_JSCPD_DISABLE_ERRORS_IF_LESS_THAN number

COPYPASTE_JSCPD: If the number of errors found is less than this value, COPYPASTE_JSCPD doesn't make MegaLinter fail

Default: 0
COPYPASTE_JSCPD_POST_COMMANDS command_info[]

COPYPASTE_JSCPD: Define bash commands to run after running COPYPASTE_JSCPD

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
COPYPASTE_JSCPD_PRE_COMMANDS command_info[]

COPYPASTE_JSCPD: Define bash commands to run before running COPYPASTE_JSCPD

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
COPYPASTE_JSCPD_RULES_PATH string

COPYPASTE_JSCPD: Path where to find linter configuration file

COPYPASTE_JSCPD_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling COPYPASTE_JSCPD and its pre/post commands

Default:
[]
COPYPASTE_POST_COMMANDS command_info[]

COPYPASTE: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
COPYPASTE_PRE_COMMANDS command_info[]

COPYPASTE: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
CPP_CLANG_FORMAT_ARGUMENTS array | string

CPP_CLANG_FORMAT: User custom arguments to add in linter CLI call

CPP_CLANG_FORMAT_CLI_EXECUTABLE string[]

CPP_CLANG_FORMAT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "clang-format"
  ]
]
CPP_CLANG_FORMAT_CLI_LINT_MODE string

CPP_CLANG_FORMAT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
CPP_CLANG_FORMAT_COMMAND_REMOVE_ARGUMENTS array | string

CPP_CLANG_FORMAT: User custom arguments to remove before calling linter

CPP_CLANG_FORMAT_CONFIG_FILE string

CPP_CLANG_FORMAT: User custom config file name if different from default

Default: ".clang-format"
CPP_CLANG_FORMAT_DISABLE_ERRORS boolean

CPP_CLANG_FORMAT: If true, CPP_CLANG_FORMAT doesn't make MegaLinter fail even if errors are found

Default: false
CPP_CLANG_FORMAT_DISABLE_ERRORS_IF_LESS_THAN number

CPP_CLANG_FORMAT: If the number of errors found is less than this value, CPP_CLANG_FORMAT doesn't make MegaLinter fail

Default: 0
CPP_CLANG_FORMAT_FILE_EXTENSIONS string[]

CPP_CLANG_FORMAT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".cpp",
  ".h",
  ".cc",
  ".hpp",
  ".cxx",
  ".cu",
  ".hxx",
  ".c++",
  ".hh",
  ".h++",
  ".cuh"
]
Examples: ".py", ".myext"
CPP_CLANG_FORMAT_FILE_NAMES_REGEX string[]

CPP_CLANG_FORMAT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
CPP_CLANG_FORMAT_FILTER_REGEX_EXCLUDE string

CPP_CLANG_FORMAT: Custom regex excluding filter: files matching this regex will NOT be linted

CPP_CLANG_FORMAT_FILTER_REGEX_INCLUDE string

CPP_CLANG_FORMAT: Custom regex including filter: only files matching this regex will be linted

CPP_CLANG_FORMAT_POST_COMMANDS command_info[]

CPP_CLANG_FORMAT: Define bash commands to run after running CPP_CLANG_FORMAT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CPP_CLANG_FORMAT_PRE_COMMANDS command_info[]

CPP_CLANG_FORMAT: Define bash commands to run before running CPP_CLANG_FORMAT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
CPP_CLANG_FORMAT_RULES_PATH string

CPP_CLANG_FORMAT: Path where to find linter configuration file

CPP_CLANG_FORMAT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling CPP_CLANG_FORMAT and its pre/post commands

Default:
[]
CPP_CPPCHECK_ARGUMENTS array | string

CPP_CPPCHECK: User custom arguments to add in linter CLI call

CPP_CPPCHECK_CLI_EXECUTABLE string[]

CPP_CPPCHECK: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "cppcheck"
  ]
]
CPP_CPPCHECK_CLI_LINT_MODE string

CPP_CPPCHECK: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
CPP_CPPCHECK_COMMAND_REMOVE_ARGUMENTS array | string

CPP_CPPCHECK: User custom arguments to remove before calling linter

CPP_CPPCHECK_DISABLE_ERRORS boolean

CPP_CPPCHECK: If true, CPP_CPPCHECK doesn't make MegaLinter fail even if errors are found

Default: false
CPP_CPPCHECK_DISABLE_ERRORS_IF_LESS_THAN number

CPP_CPPCHECK: If the number of errors found is less than this value, CPP_CPPCHECK doesn't make MegaLinter fail

Default: 0
CPP_CPPCHECK_FILE_EXTENSIONS string[]

CPP_CPPCHECK: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".cpp",
  ".h",
  ".cc",
  ".hpp",
  ".cxx",
  ".cu",
  ".hxx",
  ".c++",
  ".hh",
  ".h++",
  ".cuh"
]
Examples: ".py", ".myext"
CPP_CPPCHECK_FILE_NAMES_REGEX string[]

CPP_CPPCHECK: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
CPP_CPPCHECK_FILTER_REGEX_EXCLUDE string

CPP_CPPCHECK: Custom regex excluding filter: files matching this regex will NOT be linted

CPP_CPPCHECK_FILTER_REGEX_INCLUDE string

CPP_CPPCHECK: Custom regex including filter: only files matching this regex will be linted

CPP_CPPCHECK_POST_COMMANDS command_info[]

CPP_CPPCHECK: Define bash commands to run after running CPP_CPPCHECK

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CPP_CPPCHECK_PRE_COMMANDS command_info[]

CPP_CPPCHECK: Define bash commands to run before running CPP_CPPCHECK

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
CPP_CPPCHECK_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling CPP_CPPCHECK and its pre/post commands

Default:
[]
CPP_CPPLINT_ARGUMENTS array | string

CPP_CPPLINT: User custom arguments to add in linter CLI call

CPP_CPPLINT_CLI_EXECUTABLE string[]

CPP_CPPLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "cpplint"
  ]
]
CPP_CPPLINT_CLI_LINT_MODE string

CPP_CPPLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
CPP_CPPLINT_COMMAND_REMOVE_ARGUMENTS array | string

CPP_CPPLINT: User custom arguments to remove before calling linter

CPP_CPPLINT_DISABLE_ERRORS boolean

CPP_CPPLINT: If true, CPP_CPPLINT doesn't make MegaLinter fail even if errors are found

Default: false
CPP_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN number

CPP_CPPLINT: If the number of errors found is less than this value, CPP_CPPLINT doesn't make MegaLinter fail

Default: 0
CPP_CPPLINT_FILE_EXTENSIONS string[]

CPP_CPPLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".cpp",
  ".h",
  ".cc",
  ".hpp",
  ".cxx",
  ".cu",
  ".hxx",
  ".c++",
  ".hh",
  ".h++",
  ".cuh"
]
Examples: ".py", ".myext"
CPP_CPPLINT_FILE_NAMES_REGEX string[]

CPP_CPPLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
CPP_CPPLINT_FILTER_REGEX_EXCLUDE string

CPP_CPPLINT: Custom regex excluding filter: files matching this regex will NOT be linted

CPP_CPPLINT_FILTER_REGEX_INCLUDE string

CPP_CPPLINT: Custom regex including filter: only files matching this regex will be linted

CPP_CPPLINT_POST_COMMANDS command_info[]

CPP_CPPLINT: Define bash commands to run after running CPP_CPPLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CPP_CPPLINT_PRE_COMMANDS command_info[]

CPP_CPPLINT: Define bash commands to run before running CPP_CPPLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
CPP_CPPLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling CPP_CPPLINT and its pre/post commands

Default:
[]
CPP_FILTER_REGEX_EXCLUDE string

CPP: Custom regex excluding filter: files matching this regex will NOT be linted

CPP_FILTER_REGEX_INCLUDE string

CPP: Custom regex including filter: only files matching this regex will be linted

CPP_POST_COMMANDS command_info[]

CPP: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CPP_PRE_COMMANDS command_info[]

CPP: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
CSHARP_CSHARPIER_ARGUMENTS array | string

CSHARP_CSHARPIER: User custom arguments to add in linter CLI call

CSHARP_CSHARPIER_CLI_EXECUTABLE string[]

CSHARP_CSHARPIER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "csharpier"
  ]
]
CSHARP_CSHARPIER_CLI_LINT_MODE string

CSHARP_CSHARPIER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
CSHARP_CSHARPIER_COMMAND_REMOVE_ARGUMENTS array | string

CSHARP_CSHARPIER: User custom arguments to remove before calling linter

CSHARP_CSHARPIER_CONFIG_FILE string

CSHARP_CSHARPIER: User custom config file name if different from default

Default: ".csharpierrc"
CSHARP_CSHARPIER_DISABLE_ERRORS boolean

CSHARP_CSHARPIER: If true, CSHARP_CSHARPIER doesn't make MegaLinter fail even if errors are found

Default: false
CSHARP_CSHARPIER_DISABLE_ERRORS_IF_LESS_THAN number

CSHARP_CSHARPIER: If the number of errors found is less than this value, CSHARP_CSHARPIER doesn't make MegaLinter fail

Default: 0
CSHARP_CSHARPIER_FILE_EXTENSIONS string[]

CSHARP_CSHARPIER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".config",
  ".cs",
  ".csproj",
  ".props",
  ".targets"
]
Examples: ".py", ".myext"
CSHARP_CSHARPIER_FILE_NAMES_REGEX string[]

CSHARP_CSHARPIER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
CSHARP_CSHARPIER_FILTER_REGEX_EXCLUDE string

CSHARP_CSHARPIER: Custom regex excluding filter: files matching this regex will NOT be linted

CSHARP_CSHARPIER_FILTER_REGEX_INCLUDE string

CSHARP_CSHARPIER: Custom regex including filter: only files matching this regex will be linted

CSHARP_CSHARPIER_POST_COMMANDS command_info[]

CSHARP_CSHARPIER: Define bash commands to run after running CSHARP_CSHARPIER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CSHARP_CSHARPIER_PRE_COMMANDS command_info[]

CSHARP_CSHARPIER: Define bash commands to run before running CSHARP_CSHARPIER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
CSHARP_CSHARPIER_RULES_PATH string

CSHARP_CSHARPIER: Path where to find linter configuration file

CSHARP_CSHARPIER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling CSHARP_CSHARPIER and its pre/post commands

Default:
[]
CSHARP_DOTNET_FORMAT_ARGUMENTS array | string

CSHARP_DOTNET_FORMAT: User custom arguments to add in linter CLI call

CSHARP_DOTNET_FORMAT_CLI_EXECUTABLE string[]

CSHARP_DOTNET_FORMAT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "dotnet"
  ]
]
CSHARP_DOTNET_FORMAT_CLI_LINT_MODE string

CSHARP_DOTNET_FORMAT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
CSHARP_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS array | string

CSHARP_DOTNET_FORMAT: User custom arguments to remove before calling linter

CSHARP_DOTNET_FORMAT_DISABLE_ERRORS boolean

CSHARP_DOTNET_FORMAT: If true, CSHARP_DOTNET_FORMAT doesn't make MegaLinter fail even if errors are found

Default: false
CSHARP_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN number

CSHARP_DOTNET_FORMAT: If the number of errors found is less than this value, CSHARP_DOTNET_FORMAT doesn't make MegaLinter fail

Default: 0
CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS string[]

CSHARP_DOTNET_FORMAT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".cs"
]
Examples: ".py", ".myext"
CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX string[]

CSHARP_DOTNET_FORMAT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
CSHARP_DOTNET_FORMAT_POST_COMMANDS command_info[]

CSHARP_DOTNET_FORMAT: Define bash commands to run after running CSHARP_DOTNET_FORMAT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CSHARP_DOTNET_FORMAT_PRE_COMMANDS command_info[]

CSHARP_DOTNET_FORMAT: Define bash commands to run before running CSHARP_DOTNET_FORMAT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
CSHARP_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling CSHARP_DOTNET_FORMAT and its pre/post commands

Default:
[]
CSHARP_FILTER_REGEX_EXCLUDE string

CSHARP: Custom regex excluding filter: files matching this regex will NOT be linted

CSHARP_FILTER_REGEX_INCLUDE string

CSHARP: Custom regex including filter: only files matching this regex will be linted

CSHARP_POST_COMMANDS command_info[]

CSHARP: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CSHARP_PRE_COMMANDS command_info[]

CSHARP: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
CSHARP_ROSLYNATOR_ARGUMENTS array | string

CSHARP_ROSLYNATOR: User custom arguments to add in linter CLI call

CSHARP_ROSLYNATOR_CLI_EXECUTABLE string[]

CSHARP_ROSLYNATOR: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "roslynator"
  ]
]
CSHARP_ROSLYNATOR_CLI_LINT_MODE string

CSHARP_ROSLYNATOR: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
CSHARP_ROSLYNATOR_COMMAND_REMOVE_ARGUMENTS array | string

CSHARP_ROSLYNATOR: User custom arguments to remove before calling linter

CSHARP_ROSLYNATOR_DISABLE_ERRORS boolean

CSHARP_ROSLYNATOR: If true, CSHARP_ROSLYNATOR doesn't make MegaLinter fail even if errors are found

Default: false
CSHARP_ROSLYNATOR_DISABLE_ERRORS_IF_LESS_THAN number

CSHARP_ROSLYNATOR: If the number of errors found is less than this value, CSHARP_ROSLYNATOR doesn't make MegaLinter fail

Default: 0
CSHARP_ROSLYNATOR_FILE_EXTENSIONS string[]

CSHARP_ROSLYNATOR: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".csproj"
]
Examples: ".py", ".myext"
CSHARP_ROSLYNATOR_FILE_NAMES_REGEX string[]

CSHARP_ROSLYNATOR: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
CSHARP_ROSLYNATOR_FILTER_REGEX_EXCLUDE string

CSHARP_ROSLYNATOR: Custom regex excluding filter: files matching this regex will NOT be linted

CSHARP_ROSLYNATOR_FILTER_REGEX_INCLUDE string

CSHARP_ROSLYNATOR: Custom regex including filter: only files matching this regex will be linted

CSHARP_ROSLYNATOR_POST_COMMANDS command_info[]

CSHARP_ROSLYNATOR: Define bash commands to run after running CSHARP_ROSLYNATOR

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CSHARP_ROSLYNATOR_PRE_COMMANDS command_info[]

CSHARP_ROSLYNATOR: Define bash commands to run before running CSHARP_ROSLYNATOR

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
CSHARP_ROSLYNATOR_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling CSHARP_ROSLYNATOR and its pre/post commands

Default:
[]
CSS_FILTER_REGEX_EXCLUDE string

CSS: Custom regex excluding filter: files matching this regex will NOT be linted

CSS_FILTER_REGEX_INCLUDE string

CSS: Custom regex including filter: only files matching this regex will be linted

CSS_POST_COMMANDS command_info[]

CSS: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CSS_PRE_COMMANDS command_info[]

CSS: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
CSS_SCSS_LINT_ARGUMENTS array | string

CSS_SCSS_LINT: User custom arguments to add in linter CLI call

CSS_SCSS_LINT_CLI_EXECUTABLE string[]
Default:
[
  [
    "scss-lint"
  ]
]
CSS_SCSS_LINT_CLI_LINT_MODE string
Default: "file"
Values: "file" "project"
CSS_SCSS_LINT_COMMAND_REMOVE_ARGUMENTS array | string

CSS_SCSS_LINT: User custom arguments to remove before calling linter

CSS_SCSS_LINT_CONFIG_FILE string

CSS_SCSS_LINT: User custom config file name if different from default

Default: ".scss-lint.yml"
CSS_SCSS_LINT_DISABLE_ERRORS boolean
Default: false
CSS_SCSS_LINT_DISABLE_ERRORS_IF_LESS_THAN number
Default: 0
CSS_SCSS_LINT_FILE_EXTENSIONS string[]
CSS_SCSS_LINT_FILE_NAME string

CSS_SCSS_LINT: User custom config file name if different from default

Default: ".scss-lint.yml"
CSS_SCSS_LINT_FILE_NAMES_REGEX string[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
CSS_SCSS_LINT_FILTER_REGEX_EXCLUDE string
CSS_SCSS_LINT_FILTER_REGEX_INCLUDE string
CSS_SCSS_LINT_POST_COMMANDS command_info[]
Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CSS_SCSS_LINT_PRE_COMMANDS command_info[]
Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
CSS_SCSS_LINT_RULES_PATH string

CSS_SCSS_LINT: Path where to find linter configuration file

CSS_SCSS_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling CSS_SCSS_LINT and its pre/post commands

Default:
[]
CSS_STYLELINT_ARGUMENTS array | string

CSS_STYLELINT: User custom arguments to add in linter CLI call

CSS_STYLELINT_CLI_EXECUTABLE string[]

CSS_STYLELINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "stylelint"
  ]
]
CSS_STYLELINT_CLI_LINT_MODE string

CSS_STYLELINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
CSS_STYLELINT_COMMAND_REMOVE_ARGUMENTS array | string

CSS_STYLELINT: User custom arguments to remove before calling linter

CSS_STYLELINT_CONFIG_FILE string

CSS_STYLELINT: User custom config file name if different from default

Default: ".stylelintrc.json"
CSS_STYLELINT_DISABLE_ERRORS boolean

CSS_STYLELINT: If true, CSS_STYLELINT doesn't make MegaLinter fail even if errors are found

Default: false
CSS_STYLELINT_DISABLE_ERRORS_IF_LESS_THAN number

CSS_STYLELINT: If the number of errors found is less than this value, CSS_STYLELINT doesn't make MegaLinter fail

Default: 0
CSS_STYLELINT_FILE_EXTENSIONS string[]

CSS_STYLELINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".css",
  ".scss",
  ".saas"
]
Examples: ".py", ".myext"
CSS_STYLELINT_FILE_NAMES_REGEX string[]

CSS_STYLELINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
CSS_STYLELINT_FILTER_REGEX_EXCLUDE string

CSS_STYLELINT: Custom regex excluding filter: files matching this regex will NOT be linted

CSS_STYLELINT_FILTER_REGEX_INCLUDE string

CSS_STYLELINT: Custom regex including filter: only files matching this regex will be linted

CSS_STYLELINT_POST_COMMANDS command_info[]

CSS_STYLELINT: Define bash commands to run after running CSS_STYLELINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
CSS_STYLELINT_PRE_COMMANDS command_info[]

CSS_STYLELINT: Define bash commands to run before running CSS_STYLELINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
CSS_STYLELINT_RULES_PATH string

CSS_STYLELINT: Path where to find linter configuration file

CSS_STYLELINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling CSS_STYLELINT and its pre/post commands

Default:
[]
C_CLANG_FORMAT_ARGUMENTS array | string

C_CLANG_FORMAT: User custom arguments to add in linter CLI call

C_CLANG_FORMAT_CLI_EXECUTABLE string[]

C_CLANG_FORMAT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "clang-format"
  ]
]
C_CLANG_FORMAT_CLI_LINT_MODE string

C_CLANG_FORMAT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
C_CLANG_FORMAT_COMMAND_REMOVE_ARGUMENTS array | string

C_CLANG_FORMAT: User custom arguments to remove before calling linter

C_CLANG_FORMAT_CONFIG_FILE string

C_CLANG_FORMAT: User custom config file name if different from default

Default: ".clang-format"
C_CLANG_FORMAT_DISABLE_ERRORS boolean

C_CLANG_FORMAT: If true, C_CLANG_FORMAT doesn't make MegaLinter fail even if errors are found

Default: false
C_CLANG_FORMAT_DISABLE_ERRORS_IF_LESS_THAN number

C_CLANG_FORMAT: If the number of errors found is less than this value, C_CLANG_FORMAT doesn't make MegaLinter fail

Default: 0
C_CLANG_FORMAT_FILE_EXTENSIONS string[]

C_CLANG_FORMAT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".c",
  ".h"
]
Examples: ".py", ".myext"
C_CLANG_FORMAT_FILE_NAMES_REGEX string[]

C_CLANG_FORMAT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
C_CLANG_FORMAT_FILTER_REGEX_EXCLUDE string

C_CLANG_FORMAT: Custom regex excluding filter: files matching this regex will NOT be linted

C_CLANG_FORMAT_FILTER_REGEX_INCLUDE string

C_CLANG_FORMAT: Custom regex including filter: only files matching this regex will be linted

C_CLANG_FORMAT_POST_COMMANDS command_info[]

C_CLANG_FORMAT: Define bash commands to run after running C_CLANG_FORMAT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
C_CLANG_FORMAT_PRE_COMMANDS command_info[]

C_CLANG_FORMAT: Define bash commands to run before running C_CLANG_FORMAT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
C_CLANG_FORMAT_RULES_PATH string

C_CLANG_FORMAT: Path where to find linter configuration file

C_CLANG_FORMAT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling C_CLANG_FORMAT and its pre/post commands

Default:
[]
C_CPPCHECK_ARGUMENTS array | string

C_CPPCHECK: User custom arguments to add in linter CLI call

C_CPPCHECK_CLI_EXECUTABLE string[]

C_CPPCHECK: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "cppcheck"
  ]
]
C_CPPCHECK_CLI_LINT_MODE string

C_CPPCHECK: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
C_CPPCHECK_COMMAND_REMOVE_ARGUMENTS array | string

C_CPPCHECK: User custom arguments to remove before calling linter

C_CPPCHECK_DISABLE_ERRORS boolean

C_CPPCHECK: If true, C_CPPCHECK doesn't make MegaLinter fail even if errors are found

Default: false
C_CPPCHECK_DISABLE_ERRORS_IF_LESS_THAN number

C_CPPCHECK: If the number of errors found is less than this value, C_CPPCHECK doesn't make MegaLinter fail

Default: 0
C_CPPCHECK_FILE_EXTENSIONS string[]

C_CPPCHECK: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".c",
  ".h"
]
Examples: ".py", ".myext"
C_CPPCHECK_FILE_NAMES_REGEX string[]

C_CPPCHECK: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
C_CPPCHECK_FILTER_REGEX_EXCLUDE string

C_CPPCHECK: Custom regex excluding filter: files matching this regex will NOT be linted

C_CPPCHECK_FILTER_REGEX_INCLUDE string

C_CPPCHECK: Custom regex including filter: only files matching this regex will be linted

C_CPPCHECK_POST_COMMANDS command_info[]

C_CPPCHECK: Define bash commands to run after running C_CPPCHECK

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
C_CPPCHECK_PRE_COMMANDS command_info[]

C_CPPCHECK: Define bash commands to run before running C_CPPCHECK

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
C_CPPCHECK_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling C_CPPCHECK and its pre/post commands

Default:
[]
C_CPPLINT_ARGUMENTS array | string

C_CPPLINT: User custom arguments to add in linter CLI call

C_CPPLINT_CLI_EXECUTABLE string[]

C_CPPLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "cpplint"
  ]
]
C_CPPLINT_CLI_LINT_MODE string

C_CPPLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
C_CPPLINT_COMMAND_REMOVE_ARGUMENTS array | string

C_CPPLINT: User custom arguments to remove before calling linter

C_CPPLINT_DISABLE_ERRORS boolean

C_CPPLINT: If true, C_CPPLINT doesn't make MegaLinter fail even if errors are found

Default: false
C_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN number

C_CPPLINT: If the number of errors found is less than this value, C_CPPLINT doesn't make MegaLinter fail

Default: 0
C_CPPLINT_FILE_EXTENSIONS string[]

C_CPPLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".c",
  ".h"
]
Examples: ".py", ".myext"
C_CPPLINT_FILE_NAMES_REGEX string[]

C_CPPLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
C_CPPLINT_FILTER_REGEX_EXCLUDE string

C_CPPLINT: Custom regex excluding filter: files matching this regex will NOT be linted

C_CPPLINT_FILTER_REGEX_INCLUDE string

C_CPPLINT: Custom regex including filter: only files matching this regex will be linted

C_CPPLINT_POST_COMMANDS command_info[]

C_CPPLINT: Define bash commands to run after running C_CPPLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
C_CPPLINT_PRE_COMMANDS command_info[]

C_CPPLINT: Define bash commands to run before running C_CPPLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
C_CPPLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling C_CPPLINT and its pre/post commands

Default:
[]
C_FILTER_REGEX_EXCLUDE string

C: Custom regex excluding filter: files matching this regex will NOT be linted

C_FILTER_REGEX_INCLUDE string

C: Custom regex including filter: only files matching this regex will be linted

C_POST_COMMANDS command_info[]

C: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
C_PRE_COMMANDS command_info[]

C: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
DART_DARTANALYZER_ARGUMENTS array | string

DART_DARTANALYZER: User custom arguments to add in linter CLI call

DART_DARTANALYZER_CLI_EXECUTABLE string[]

DART_DARTANALYZER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "dart"
  ]
]
DART_DARTANALYZER_CLI_LINT_MODE string

DART_DARTANALYZER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
DART_DARTANALYZER_COMMAND_REMOVE_ARGUMENTS array | string

DART_DARTANALYZER: User custom arguments to remove before calling linter

DART_DARTANALYZER_CONFIG_FILE string

DART_DARTANALYZER: User custom config file name if different from default

Default: "analysis_options.yaml"
DART_DARTANALYZER_DISABLE_ERRORS boolean

DART_DARTANALYZER: If true, DART_DARTANALYZER doesn't make MegaLinter fail even if errors are found

Default: false
DART_DARTANALYZER_DISABLE_ERRORS_IF_LESS_THAN number

DART_DARTANALYZER: If the number of errors found is less than this value, DART_DARTANALYZER doesn't make MegaLinter fail

Default: 0
DART_DARTANALYZER_FILE_EXTENSIONS string[]

DART_DARTANALYZER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".dart"
]
Examples: ".py", ".myext"
DART_DARTANALYZER_FILE_NAMES_REGEX string[]

DART_DARTANALYZER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
DART_DARTANALYZER_FILTER_REGEX_EXCLUDE string

DART_DARTANALYZER: Custom regex excluding filter: files matching this regex will NOT be linted

DART_DARTANALYZER_FILTER_REGEX_INCLUDE string

DART_DARTANALYZER: Custom regex including filter: only files matching this regex will be linted

DART_DARTANALYZER_POST_COMMANDS command_info[]

DART_DARTANALYZER: Define bash commands to run after running DART_DARTANALYZER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
DART_DARTANALYZER_PRE_COMMANDS command_info[]

DART_DARTANALYZER: Define bash commands to run before running DART_DARTANALYZER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
DART_DARTANALYZER_RULES_PATH string

DART_DARTANALYZER: Path where to find linter configuration file

DART_DARTANALYZER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling DART_DARTANALYZER and its pre/post commands

Default:
[]
DART_FILTER_REGEX_EXCLUDE string

DART: Custom regex excluding filter: files matching this regex will NOT be linted

DART_FILTER_REGEX_INCLUDE string

DART: Custom regex including filter: only files matching this regex will be linted

DART_POST_COMMANDS command_info[]

DART: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
DART_PRE_COMMANDS command_info[]

DART: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
DEFAULT_BRANCH string

Deprecated: The name of the repository's default branch.

Default: "HEAD"
Examples: "master", "main"
DEFAULT_WORKSPACE string

The location containing files to lint if you are running as docker image

Default: "/tmp/lint"

If DISABLE is set, the linters in the listed descriptors will be skipped

Examples: ["BASH","HTML"]
DISABLE_ERRORS boolean

Flag to have the MegaLinter complete with exit code 0 even if errors were detected.

Default: false
DISABLE_ERRORS_LINTERS enum_linter_keys[]

If DISABLE_ERRORS_LINTERS is set, the listed linters will be run but errors will be not blocking

Examples: ["BASH_BASH_SHFMT","JAVASCRIPT_STANDARD"]
DISABLE_LINTERS enum_linter_keys[]

If DISABLE_LINTERS is set, the listed linters will be skipped

Examples: ["BASH_BASH_SHFMT","JAVASCRIPT_STANDARD"]
DOCKERFILE_DOCKERFILELINT_ARGUMENTS array | string

DOCKERFILE_DOCKERFILELINT: User custom arguments to add in linter CLI call

DOCKERFILE_DOCKERFILELINT_CLI_LINT_MODE string
Default: "file"
Values: "file" "list_of_files" "project"
DOCKERFILE_DOCKERFILELINT_CONFIG_FILE string

DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default

Default: ".dockerfilelintrc"
DOCKERFILE_DOCKERFILELINT_DISABLE_ERRORS boolean
Default: false
DOCKERFILE_DOCKERFILELINT_DISABLE_ERRORS_IF_LESS_THAN number
Default: 0
DOCKERFILE_DOCKERFILELINT_FILE_EXTENSIONS string[]
DOCKERFILE_DOCKERFILELINT_FILE_NAME string

DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default

Default: ".dockerfilelintrc"
DOCKERFILE_DOCKERFILELINT_FILE_NAMES_REGEX string[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
DOCKERFILE_DOCKERFILELINT_FILTER_REGEX_EXCLUDE string
DOCKERFILE_DOCKERFILELINT_FILTER_REGEX_INCLUDE string
DOCKERFILE_DOCKERFILELINT_POST_COMMANDS command_info[]
Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS command_info[]
Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
DOCKERFILE_DOCKERFILELINT_RULES_PATH string

DOCKERFILE_DOCKERFILELINT: Path where to find linter configuration file

DOCKERFILE_FILTER_REGEX_EXCLUDE string

DOCKERFILE: Custom regex excluding filter: files matching this regex will NOT be linted

DOCKERFILE_FILTER_REGEX_INCLUDE string

DOCKERFILE: Custom regex including filter: only files matching this regex will be linted

DOCKERFILE_HADOLINT_ARGUMENTS array | string

DOCKERFILE_HADOLINT: User custom arguments to add in linter CLI call

DOCKERFILE_HADOLINT_CLI_EXECUTABLE string[]

DOCKERFILE_HADOLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "hadolint"
  ]
]
DOCKERFILE_HADOLINT_CLI_LINT_MODE string

DOCKERFILE_HADOLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
DOCKERFILE_HADOLINT_COMMAND_REMOVE_ARGUMENTS array | string

DOCKERFILE_HADOLINT: User custom arguments to remove before calling linter

DOCKERFILE_HADOLINT_CONFIG_FILE string

DOCKERFILE_HADOLINT: User custom config file name if different from default

Default: ".hadolint.yaml"
DOCKERFILE_HADOLINT_DISABLE_ERRORS boolean

DOCKERFILE_HADOLINT: If true, DOCKERFILE_HADOLINT doesn't make MegaLinter fail even if errors are found

Default: false
DOCKERFILE_HADOLINT_DISABLE_ERRORS_IF_LESS_THAN number

DOCKERFILE_HADOLINT: If the number of errors found is less than this value, DOCKERFILE_HADOLINT doesn't make MegaLinter fail

Default: 0
DOCKERFILE_HADOLINT_FILE_EXTENSIONS string[]

DOCKERFILE_HADOLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[]
Examples: ".py", ".myext"
DOCKERFILE_HADOLINT_FILE_NAMES_REGEX string[]

DOCKERFILE_HADOLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[
  "Containerfile",
  "(.*\\.)?Dockerfile"
]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
DOCKERFILE_HADOLINT_FILTER_REGEX_EXCLUDE string

DOCKERFILE_HADOLINT: Custom regex excluding filter: files matching this regex will NOT be linted

DOCKERFILE_HADOLINT_FILTER_REGEX_INCLUDE string

DOCKERFILE_HADOLINT: Custom regex including filter: only files matching this regex will be linted

DOCKERFILE_HADOLINT_POST_COMMANDS command_info[]

DOCKERFILE_HADOLINT: Define bash commands to run after running DOCKERFILE_HADOLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
DOCKERFILE_HADOLINT_PRE_COMMANDS command_info[]

DOCKERFILE_HADOLINT: Define bash commands to run before running DOCKERFILE_HADOLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
DOCKERFILE_HADOLINT_RULES_PATH string

DOCKERFILE_HADOLINT: Path where to find linter configuration file

DOCKERFILE_HADOLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling DOCKERFILE_HADOLINT and its pre/post commands

Default:
[]
DOCKERFILE_POST_COMMANDS command_info[]

DOCKERFILE: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
DOCKERFILE_PRE_COMMANDS command_info[]

DOCKERFILE: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS array | string

EDITORCONFIG_EDITORCONFIG_CHECKER: User custom arguments to add in linter CLI call

EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_EXECUTABLE string[]

EDITORCONFIG_EDITORCONFIG_CHECKER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "editorconfig-checker"
  ]
]
EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_LINT_MODE string

EDITORCONFIG_EDITORCONFIG_CHECKER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
EDITORCONFIG_EDITORCONFIG_CHECKER_COMMAND_REMOVE_ARGUMENTS array | string

EDITORCONFIG_EDITORCONFIG_CHECKER: User custom arguments to remove before calling linter

EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE string

EDITORCONFIG_EDITORCONFIG_CHECKER: User custom config file name if different from default

Default: ".editorconfig-checker.json"
EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS boolean

EDITORCONFIG_EDITORCONFIG_CHECKER: If true, EDITORCONFIG_EDITORCONFIG_CHECKER doesn't make MegaLinter fail even if errors are found

Default: false
EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS_IF_LESS_THAN number

EDITORCONFIG_EDITORCONFIG_CHECKER: If the number of errors found is less than this value, EDITORCONFIG_EDITORCONFIG_CHECKER doesn't make MegaLinter fail

Default: 0
EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS string[]

EDITORCONFIG_EDITORCONFIG_CHECKER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  "*"
]
Examples: ".py", ".myext"
EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX string[]

EDITORCONFIG_EDITORCONFIG_CHECKER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_EXCLUDE string

EDITORCONFIG_EDITORCONFIG_CHECKER: Custom regex excluding filter: files matching this regex will NOT be linted

EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_INCLUDE string

EDITORCONFIG_EDITORCONFIG_CHECKER: Custom regex including filter: only files matching this regex will be linted

EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS command_info[]

EDITORCONFIG_EDITORCONFIG_CHECKER: Define bash commands to run after running EDITORCONFIG_EDITORCONFIG_CHECKER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS command_info[]

EDITORCONFIG_EDITORCONFIG_CHECKER: Define bash commands to run before running EDITORCONFIG_EDITORCONFIG_CHECKER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
EDITORCONFIG_EDITORCONFIG_CHECKER_RULES_PATH string

EDITORCONFIG_EDITORCONFIG_CHECKER: Path where to find linter configuration file

EDITORCONFIG_EDITORCONFIG_CHECKER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling EDITORCONFIG_EDITORCONFIG_CHECKER and its pre/post commands

Default:
[]
EDITORCONFIG_FILTER_REGEX_EXCLUDE string

EDITORCONFIG: Custom regex excluding filter: files matching this regex will NOT be linted

EDITORCONFIG_FILTER_REGEX_INCLUDE string

EDITORCONFIG: Custom regex including filter: only files matching this regex will be linted

EDITORCONFIG_POST_COMMANDS command_info[]

EDITORCONFIG: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
EDITORCONFIG_PRE_COMMANDS command_info[]

EDITORCONFIG: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
EMAIL_REPORTER boolean

MegaLinter can send email with reports to given addresses. Please set EMAIL_REPORTER_** variables if activated

Default: true
EMAIL_REPORTER_EMAIL string

Comma-separated list of recipient emails, that will receive reports

EMAIL_REPORTER_SENDER string
Default: "[email protected]"
EMAIL_REPORTER_SEND_SUCCESS boolean

Define to true if you want to receive reports by mail even when there is no errors or updated sources

Default: false
EMAIL_REPORTER_SMTP_HOST string
Default: "smtp.gmail.com"
EMAIL_REPORTER_SMTP_PASSWORD string
EMAIL_REPORTER_SMTP_PORT number
Default: "465"
EMAIL_REPORTER_SMTP_USERNAME string
Default: "[email protected]"

If ENABLE is not set, all descriptors are activated by default. If set, all linters of listed descriptors will be activated by default

Examples: ["BASH","HTML","JAVASCRIPT"]
ENABLE_ERRORS_LINTERS enum_linter_keys[]

If ENABLE_ERRORS_LINTERS is set, only the listed linters will be considered as blocking

Examples: ["REPOSITORY_TRIVY","REPOSITORY_GITLEAKS"]
ENABLE_LINTERS enum_linter_keys[]

If ENABLE_LINTERS is set, only listed linters will be processed

Examples: ["JAVASCRIPT_ES","PYTHON_PYLINT"]
ENV_DOTENV_LINTER_ARGUMENTS array | string

ENV_DOTENV_LINTER: User custom arguments to add in linter CLI call

ENV_DOTENV_LINTER_CLI_EXECUTABLE string[]

ENV_DOTENV_LINTER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "dotenv-linter"
  ]
]
ENV_DOTENV_LINTER_CLI_LINT_MODE string

ENV_DOTENV_LINTER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
ENV_DOTENV_LINTER_COMMAND_REMOVE_ARGUMENTS array | string

ENV_DOTENV_LINTER: User custom arguments to remove before calling linter

ENV_DOTENV_LINTER_DISABLE_ERRORS boolean

ENV_DOTENV_LINTER: If true, ENV_DOTENV_LINTER doesn't make MegaLinter fail even if errors are found

Default: false
ENV_DOTENV_LINTER_DISABLE_ERRORS_IF_LESS_THAN number

ENV_DOTENV_LINTER: If the number of errors found is less than this value, ENV_DOTENV_LINTER doesn't make MegaLinter fail

Default: 0
ENV_DOTENV_LINTER_FILE_EXTENSIONS string[]

ENV_DOTENV_LINTER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".env"
]
Examples: ".py", ".myext"
ENV_DOTENV_LINTER_FILE_NAMES_REGEX string[]

ENV_DOTENV_LINTER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
ENV_DOTENV_LINTER_FILTER_REGEX_EXCLUDE string

ENV_DOTENV_LINTER: Custom regex excluding filter: files matching this regex will NOT be linted

ENV_DOTENV_LINTER_FILTER_REGEX_INCLUDE string

ENV_DOTENV_LINTER: Custom regex including filter: only files matching this regex will be linted

ENV_DOTENV_LINTER_POST_COMMANDS command_info[]

ENV_DOTENV_LINTER: Define bash commands to run after running ENV_DOTENV_LINTER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
ENV_DOTENV_LINTER_PRE_COMMANDS command_info[]

ENV_DOTENV_LINTER: Define bash commands to run before running ENV_DOTENV_LINTER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
ENV_DOTENV_LINTER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling ENV_DOTENV_LINTER and its pre/post commands

Default:
[]
ENV_FILTER_REGEX_EXCLUDE string

ENV: Custom regex excluding filter: files matching this regex will NOT be linted

ENV_FILTER_REGEX_INCLUDE string

ENV: Custom regex including filter: only files matching this regex will be linted

ENV_POST_COMMANDS command_info[]

ENV: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
ENV_PRE_COMMANDS command_info[]

ENV: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
ERROR_ON_MISSING_EXEC_BIT boolean

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: false
EXCLUDED_DIRECTORIES string[]

List of excluded directory basenames replacing MegaLinter default excluded directories. They are excluded at any nested level.

Examples: [".github","node_modules"]
EXTENDS array | string

Base mega-linter.yml config file(s) to extend local configuration from. Can be a single URL or a list of .mega-linter.yml config files URLs

FAIL_IF_MISSING_LINTER_IN_FLAVOR boolean

If set to true, MegaLinter fails if a linter is missing in the selected flavor

Default: false
FAIL_IF_UPDATED_SOURCES boolean

If set to true, MegaLinter fails if a linter or formatter has auto-fixed sources, even if there are no errors

Default: false
FILEIO_REPORTER boolean

If you don't use artifacts upload to read MegaLinter reports, you can access them with an hyperlink to file.io. Important: MegaLinter has no affiliation with file.io, but it's supposed to be secured, and only one download is available for a report (snapchat for files, basically)

Default: false
FILEIO_REPORTER_SEND_SUCCESS boolean

Skip posting to file.io if linting is in success

Default: false
FILTER_REGEX_EXCLUDE string

Regular expression defining which files will be excluded from linting

Examples: "(\.automation/test|docs/javascripts|docs/overrides|flavors|clj-kondo|TEMPLATES)", "(src/test)"
FILTER_REGEX_INCLUDE string

Regular expression defining which files will be processed by linters

Examples: "(src/)"
FLAVOR_SUGGESTIONS boolean

Provides suggestions about different MegaLinter flavors to use to improve runtime performances

Default: true
FORMATTERS_DISABLE_ERRORS boolean

Formatter errors will be reported as errors (and not warnings) if this variable is set to false

Default: true
GHERKIN_FILTER_REGEX_EXCLUDE string

GHERKIN: Custom regex excluding filter: files matching this regex will NOT be linted

GHERKIN_FILTER_REGEX_INCLUDE string

GHERKIN: Custom regex including filter: only files matching this regex will be linted

GHERKIN_GHERKIN_LINT_ARGUMENTS array | string

GHERKIN_GHERKIN_LINT: User custom arguments to add in linter CLI call

GHERKIN_GHERKIN_LINT_CLI_EXECUTABLE string[]

GHERKIN_GHERKIN_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "gherkin-lint"
  ]
]
GHERKIN_GHERKIN_LINT_CLI_LINT_MODE string

GHERKIN_GHERKIN_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
GHERKIN_GHERKIN_LINT_COMMAND_REMOVE_ARGUMENTS array | string

GHERKIN_GHERKIN_LINT: User custom arguments to remove before calling linter

GHERKIN_GHERKIN_LINT_CONFIG_FILE string

GHERKIN_GHERKIN_LINT: User custom config file name if different from default

Default: ".gherkin-lintrc"
GHERKIN_GHERKIN_LINT_DISABLE_ERRORS boolean

GHERKIN_GHERKIN_LINT: If true, GHERKIN_GHERKIN_LINT doesn't make MegaLinter fail even if errors are found

Default: false
GHERKIN_GHERKIN_LINT_DISABLE_ERRORS_IF_LESS_THAN number

GHERKIN_GHERKIN_LINT: If the number of errors found is less than this value, GHERKIN_GHERKIN_LINT doesn't make MegaLinter fail

Default: 0
GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS string[]

GHERKIN_GHERKIN_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".feature"
]
Examples: ".py", ".myext"
GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX string[]

GHERKIN_GHERKIN_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
GHERKIN_GHERKIN_LINT_FILTER_REGEX_EXCLUDE string

GHERKIN_GHERKIN_LINT: Custom regex excluding filter: files matching this regex will NOT be linted

GHERKIN_GHERKIN_LINT_FILTER_REGEX_INCLUDE string

GHERKIN_GHERKIN_LINT: Custom regex including filter: only files matching this regex will be linted

GHERKIN_GHERKIN_LINT_POST_COMMANDS command_info[]

GHERKIN_GHERKIN_LINT: Define bash commands to run after running GHERKIN_GHERKIN_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
GHERKIN_GHERKIN_LINT_PRE_COMMANDS command_info[]

GHERKIN_GHERKIN_LINT: Define bash commands to run before running GHERKIN_GHERKIN_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
GHERKIN_GHERKIN_LINT_RULES_PATH string

GHERKIN_GHERKIN_LINT: Path where to find linter configuration file

GHERKIN_GHERKIN_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling GHERKIN_GHERKIN_LINT and its pre/post commands

Default:
[]
GHERKIN_POST_COMMANDS command_info[]

GHERKIN: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
GHERKIN_PRE_COMMANDS command_info[]

GHERKIN: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
GITHUB_API_URL string

URL where the github API can be reached. Must be overridden if using GitHub Enterprise

Default: "https://api.github.com"
Examples: "https://github.my-company.com/api/v3"
format=uri
GITHUB_COMMENT_REPORTER boolean

Posts MegaLinter results summary in the comments of the related pull request (if existing)

Default: true
GITHUB_SERVER_URL string

URL of the GitHub instance. Must be overridden if using GitHub Enterprise

Default: "https://github.com"
Examples: "https://github.my-company.com/"
format=uri
GITHUB_STATUS_REPORTER boolean

Posts a status on the pull request for each processed linter

Default: true
GITHUB_WORKSPACE string

Base directory for REPORT_OUTPUT_FOLDER, for user-defined linter rules location, for location of linted files if DEFAULT_WORKSPACE is not set

Default: "/tmp/lint"
GITLAB_CERTIFICATE_PATH string

Path to SSL certificate if necessary

Default: true
GITLAB_COMMENT_REPORTER boolean

Posts Mega-Linter results summary in the comments of the related merge request (if existing)

Default: true
GITLAB_COMMENT_REPORTER_OVERWRITE_COMMENT boolean

Set to false to disable the overwrite of existing MegaLinter Merge Request comment in case of new run

Default: true
GO_FILTER_REGEX_EXCLUDE string

GO: Custom regex excluding filter: files matching this regex will NOT be linted

GO_FILTER_REGEX_INCLUDE string

GO: Custom regex including filter: only files matching this regex will be linted

GO_GOLANGCI_LINT_ARGUMENTS array | string

GO_GOLANGCI_LINT: User custom arguments to add in linter CLI call

GO_GOLANGCI_LINT_CLI_EXECUTABLE string[]

GO_GOLANGCI_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "golangci-lint"
  ]
]
GO_GOLANGCI_LINT_CLI_LINT_MODE string

GO_GOLANGCI_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
GO_GOLANGCI_LINT_COMMAND_REMOVE_ARGUMENTS array | string

GO_GOLANGCI_LINT: User custom arguments to remove before calling linter

GO_GOLANGCI_LINT_CONFIG_FILE string

GO_GOLANGCI_LINT: User custom config file name if different from default

Default: ".golangci.yml"
GO_GOLANGCI_LINT_DISABLE_ERRORS boolean

GO_GOLANGCI_LINT: If true, GO_GOLANGCI_LINT doesn't make MegaLinter fail even if errors are found

Default: false
GO_GOLANGCI_LINT_DISABLE_ERRORS_IF_LESS_THAN number

GO_GOLANGCI_LINT: If the number of errors found is less than this value, GO_GOLANGCI_LINT doesn't make MegaLinter fail

Default: 0
GO_GOLANGCI_LINT_FILE_EXTENSIONS string[]

GO_GOLANGCI_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".go"
]
Examples: ".py", ".myext"
GO_GOLANGCI_LINT_FILE_NAMES_REGEX string[]

GO_GOLANGCI_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
GO_GOLANGCI_LINT_POST_COMMANDS command_info[]

GO_GOLANGCI_LINT: Define bash commands to run after running GO_GOLANGCI_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
GO_GOLANGCI_LINT_PRE_COMMANDS command_info[]

GO_GOLANGCI_LINT: Define bash commands to run before running GO_GOLANGCI_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
GO_GOLANGCI_LINT_RULES_PATH string

GO_GOLANGCI_LINT: Path where to find linter configuration file

GO_GOLANGCI_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling GO_GOLANGCI_LINT and its pre/post commands

Default:
[]
GO_POST_COMMANDS command_info[]

GO: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
GO_PRE_COMMANDS command_info[]

GO: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
GO_REVIVE_ARGUMENTS array | string

GO_REVIVE: User custom arguments to add in linter CLI call

GO_REVIVE_CLI_EXECUTABLE string[]

GO_REVIVE: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "revive"
  ]
]
GO_REVIVE_CLI_LINT_MODE string

GO_REVIVE: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
GO_REVIVE_COMMAND_REMOVE_ARGUMENTS array | string

GO_REVIVE: User custom arguments to remove before calling linter

GO_REVIVE_CONFIG_FILE string

GO_REVIVE: User custom config file name if different from default

Default: "revive.toml"
GO_REVIVE_DISABLE_ERRORS boolean

GO_REVIVE: If true, GO_REVIVE doesn't make MegaLinter fail even if errors are found

Default: false
GO_REVIVE_DISABLE_ERRORS_IF_LESS_THAN number

GO_REVIVE: If the number of errors found is less than this value, GO_REVIVE doesn't make MegaLinter fail

Default: 0
GO_REVIVE_FILE_EXTENSIONS string[]

GO_REVIVE: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".go"
]
Examples: ".py", ".myext"
GO_REVIVE_FILE_NAMES_REGEX string[]

GO_REVIVE: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
GO_REVIVE_FILTER_REGEX_EXCLUDE string

GO_REVIVE: Custom regex excluding filter: files matching this regex will NOT be linted

GO_REVIVE_FILTER_REGEX_INCLUDE string

GO_REVIVE: Custom regex including filter: only files matching this regex will be linted

GO_REVIVE_POST_COMMANDS command_info[]

GO_REVIVE: Define bash commands to run after running GO_REVIVE

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
GO_REVIVE_PRE_COMMANDS command_info[]

GO_REVIVE: Define bash commands to run before running GO_REVIVE

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
GO_REVIVE_RULES_PATH string

GO_REVIVE: Path where to find linter configuration file

GO_REVIVE_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling GO_REVIVE and its pre/post commands

Default:
[]
GRAPHQL_FILTER_REGEX_EXCLUDE string

GRAPHQL: Custom regex excluding filter: files matching this regex will NOT be linted

GRAPHQL_FILTER_REGEX_INCLUDE string

GRAPHQL: Custom regex including filter: only files matching this regex will be linted

GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS array | string

GRAPHQL_GRAPHQL_SCHEMA_LINTER: User custom arguments to add in linter CLI call

GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_EXECUTABLE string[]

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "graphql-schema-linter"
  ]
]
GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_LINT_MODE string

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
GRAPHQL_GRAPHQL_SCHEMA_LINTER_COMMAND_REMOVE_ARGUMENTS array | string

GRAPHQL_GRAPHQL_SCHEMA_LINTER: User custom arguments to remove before calling linter

GRAPHQL_GRAPHQL_SCHEMA_LINTER_CONFIG_FILE string

GRAPHQL_GRAPHQL_SCHEMA_LINTER: User custom config file name if different from default

Default: ".graphql-schema-linterrc"
GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS boolean

GRAPHQL_GRAPHQL_SCHEMA_LINTER: If true, GRAPHQL_GRAPHQL_SCHEMA_LINTER doesn't make MegaLinter fail even if errors are found

Default: false
GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS_IF_LESS_THAN number

GRAPHQL_GRAPHQL_SCHEMA_LINTER: If the number of errors found is less than this value, GRAPHQL_GRAPHQL_SCHEMA_LINTER doesn't make MegaLinter fail

Default: 0
GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS string[]

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".graphql"
]
Examples: ".py", ".myext"
GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX string[]

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_EXCLUDE string

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom regex excluding filter: files matching this regex will NOT be linted

GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_INCLUDE string

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom regex including filter: only files matching this regex will be linted

GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS command_info[]

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Define bash commands to run after running GRAPHQL_GRAPHQL_SCHEMA_LINTER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS command_info[]

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Define bash commands to run before running GRAPHQL_GRAPHQL_SCHEMA_LINTER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
GRAPHQL_GRAPHQL_SCHEMA_LINTER_RULES_PATH string

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Path where to find linter configuration file

GRAPHQL_GRAPHQL_SCHEMA_LINTER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling GRAPHQL_GRAPHQL_SCHEMA_LINTER and its pre/post commands

Default:
[]
GRAPHQL_POST_COMMANDS command_info[]

GRAPHQL: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
GRAPHQL_PRE_COMMANDS command_info[]

GRAPHQL: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
GROOVY_FILTER_REGEX_EXCLUDE string

GROOVY: Custom regex excluding filter: files matching this regex will NOT be linted

GROOVY_FILTER_REGEX_INCLUDE string

GROOVY: Custom regex including filter: only files matching this regex will be linted

GROOVY_NPM_GROOVY_LINT_ARGUMENTS array | string

GROOVY_NPM_GROOVY_LINT: User custom arguments to add in linter CLI call

GROOVY_NPM_GROOVY_LINT_CLI_EXECUTABLE string[]

GROOVY_NPM_GROOVY_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "npm-groovy-lint"
  ]
]
GROOVY_NPM_GROOVY_LINT_CLI_LINT_MODE string

GROOVY_NPM_GROOVY_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
GROOVY_NPM_GROOVY_LINT_COMMAND_REMOVE_ARGUMENTS array | string

GROOVY_NPM_GROOVY_LINT: User custom arguments to remove before calling linter

GROOVY_NPM_GROOVY_LINT_CONFIG_FILE string

GROOVY_NPM_GROOVY_LINT: User custom config file name if different from default

Default: ".groovylintrc.json"
GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS boolean

GROOVY_NPM_GROOVY_LINT: If true, GROOVY_NPM_GROOVY_LINT doesn't make MegaLinter fail even if errors are found

Default: false
GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS_IF_LESS_THAN number

GROOVY_NPM_GROOVY_LINT: If the number of errors found is less than this value, GROOVY_NPM_GROOVY_LINT doesn't make MegaLinter fail

Default: 0
GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS string[]

GROOVY_NPM_GROOVY_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".groovy",
  ".gvy",
  ".gradle",
  ".nf"
]
Examples: ".py", ".myext"
GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX string[]

GROOVY_NPM_GROOVY_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[
  "Jenkinsfile"
]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_EXCLUDE string

GROOVY_NPM_GROOVY_LINT: Custom regex excluding filter: files matching this regex will NOT be linted

GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_INCLUDE string

GROOVY_NPM_GROOVY_LINT: Custom regex including filter: only files matching this regex will be linted

GROOVY_NPM_GROOVY_LINT_POST_COMMANDS command_info[]

GROOVY_NPM_GROOVY_LINT: Define bash commands to run after running GROOVY_NPM_GROOVY_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS command_info[]

GROOVY_NPM_GROOVY_LINT: Define bash commands to run before running GROOVY_NPM_GROOVY_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
GROOVY_NPM_GROOVY_LINT_RULES_PATH string

GROOVY_NPM_GROOVY_LINT: Path where to find linter configuration file

GROOVY_NPM_GROOVY_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling GROOVY_NPM_GROOVY_LINT and its pre/post commands

Default:
[]
GROOVY_POST_COMMANDS command_info[]

GROOVY: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
GROOVY_PRE_COMMANDS command_info[]

GROOVY: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
HTML_DJLINT_ARGUMENTS array | string

HTML_DJLINT: User custom arguments to add in linter CLI call

HTML_DJLINT_CLI_EXECUTABLE string[]

HTML_DJLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "djlint"
  ]
]
HTML_DJLINT_CLI_LINT_MODE string

HTML_DJLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
HTML_DJLINT_COMMAND_REMOVE_ARGUMENTS array | string

HTML_DJLINT: User custom arguments to remove before calling linter

HTML_DJLINT_DISABLE_ERRORS boolean

HTML_DJLINT: If true, HTML_DJLINT doesn't make MegaLinter fail even if errors are found

Default: false
HTML_DJLINT_DISABLE_ERRORS_IF_LESS_THAN number

HTML_DJLINT: If the number of errors found is less than this value, HTML_DJLINT doesn't make MegaLinter fail

Default: 0
HTML_DJLINT_FILE_EXTENSIONS string[]

HTML_DJLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".html",
  ".htm"
]
Examples: ".py", ".myext"
HTML_DJLINT_FILE_NAMES_REGEX string[]

HTML_DJLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
HTML_DJLINT_FILTER_REGEX_EXCLUDE string

HTML_DJLINT: Custom regex excluding filter: files matching this regex will NOT be linted

HTML_DJLINT_FILTER_REGEX_INCLUDE string

HTML_DJLINT: Custom regex including filter: only files matching this regex will be linted

HTML_DJLINT_POST_COMMANDS command_info[]

HTML_DJLINT: Define bash commands to run after running HTML_DJLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
HTML_DJLINT_PRE_COMMANDS command_info[]

HTML_DJLINT: Define bash commands to run before running HTML_DJLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
HTML_DJLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling HTML_DJLINT and its pre/post commands

Default:
[]
HTML_FILTER_REGEX_EXCLUDE string

HTML: Custom regex excluding filter: files matching this regex will NOT be linted

HTML_FILTER_REGEX_INCLUDE string

HTML: Custom regex including filter: only files matching this regex will be linted

HTML_HTMLHINT_ARGUMENTS array | string

HTML_HTMLHINT: User custom arguments to add in linter CLI call

HTML_HTMLHINT_CLI_EXECUTABLE string[]

HTML_HTMLHINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "htmlhint"
  ]
]
HTML_HTMLHINT_CLI_LINT_MODE string

HTML_HTMLHINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
HTML_HTMLHINT_COMMAND_REMOVE_ARGUMENTS array | string

HTML_HTMLHINT: User custom arguments to remove before calling linter

HTML_HTMLHINT_CONFIG_FILE string

HTML_HTMLHINT: User custom config file name if different from default

Default: ".htmlhintrc"
HTML_HTMLHINT_DISABLE_ERRORS boolean

HTML_HTMLHINT: If true, HTML_HTMLHINT doesn't make MegaLinter fail even if errors are found

Default: false
HTML_HTMLHINT_DISABLE_ERRORS_IF_LESS_THAN number

HTML_HTMLHINT: If the number of errors found is less than this value, HTML_HTMLHINT doesn't make MegaLinter fail

Default: 0
HTML_HTMLHINT_FILE_EXTENSIONS string[]

HTML_HTMLHINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".html",
  ".htm"
]
Examples: ".py", ".myext"
HTML_HTMLHINT_FILE_NAMES_REGEX string[]

HTML_HTMLHINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
HTML_HTMLHINT_FILTER_REGEX_EXCLUDE string

HTML_HTMLHINT: Custom regex excluding filter: files matching this regex will NOT be linted

HTML_HTMLHINT_FILTER_REGEX_INCLUDE string

HTML_HTMLHINT: Custom regex including filter: only files matching this regex will be linted

HTML_HTMLHINT_POST_COMMANDS command_info[]

HTML_HTMLHINT: Define bash commands to run after running HTML_HTMLHINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
HTML_HTMLHINT_PRE_COMMANDS command_info[]

HTML_HTMLHINT: Define bash commands to run before running HTML_HTMLHINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
HTML_HTMLHINT_RULES_PATH string

HTML_HTMLHINT: Path where to find linter configuration file

HTML_HTMLHINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling HTML_HTMLHINT and its pre/post commands

Default:
[]
HTML_POST_COMMANDS command_info[]

HTML: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
HTML_PRE_COMMANDS command_info[]

HTML: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
IGNORE_GENERATED_FILES boolean

Makes MegaLinter skip files containing @generated marker (and not containing @not-generated)

Default: false
IGNORE_GITIGNORED_FILES boolean

Makes MegaLinter skip files that are ignored by git using .gitignore

Default: false
JAVASCRIPT_DEFAULT_STYLE string

Style of javascript formatting to apply

Default: "prettier"
Values: "standard" "prettier"
Examples: "standard", "prettier"
JAVASCRIPT_ES_ARGUMENTS array | string

JAVASCRIPT_ES: User custom arguments to add in linter CLI call

JAVASCRIPT_ES_CLI_EXECUTABLE string[]

JAVASCRIPT_ES: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "eslint"
  ]
]
JAVASCRIPT_ES_CLI_LINT_MODE string

JAVASCRIPT_ES: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
JAVASCRIPT_ES_COMMAND_REMOVE_ARGUMENTS array | string

JAVASCRIPT_ES: User custom arguments to remove before calling linter

JAVASCRIPT_ES_CONFIG_FILE string

JAVASCRIPT_ES: User custom config file name if different from default

Default: ".eslintrc.json"
JAVASCRIPT_ES_DISABLE_ERRORS boolean

JAVASCRIPT_ES: If true, JAVASCRIPT_ES doesn't make MegaLinter fail even if errors are found

Default: false
JAVASCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN number

JAVASCRIPT_ES: If the number of errors found is less than this value, JAVASCRIPT_ES doesn't make MegaLinter fail

Default: 0
JAVASCRIPT_ES_FILE_EXTENSIONS string[]

JAVASCRIPT_ES: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".js",
  ".vue"
]
Examples: ".py", ".myext"
JAVASCRIPT_ES_FILE_NAMES_REGEX string[]

JAVASCRIPT_ES: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
JAVASCRIPT_ES_FILTER_REGEX_EXCLUDE string

JAVASCRIPT_ES: Custom regex excluding filter: files matching this regex will NOT be linted

JAVASCRIPT_ES_FILTER_REGEX_INCLUDE string

JAVASCRIPT_ES: Custom regex including filter: only files matching this regex will be linted

JAVASCRIPT_ES_POST_COMMANDS command_info[]

JAVASCRIPT_ES: Define bash commands to run after running JAVASCRIPT_ES

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JAVASCRIPT_ES_PRE_COMMANDS command_info[]

JAVASCRIPT_ES: Define bash commands to run before running JAVASCRIPT_ES

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
JAVASCRIPT_ES_RULES_PATH string

JAVASCRIPT_ES: Path where to find linter configuration file

JAVASCRIPT_ES_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling JAVASCRIPT_ES and its pre/post commands

Default:
[]
JAVASCRIPT_FILTER_REGEX_EXCLUDE string

JAVASCRIPT: Custom regex excluding filter: files matching this regex will NOT be linted

JAVASCRIPT_FILTER_REGEX_INCLUDE string

JAVASCRIPT: Custom regex including filter: only files matching this regex will be linted

JAVASCRIPT_POST_COMMANDS command_info[]

JAVASCRIPT: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JAVASCRIPT_PRETTIER_ARGUMENTS array | string

JAVASCRIPT_PRETTIER: User custom arguments to add in linter CLI call

JAVASCRIPT_PRETTIER_CLI_EXECUTABLE string[]

JAVASCRIPT_PRETTIER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "prettier"
  ]
]
JAVASCRIPT_PRETTIER_CLI_LINT_MODE string

JAVASCRIPT_PRETTIER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
JAVASCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS array | string

JAVASCRIPT_PRETTIER: User custom arguments to remove before calling linter

JAVASCRIPT_PRETTIER_CONFIG_FILE string

JAVASCRIPT_PRETTIER: User custom config file name if different from default

Default: ".prettierrc.json"
JAVASCRIPT_PRETTIER_DISABLE_ERRORS boolean

JAVASCRIPT_PRETTIER: If true, JAVASCRIPT_PRETTIER doesn't make MegaLinter fail even if errors are found

Default: false
JAVASCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN number

JAVASCRIPT_PRETTIER: If the number of errors found is less than this value, JAVASCRIPT_PRETTIER doesn't make MegaLinter fail

Default: 0
JAVASCRIPT_PRETTIER_FILE_EXTENSIONS string[]

JAVASCRIPT_PRETTIER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".js"
]
Examples: ".py", ".myext"
JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX string[]

JAVASCRIPT_PRETTIER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
JAVASCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE string

JAVASCRIPT_PRETTIER: Custom regex excluding filter: files matching this regex will NOT be linted

JAVASCRIPT_PRETTIER_FILTER_REGEX_INCLUDE string

JAVASCRIPT_PRETTIER: Custom regex including filter: only files matching this regex will be linted

JAVASCRIPT_PRETTIER_POST_COMMANDS command_info[]

JAVASCRIPT_PRETTIER: Define bash commands to run after running JAVASCRIPT_PRETTIER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JAVASCRIPT_PRETTIER_PRE_COMMANDS command_info[]

JAVASCRIPT_PRETTIER: Define bash commands to run before running JAVASCRIPT_PRETTIER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
JAVASCRIPT_PRETTIER_RULES_PATH string

JAVASCRIPT_PRETTIER: Path where to find linter configuration file

JAVASCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling JAVASCRIPT_PRETTIER and its pre/post commands

Default:
[]
JAVASCRIPT_PRE_COMMANDS command_info[]

JAVASCRIPT: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
JAVASCRIPT_STANDARD_ARGUMENTS array | string

JAVASCRIPT_STANDARD: User custom arguments to add in linter CLI call

JAVASCRIPT_STANDARD_CLI_EXECUTABLE string[]

JAVASCRIPT_STANDARD: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "standard"
  ]
]
JAVASCRIPT_STANDARD_CLI_LINT_MODE string

JAVASCRIPT_STANDARD: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
JAVASCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS array | string

JAVASCRIPT_STANDARD: User custom arguments to remove before calling linter

JAVASCRIPT_STANDARD_DISABLE_ERRORS boolean

JAVASCRIPT_STANDARD: If true, JAVASCRIPT_STANDARD doesn't make MegaLinter fail even if errors are found

Default: false
JAVASCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN number

JAVASCRIPT_STANDARD: If the number of errors found is less than this value, JAVASCRIPT_STANDARD doesn't make MegaLinter fail

Default: 0
JAVASCRIPT_STANDARD_FILE_EXTENSIONS string[]

JAVASCRIPT_STANDARD: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".js"
]
Examples: ".py", ".myext"
JAVASCRIPT_STANDARD_FILE_NAMES_REGEX string[]

JAVASCRIPT_STANDARD: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
JAVASCRIPT_STANDARD_FILTER_REGEX_EXCLUDE string

JAVASCRIPT_STANDARD: Custom regex excluding filter: files matching this regex will NOT be linted

JAVASCRIPT_STANDARD_FILTER_REGEX_INCLUDE string

JAVASCRIPT_STANDARD: Custom regex including filter: only files matching this regex will be linted

JAVASCRIPT_STANDARD_POST_COMMANDS command_info[]

JAVASCRIPT_STANDARD: Define bash commands to run after running JAVASCRIPT_STANDARD

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JAVASCRIPT_STANDARD_PRE_COMMANDS command_info[]

JAVASCRIPT_STANDARD: Define bash commands to run before running JAVASCRIPT_STANDARD

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
JAVASCRIPT_STANDARD_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling JAVASCRIPT_STANDARD and its pre/post commands

Default:
[]
JAVA_CHECKSTYLE_ARGUMENTS array | string

JAVA_CHECKSTYLE: User custom arguments to add in linter CLI call

JAVA_CHECKSTYLE_CLI_EXECUTABLE string[]

JAVA_CHECKSTYLE: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "java"
  ]
]
JAVA_CHECKSTYLE_CLI_LINT_MODE string

JAVA_CHECKSTYLE: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
JAVA_CHECKSTYLE_COMMAND_REMOVE_ARGUMENTS array | string

JAVA_CHECKSTYLE: User custom arguments to remove before calling linter

JAVA_CHECKSTYLE_CONFIG_FILE string

JAVA_CHECKSTYLE: User custom config file name if different from default

Default: "sun_checks.xml"
JAVA_CHECKSTYLE_DISABLE_ERRORS boolean

JAVA_CHECKSTYLE: If true, JAVA_CHECKSTYLE doesn't make MegaLinter fail even if errors are found

Default: false
JAVA_CHECKSTYLE_DISABLE_ERRORS_IF_LESS_THAN number

JAVA_CHECKSTYLE: If the number of errors found is less than this value, JAVA_CHECKSTYLE doesn't make MegaLinter fail

Default: 0
JAVA_CHECKSTYLE_FILE_EXTENSIONS string[]

JAVA_CHECKSTYLE: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".java"
]
Examples: ".py", ".myext"
JAVA_CHECKSTYLE_FILE_NAMES_REGEX string[]

JAVA_CHECKSTYLE: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
JAVA_CHECKSTYLE_FILTER_REGEX_EXCLUDE string

JAVA_CHECKSTYLE: Custom regex excluding filter: files matching this regex will NOT be linted

JAVA_CHECKSTYLE_FILTER_REGEX_INCLUDE string

JAVA_CHECKSTYLE: Custom regex including filter: only files matching this regex will be linted

JAVA_CHECKSTYLE_POST_COMMANDS command_info[]

JAVA_CHECKSTYLE: Define bash commands to run after running JAVA_CHECKSTYLE

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JAVA_CHECKSTYLE_PRE_COMMANDS command_info[]

JAVA_CHECKSTYLE: Define bash commands to run before running JAVA_CHECKSTYLE

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
JAVA_CHECKSTYLE_RULES_PATH string

JAVA_CHECKSTYLE: Path where to find linter configuration file

JAVA_CHECKSTYLE_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling JAVA_CHECKSTYLE and its pre/post commands

Default:
[]
JAVA_FILTER_REGEX_EXCLUDE string

JAVA: Custom regex excluding filter: files matching this regex will NOT be linted

JAVA_FILTER_REGEX_INCLUDE string

JAVA: Custom regex including filter: only files matching this regex will be linted

JAVA_PMD_ARGUMENTS array | string

JAVA_PMD: User custom arguments to add in linter CLI call

JAVA_PMD_CLI_EXECUTABLE string[]

JAVA_PMD: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "/usr/bin/pmd/bin/pmd"
  ]
]
JAVA_PMD_CLI_LINT_MODE string

JAVA_PMD: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
JAVA_PMD_COMMAND_REMOVE_ARGUMENTS array | string

JAVA_PMD: User custom arguments to remove before calling linter

JAVA_PMD_CONFIG_FILE string

JAVA_PMD: User custom config file name if different from default

Default: "java-pmd-ruleset.xml"
JAVA_PMD_DISABLE_ERRORS boolean

JAVA_PMD: If true, JAVA_PMD doesn't make MegaLinter fail even if errors are found

Default: false
JAVA_PMD_DISABLE_ERRORS_IF_LESS_THAN number

JAVA_PMD: If the number of errors found is less than this value, JAVA_PMD doesn't make MegaLinter fail

Default: 0
JAVA_PMD_FILE_EXTENSIONS string[]

JAVA_PMD: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".java"
]
Examples: ".py", ".myext"
JAVA_PMD_FILE_NAMES_REGEX string[]

JAVA_PMD: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
JAVA_PMD_FILTER_REGEX_EXCLUDE string

JAVA_PMD: Custom regex excluding filter: files matching this regex will NOT be linted

JAVA_PMD_FILTER_REGEX_INCLUDE string

JAVA_PMD: Custom regex including filter: only files matching this regex will be linted

JAVA_PMD_POST_COMMANDS command_info[]

JAVA_PMD: Define bash commands to run after running JAVA_PMD

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JAVA_PMD_PRE_COMMANDS command_info[]

JAVA_PMD: Define bash commands to run before running JAVA_PMD

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
JAVA_PMD_RULES_PATH string

JAVA_PMD: Path where to find linter configuration file

JAVA_PMD_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling JAVA_PMD and its pre/post commands

Default:
[]
JAVA_POST_COMMANDS command_info[]

JAVA: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JAVA_PRE_COMMANDS command_info[]

JAVA: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
JOB_SUMMARY_ADDITIONAL_MARKDOWN string

Custom markdown to add at the end of the summary message posted on a PR/MR

JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS array | string

JSON_ESLINT_PLUGIN_JSONC: User custom arguments to add in linter CLI call

JSON_ESLINT_PLUGIN_JSONC_CLI_EXECUTABLE string[]

JSON_ESLINT_PLUGIN_JSONC: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "eslint"
  ]
]
JSON_ESLINT_PLUGIN_JSONC_CLI_LINT_MODE string

JSON_ESLINT_PLUGIN_JSONC: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
JSON_ESLINT_PLUGIN_JSONC_COMMAND_REMOVE_ARGUMENTS array | string

JSON_ESLINT_PLUGIN_JSONC: User custom arguments to remove before calling linter

JSON_ESLINT_PLUGIN_JSONC_CONFIG_FILE string

JSON_ESLINT_PLUGIN_JSONC: User custom config file name if different from default

Default: ".eslintrc-json.json"
JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS boolean

JSON_ESLINT_PLUGIN_JSONC: If true, JSON_ESLINT_PLUGIN_JSONC doesn't make MegaLinter fail even if errors are found

Default: false
JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS_IF_LESS_THAN number

JSON_ESLINT_PLUGIN_JSONC: If the number of errors found is less than this value, JSON_ESLINT_PLUGIN_JSONC doesn't make MegaLinter fail

Default: 0
JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS string[]

JSON_ESLINT_PLUGIN_JSONC: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".json",
  ".json5",
  ".jsonc"
]
Examples: ".py", ".myext"
JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX string[]

JSON_ESLINT_PLUGIN_JSONC: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_EXCLUDE string

JSON_ESLINT_PLUGIN_JSONC: Custom regex excluding filter: files matching this regex will NOT be linted

JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_INCLUDE string

JSON_ESLINT_PLUGIN_JSONC: Custom regex including filter: only files matching this regex will be linted

JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS command_info[]

JSON_ESLINT_PLUGIN_JSONC: Define bash commands to run after running JSON_ESLINT_PLUGIN_JSONC

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS command_info[]

JSON_ESLINT_PLUGIN_JSONC: Define bash commands to run before running JSON_ESLINT_PLUGIN_JSONC

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
JSON_ESLINT_PLUGIN_JSONC_RULES_PATH string

JSON_ESLINT_PLUGIN_JSONC: Path where to find linter configuration file

JSON_ESLINT_PLUGIN_JSONC_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling JSON_ESLINT_PLUGIN_JSONC and its pre/post commands

Default:
[]
JSON_FILTER_REGEX_EXCLUDE string

JSON: Custom regex excluding filter: files matching this regex will NOT be linted

JSON_FILTER_REGEX_INCLUDE string

JSON: Custom regex including filter: only files matching this regex will be linted

JSON_JSONLINT_ARGUMENTS array | string

JSON_JSONLINT: User custom arguments to add in linter CLI call

JSON_JSONLINT_CLI_EXECUTABLE string[]

JSON_JSONLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "jsonlint"
  ]
]
JSON_JSONLINT_CLI_LINT_MODE string

JSON_JSONLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
JSON_JSONLINT_COMMAND_REMOVE_ARGUMENTS array | string

JSON_JSONLINT: User custom arguments to remove before calling linter

JSON_JSONLINT_CONFIG_FILE string

JSON_JSONLINT: User custom config file name if different from default

Default: ".jsonlintrc"
JSON_JSONLINT_DISABLE_ERRORS boolean

JSON_JSONLINT: If true, JSON_JSONLINT doesn't make MegaLinter fail even if errors are found

Default: false
JSON_JSONLINT_DISABLE_ERRORS_IF_LESS_THAN number

JSON_JSONLINT: If the number of errors found is less than this value, JSON_JSONLINT doesn't make MegaLinter fail

Default: 0
JSON_JSONLINT_FILE_EXTENSIONS string[]

JSON_JSONLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".json"
]
Examples: ".py", ".myext"
JSON_JSONLINT_FILE_NAMES_REGEX string[]

JSON_JSONLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
JSON_JSONLINT_FILTER_REGEX_EXCLUDE string

JSON_JSONLINT: Custom regex excluding filter: files matching this regex will NOT be linted

JSON_JSONLINT_FILTER_REGEX_INCLUDE string

JSON_JSONLINT: Custom regex including filter: only files matching this regex will be linted

JSON_JSONLINT_POST_COMMANDS command_info[]

JSON_JSONLINT: Define bash commands to run after running JSON_JSONLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JSON_JSONLINT_PRE_COMMANDS command_info[]

JSON_JSONLINT: Define bash commands to run before running JSON_JSONLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
JSON_JSONLINT_RULES_PATH string

JSON_JSONLINT: Path where to find linter configuration file

JSON_JSONLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling JSON_JSONLINT and its pre/post commands

Default:
[]
JSON_NPM_PACKAGE_JSON_LINT_ARGUMENTS array | string

JSON_NPM_PACKAGE_JSON_LINT: User custom arguments to add in linter CLI call

JSON_NPM_PACKAGE_JSON_LINT_CLI_EXECUTABLE string[]

JSON_NPM_PACKAGE_JSON_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "npmPkgJsonLint"
  ]
]
JSON_NPM_PACKAGE_JSON_LINT_CLI_LINT_MODE string

JSON_NPM_PACKAGE_JSON_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
JSON_NPM_PACKAGE_JSON_LINT_COMMAND_REMOVE_ARGUMENTS array | string

JSON_NPM_PACKAGE_JSON_LINT: User custom arguments to remove before calling linter

JSON_NPM_PACKAGE_JSON_LINT_CONFIG_FILE string

JSON_NPM_PACKAGE_JSON_LINT: User custom config file name if different from default

Default: ".npmpackagejsonlintrc.json"
JSON_NPM_PACKAGE_JSON_LINT_DISABLE_ERRORS boolean

JSON_NPM_PACKAGE_JSON_LINT: If true, JSON_NPM_PACKAGE_JSON_LINT doesn't make MegaLinter fail even if errors are found

Default: false
JSON_NPM_PACKAGE_JSON_LINT_DISABLE_ERRORS_IF_LESS_THAN number

JSON_NPM_PACKAGE_JSON_LINT: If the number of errors found is less than this value, JSON_NPM_PACKAGE_JSON_LINT doesn't make MegaLinter fail

Default: 0
JSON_NPM_PACKAGE_JSON_LINT_FILE_EXTENSIONS string[]

JSON_NPM_PACKAGE_JSON_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".json"
]
Examples: ".py", ".myext"
JSON_NPM_PACKAGE_JSON_LINT_FILE_NAMES_REGEX string[]

JSON_NPM_PACKAGE_JSON_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[
  "package\\.json"
]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS command_info[]

JSON_NPM_PACKAGE_JSON_LINT: Define bash commands to run after running JSON_NPM_PACKAGE_JSON_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS command_info[]

JSON_NPM_PACKAGE_JSON_LINT: Define bash commands to run before running JSON_NPM_PACKAGE_JSON_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
JSON_NPM_PACKAGE_JSON_LINT_RULES_PATH string

JSON_NPM_PACKAGE_JSON_LINT: Path where to find linter configuration file

JSON_NPM_PACKAGE_JSON_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling JSON_NPM_PACKAGE_JSON_LINT and its pre/post commands

Default:
[]
JSON_POST_COMMANDS command_info[]

JSON: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JSON_PRETTIER_ARGUMENTS array | string

JSON_PRETTIER: User custom arguments to add in linter CLI call

JSON_PRETTIER_CLI_EXECUTABLE string[]

JSON_PRETTIER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "prettier"
  ]
]
JSON_PRETTIER_CLI_LINT_MODE string

JSON_PRETTIER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
JSON_PRETTIER_COMMAND_REMOVE_ARGUMENTS array | string

JSON_PRETTIER: User custom arguments to remove before calling linter

JSON_PRETTIER_CONFIG_FILE string

JSON_PRETTIER: User custom config file name if different from default

Default: ".prettierrc.json"
JSON_PRETTIER_DISABLE_ERRORS boolean

JSON_PRETTIER: If true, JSON_PRETTIER doesn't make MegaLinter fail even if errors are found

Default: false
JSON_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN number

JSON_PRETTIER: If the number of errors found is less than this value, JSON_PRETTIER doesn't make MegaLinter fail

Default: 0
JSON_PRETTIER_FILE_EXTENSIONS string[]

JSON_PRETTIER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".json"
]
Examples: ".py", ".myext"
JSON_PRETTIER_FILE_NAMES_REGEX string[]

JSON_PRETTIER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
JSON_PRETTIER_FILTER_REGEX_EXCLUDE string

JSON_PRETTIER: Custom regex excluding filter: files matching this regex will NOT be linted

JSON_PRETTIER_FILTER_REGEX_INCLUDE string

JSON_PRETTIER: Custom regex including filter: only files matching this regex will be linted

JSON_PRETTIER_POST_COMMANDS command_info[]

JSON_PRETTIER: Define bash commands to run after running JSON_PRETTIER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JSON_PRETTIER_PRE_COMMANDS command_info[]

JSON_PRETTIER: Define bash commands to run before running JSON_PRETTIER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
JSON_PRETTIER_RULES_PATH string

JSON_PRETTIER: Path where to find linter configuration file

JSON_PRETTIER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling JSON_PRETTIER and its pre/post commands

Default:
[]
JSON_PRE_COMMANDS command_info[]

JSON: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
JSON_REPORTER boolean

Output a large execution log in a JSON file named mega-linter-report.json

Default: false
JSON_REPORTER_OUTPUT_DETAIL string

Defines if output contain only error files (simple) or all files (detailed)

Default: "simple"
Values: "simple" "detailed"
JSON_V8R_ARGUMENTS array | string

JSON_V8R: User custom arguments to add in linter CLI call

JSON_V8R_CLI_EXECUTABLE string[]

JSON_V8R: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "v8r"
  ]
]
JSON_V8R_CLI_LINT_MODE string

JSON_V8R: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
JSON_V8R_COMMAND_REMOVE_ARGUMENTS array | string

JSON_V8R: User custom arguments to remove before calling linter

JSON_V8R_DISABLE_ERRORS boolean

JSON_V8R: If true, JSON_V8R doesn't make MegaLinter fail even if errors are found

Default: false
JSON_V8R_DISABLE_ERRORS_IF_LESS_THAN number

JSON_V8R: If the number of errors found is less than this value, JSON_V8R doesn't make MegaLinter fail

Default: 0
JSON_V8R_FILE_EXTENSIONS string[]

JSON_V8R: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".json"
]
Examples: ".py", ".myext"
JSON_V8R_FILE_NAMES_REGEX string[]

JSON_V8R: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
JSON_V8R_FILTER_REGEX_EXCLUDE string

JSON_V8R: Custom regex excluding filter: files matching this regex will NOT be linted

JSON_V8R_FILTER_REGEX_INCLUDE string

JSON_V8R: Custom regex including filter: only files matching this regex will be linted

JSON_V8R_POST_COMMANDS command_info[]

JSON_V8R: Define bash commands to run after running JSON_V8R

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JSON_V8R_PRE_COMMANDS command_info[]

JSON_V8R: Define bash commands to run before running JSON_V8R

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
JSON_V8R_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling JSON_V8R and its pre/post commands

Default:
[]
JSX_ESLINT_ARGUMENTS array | string

JSX_ESLINT: User custom arguments to add in linter CLI call

JSX_ESLINT_CLI_EXECUTABLE string[]

JSX_ESLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "eslint"
  ]
]
JSX_ESLINT_CLI_LINT_MODE string

JSX_ESLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
JSX_ESLINT_COMMAND_REMOVE_ARGUMENTS array | string

JSX_ESLINT: User custom arguments to remove before calling linter

JSX_ESLINT_CONFIG_FILE string

JSX_ESLINT: User custom config file name if different from default

Default: "eslint.config.js"
JSX_ESLINT_DISABLE_ERRORS boolean

JSX_ESLINT: If true, JSX_ESLINT doesn't make MegaLinter fail even if errors are found

Default: false
JSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN number

JSX_ESLINT: If the number of errors found is less than this value, JSX_ESLINT doesn't make MegaLinter fail

Default: 0
JSX_ESLINT_FILE_EXTENSIONS string[]

JSX_ESLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".jsx"
]
Examples: ".py", ".myext"
JSX_ESLINT_FILE_NAMES_REGEX string[]

JSX_ESLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
JSX_ESLINT_FILTER_REGEX_EXCLUDE string

JSX_ESLINT: Custom regex excluding filter: files matching this regex will NOT be linted

JSX_ESLINT_FILTER_REGEX_INCLUDE string

JSX_ESLINT: Custom regex including filter: only files matching this regex will be linted

JSX_ESLINT_POST_COMMANDS command_info[]

JSX_ESLINT: Define bash commands to run after running JSX_ESLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JSX_ESLINT_PRE_COMMANDS command_info[]

JSX_ESLINT: Define bash commands to run before running JSX_ESLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
JSX_ESLINT_RULES_PATH string

JSX_ESLINT: Path where to find linter configuration file

JSX_ESLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling JSX_ESLINT and its pre/post commands

Default:
[]
JSX_FILTER_REGEX_EXCLUDE string

JSX: Custom regex excluding filter: files matching this regex will NOT be linted

JSX_FILTER_REGEX_INCLUDE string

JSX: Custom regex including filter: only files matching this regex will be linted

JSX_POST_COMMANDS command_info[]

JSX: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
JSX_PRE_COMMANDS command_info[]

JSX: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
KOTLIN_DETEKT_ARGUMENTS array | string

KOTLIN_DETEKT: User custom arguments to add in linter CLI call

KOTLIN_DETEKT_CLI_EXECUTABLE string[]

KOTLIN_DETEKT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "detekt-cli"
  ]
]
KOTLIN_DETEKT_CLI_LINT_MODE string

KOTLIN_DETEKT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
KOTLIN_DETEKT_COMMAND_REMOVE_ARGUMENTS array | string

KOTLIN_DETEKT: User custom arguments to remove before calling linter

KOTLIN_DETEKT_CONFIG_FILE string

KOTLIN_DETEKT: User custom config file name if different from default

Default: "detekt-config.yml"
KOTLIN_DETEKT_DISABLE_ERRORS boolean

KOTLIN_DETEKT: If true, KOTLIN_DETEKT doesn't make MegaLinter fail even if errors are found

Default: false
KOTLIN_DETEKT_DISABLE_ERRORS_IF_LESS_THAN number

KOTLIN_DETEKT: If the number of errors found is less than this value, KOTLIN_DETEKT doesn't make MegaLinter fail

Default: 0
KOTLIN_DETEKT_FILE_EXTENSIONS string[]

KOTLIN_DETEKT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".kt",
  ".kts"
]
Examples: ".py", ".myext"
KOTLIN_DETEKT_FILE_NAMES_REGEX string[]

KOTLIN_DETEKT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
KOTLIN_DETEKT_POST_COMMANDS command_info[]

KOTLIN_DETEKT: Define bash commands to run after running KOTLIN_DETEKT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
KOTLIN_DETEKT_PRE_COMMANDS command_info[]

KOTLIN_DETEKT: Define bash commands to run before running KOTLIN_DETEKT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
KOTLIN_DETEKT_RULES_PATH string

KOTLIN_DETEKT: Path where to find linter configuration file

KOTLIN_DETEKT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling KOTLIN_DETEKT and its pre/post commands

Default:
[]
KOTLIN_FILTER_REGEX_EXCLUDE string

KOTLIN: Custom regex excluding filter: files matching this regex will NOT be linted

KOTLIN_FILTER_REGEX_INCLUDE string

KOTLIN: Custom regex including filter: only files matching this regex will be linted

KOTLIN_KTLINT_ARGUMENTS array | string

KOTLIN_KTLINT: User custom arguments to add in linter CLI call

KOTLIN_KTLINT_CLI_EXECUTABLE string[]

KOTLIN_KTLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "ktlint"
  ]
]
KOTLIN_KTLINT_CLI_LINT_MODE string

KOTLIN_KTLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
KOTLIN_KTLINT_COMMAND_REMOVE_ARGUMENTS array | string

KOTLIN_KTLINT: User custom arguments to remove before calling linter

KOTLIN_KTLINT_DISABLE_ERRORS boolean

KOTLIN_KTLINT: If true, KOTLIN_KTLINT doesn't make MegaLinter fail even if errors are found

Default: false
KOTLIN_KTLINT_DISABLE_ERRORS_IF_LESS_THAN number

KOTLIN_KTLINT: If the number of errors found is less than this value, KOTLIN_KTLINT doesn't make MegaLinter fail

Default: 0
KOTLIN_KTLINT_FILE_EXTENSIONS string[]

KOTLIN_KTLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".kt",
  ".kts"
]
Examples: ".py", ".myext"
KOTLIN_KTLINT_FILE_NAMES_REGEX string[]

KOTLIN_KTLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
KOTLIN_KTLINT_FILTER_REGEX_EXCLUDE string

KOTLIN_KTLINT: Custom regex excluding filter: files matching this regex will NOT be linted

KOTLIN_KTLINT_FILTER_REGEX_INCLUDE string

KOTLIN_KTLINT: Custom regex including filter: only files matching this regex will be linted

KOTLIN_KTLINT_POST_COMMANDS command_info[]

KOTLIN_KTLINT: Define bash commands to run after running KOTLIN_KTLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
KOTLIN_KTLINT_PRE_COMMANDS command_info[]

KOTLIN_KTLINT: Define bash commands to run before running KOTLIN_KTLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
KOTLIN_KTLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling KOTLIN_KTLINT and its pre/post commands

Default:
[]
KOTLIN_POST_COMMANDS command_info[]

KOTLIN: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
KOTLIN_PRE_COMMANDS command_info[]

KOTLIN: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
KUBERNETES_DIRECTORY string
KUBERNETES_FILTER_REGEX_EXCLUDE string

KUBERNETES: Custom regex excluding filter: files matching this regex will NOT be linted

KUBERNETES_FILTER_REGEX_INCLUDE string

KUBERNETES: Custom regex including filter: only files matching this regex will be linted

KUBERNETES_HELM_ARGUMENTS array | string

KUBERNETES_HELM: User custom arguments to add in linter CLI call

KUBERNETES_HELM_CLI_EXECUTABLE string[]

KUBERNETES_HELM: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "helm"
  ]
]
KUBERNETES_HELM_CLI_LINT_MODE string

KUBERNETES_HELM: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
KUBERNETES_HELM_COMMAND_REMOVE_ARGUMENTS array | string

KUBERNETES_HELM: User custom arguments to remove before calling linter

KUBERNETES_HELM_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: ""
KUBERNETES_HELM_DISABLE_ERRORS boolean

KUBERNETES_HELM: If true, KUBERNETES_HELM doesn't make MegaLinter fail even if errors are found

Default: false
KUBERNETES_HELM_DISABLE_ERRORS_IF_LESS_THAN number

KUBERNETES_HELM: If the number of errors found is less than this value, KUBERNETES_HELM doesn't make MegaLinter fail

Default: 0
KUBERNETES_HELM_FILE_EXTENSIONS string[]

KUBERNETES_HELM: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".yml",
  ".yaml",
  ".json"
]
Examples: ".py", ".myext"
KUBERNETES_HELM_FILE_NAMES_REGEX string[]

KUBERNETES_HELM: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
KUBERNETES_HELM_POST_COMMANDS command_info[]

KUBERNETES_HELM: Define bash commands to run after running KUBERNETES_HELM

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
KUBERNETES_HELM_PRE_COMMANDS command_info[]

KUBERNETES_HELM: Define bash commands to run before running KUBERNETES_HELM

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
KUBERNETES_HELM_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling KUBERNETES_HELM and its pre/post commands

Default:
[]
KUBERNETES_KUBECONFORM_ARGUMENTS array | string

KUBERNETES_KUBECONFORM: User custom arguments to add in linter CLI call

KUBERNETES_KUBECONFORM_CLI_EXECUTABLE string[]

KUBERNETES_KUBECONFORM: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "kubeconform"
  ]
]
KUBERNETES_KUBECONFORM_CLI_LINT_MODE string

KUBERNETES_KUBECONFORM: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
KUBERNETES_KUBECONFORM_COMMAND_REMOVE_ARGUMENTS array | string

KUBERNETES_KUBECONFORM: User custom arguments to remove before calling linter

KUBERNETES_KUBECONFORM_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: "kubernetes"
KUBERNETES_KUBECONFORM_DISABLE_ERRORS boolean

KUBERNETES_KUBECONFORM: If true, KUBERNETES_KUBECONFORM doesn't make MegaLinter fail even if errors are found

Default: false
KUBERNETES_KUBECONFORM_DISABLE_ERRORS_IF_LESS_THAN number

KUBERNETES_KUBECONFORM: If the number of errors found is less than this value, KUBERNETES_KUBECONFORM doesn't make MegaLinter fail

Default: 0
KUBERNETES_KUBECONFORM_FILE_EXTENSIONS string[]

KUBERNETES_KUBECONFORM: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".yml",
  ".yaml",
  ".json"
]
Examples: ".py", ".myext"
KUBERNETES_KUBECONFORM_FILE_NAMES_REGEX string[]

KUBERNETES_KUBECONFORM: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
KUBERNETES_KUBECONFORM_FILTER_REGEX_EXCLUDE string

KUBERNETES_KUBECONFORM: Custom regex excluding filter: files matching this regex will NOT be linted

KUBERNETES_KUBECONFORM_FILTER_REGEX_INCLUDE string

KUBERNETES_KUBECONFORM: Custom regex including filter: only files matching this regex will be linted

KUBERNETES_KUBECONFORM_POST_COMMANDS command_info[]

KUBERNETES_KUBECONFORM: Define bash commands to run after running KUBERNETES_KUBECONFORM

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
KUBERNETES_KUBECONFORM_PRE_COMMANDS command_info[]

KUBERNETES_KUBECONFORM: Define bash commands to run before running KUBERNETES_KUBECONFORM

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
KUBERNETES_KUBECONFORM_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling KUBERNETES_KUBECONFORM and its pre/post commands

Default:
[]
KUBERNETES_KUBESCAPE_ARGUMENTS array | string

KUBERNETES_KUBESCAPE: User custom arguments to add in linter CLI call

KUBERNETES_KUBESCAPE_CLI_EXECUTABLE string[]

KUBERNETES_KUBESCAPE: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "kubescape"
  ]
]
KUBERNETES_KUBESCAPE_CLI_LINT_MODE string

KUBERNETES_KUBESCAPE: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
KUBERNETES_KUBESCAPE_COMMAND_REMOVE_ARGUMENTS array | string

KUBERNETES_KUBESCAPE: User custom arguments to remove before calling linter

KUBERNETES_KUBESCAPE_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: ""
KUBERNETES_KUBESCAPE_DISABLE_ERRORS boolean

KUBERNETES_KUBESCAPE: If true, KUBERNETES_KUBESCAPE doesn't make MegaLinter fail even if errors are found

Default: false
KUBERNETES_KUBESCAPE_DISABLE_ERRORS_IF_LESS_THAN number

KUBERNETES_KUBESCAPE: If the number of errors found is less than this value, KUBERNETES_KUBESCAPE doesn't make MegaLinter fail

Default: 0
KUBERNETES_KUBESCAPE_FILE_EXTENSIONS string[]

KUBERNETES_KUBESCAPE: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".yml",
  ".yaml",
  ".json"
]
Examples: ".py", ".myext"
KUBERNETES_KUBESCAPE_FILE_NAMES_REGEX string[]

KUBERNETES_KUBESCAPE: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
KUBERNETES_KUBESCAPE_POST_COMMANDS command_info[]

KUBERNETES_KUBESCAPE: Define bash commands to run after running KUBERNETES_KUBESCAPE

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
KUBERNETES_KUBESCAPE_PRE_COMMANDS command_info[]

KUBERNETES_KUBESCAPE: Define bash commands to run before running KUBERNETES_KUBESCAPE

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
KUBERNETES_KUBESCAPE_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling KUBERNETES_KUBESCAPE and its pre/post commands

Default:
[]
KUBERNETES_KUBEVAL_ARGUMENTS array | string

KUBERNETES_KUBEVAL: User custom arguments to add in linter CLI call

KUBERNETES_KUBEVAL_CLI_EXECUTABLE string[]
Default:
[
  [
    "kubeval"
  ]
]
KUBERNETES_KUBEVAL_CLI_LINT_MODE string
Default: "file"
Values: "file" "project"
KUBERNETES_KUBEVAL_DIRECTORY string
Default: "kubernetes"
KUBERNETES_KUBEVAL_DISABLE_ERRORS boolean
Default: false
KUBERNETES_KUBEVAL_DISABLE_ERRORS_IF_LESS_THAN number
Default: 0
KUBERNETES_KUBEVAL_FILE_EXTENSIONS string[]
KUBERNETES_KUBEVAL_FILE_NAMES_REGEX string[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
KUBERNETES_KUBEVAL_FILTER_REGEX_EXCLUDE string
KUBERNETES_KUBEVAL_FILTER_REGEX_INCLUDE string
KUBERNETES_KUBEVAL_POST_COMMANDS command_info[]
Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
KUBERNETES_KUBEVAL_PRE_COMMANDS command_info[]
Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
KUBERNETES_POST_COMMANDS command_info[]

KUBERNETES: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
KUBERNETES_PRE_COMMANDS command_info[]

KUBERNETES: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
LATEX_CHKTEX_ARGUMENTS array | string

LATEX_CHKTEX: User custom arguments to add in linter CLI call

LATEX_CHKTEX_CLI_EXECUTABLE string[]

LATEX_CHKTEX: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "chktex"
  ]
]
LATEX_CHKTEX_CLI_LINT_MODE string

LATEX_CHKTEX: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
LATEX_CHKTEX_COMMAND_REMOVE_ARGUMENTS array | string

LATEX_CHKTEX: User custom arguments to remove before calling linter

LATEX_CHKTEX_CONFIG_FILE string

LATEX_CHKTEX: User custom config file name if different from default

Default: ".chktexrc"
LATEX_CHKTEX_DISABLE_ERRORS boolean

LATEX_CHKTEX: If true, LATEX_CHKTEX doesn't make MegaLinter fail even if errors are found

Default: false
LATEX_CHKTEX_DISABLE_ERRORS_IF_LESS_THAN number

LATEX_CHKTEX: If the number of errors found is less than this value, LATEX_CHKTEX doesn't make MegaLinter fail

Default: 0
LATEX_CHKTEX_FILE_EXTENSIONS string[]

LATEX_CHKTEX: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".tex"
]
Examples: ".py", ".myext"
LATEX_CHKTEX_FILE_NAMES_REGEX string[]

LATEX_CHKTEX: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
LATEX_CHKTEX_FILTER_REGEX_EXCLUDE string

LATEX_CHKTEX: Custom regex excluding filter: files matching this regex will NOT be linted

LATEX_CHKTEX_FILTER_REGEX_INCLUDE string

LATEX_CHKTEX: Custom regex including filter: only files matching this regex will be linted

LATEX_CHKTEX_POST_COMMANDS command_info[]

LATEX_CHKTEX: Define bash commands to run after running LATEX_CHKTEX

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
LATEX_CHKTEX_PRE_COMMANDS command_info[]

LATEX_CHKTEX: Define bash commands to run before running LATEX_CHKTEX

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
LATEX_CHKTEX_RULES_PATH string

LATEX_CHKTEX: Path where to find linter configuration file

LATEX_CHKTEX_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling LATEX_CHKTEX and its pre/post commands

Default:
[]
LATEX_FILTER_REGEX_EXCLUDE string

LATEX: Custom regex excluding filter: files matching this regex will NOT be linted

LATEX_FILTER_REGEX_INCLUDE string

LATEX: Custom regex including filter: only files matching this regex will be linted

LATEX_POST_COMMANDS command_info[]

LATEX: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
LATEX_PRE_COMMANDS command_info[]

LATEX: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
LINTER_RULES_PATH string

Directory for all linter configuration rules. Can be a local folder or a remote URL. Not necessary if your linters configuration files are at the root of your repository

Default: ".github/linters"
Examples: "myrulesfolder", "https://raw.githubusercontent.com/some_org/some_repo/mega-linter-rules"
LLM_ADVISOR_DISABLE_LINTERS enum_linter_keys[]

If LLM_ADVISOR_DISABLE_LINTERS is set, LLM advisor will NOT process these ones

Examples: ["JAVASCRIPT_ES","PYTHON_PYLINT"]
LLM_ADVISOR_ENABLED boolean

Enable AI-powered fix suggestions using Large Language Models

Default: false
Examples: true, false
LLM_ADVISOR_ENABLE_LINTERS enum_linter_keys[]

If LLM_ADVISOR_ENABLE_LINTERS is set, LLM advisor will only process these ones

Examples: ["JAVASCRIPT_ES","PYTHON_PYLINT"]
LLM_ADVISOR_LEVEL string

When to trigger AI suggestions: ERROR (only for blocking linters with return_code != 0) or WARNING (for both blocking and non-blocking linters)

Default: "ERROR"
Values: "ERROR" "WARNING"
Examples: "ERROR", "WARNING"
LLM_ADVISOR_POSITION string

Display LLM Advisor suggestions before or after linter output

Default: "after_linter_output"
Values: "after_linter_output" "before_linter_output"
Examples: "after_linter_output", "before_linter_output"
LLM_MAX_TOKENS string

Maximum number of tokens for LLM response

Default: "1000"
Examples: "500", "1000", "2000"
LLM_MODEL_NAME string

Name of the LLM model to use (provider-specific)

Examples: "gpt-3.5-turbo", "gpt-4", "claude-3-haiku-20240307", "gemini-pro"
LLM_PROVIDER string

LLM provider to use for AI suggestions

Default: "openai"
Values: "openai" "anthropic" "google" "huggingface" "mistral" "deepseek" "grok" "ollama"
Examples: "openai", "anthropic", "google", "ollama"
LLM_TEMPERATURE string

Temperature for LLM generation (0.0 = deterministic, 1.0 = creative)

Default: "0.1"
Examples: "0.0", "0.1", "0.5", "1.0"
LOG_FILE string

The file name for outputting logs. All output is sent to the log file regardless of LOG_LEVEL

Default: "mega-linter.log"
LOG_LEVEL string

How much output the script will generate to the console. One of INFO, DEBUG, WARNING or ERROR.

Default: "INFO"
Values: "INFO" "DEBUG" "WARNING" "ERROR"
LUA_FILTER_REGEX_EXCLUDE string

LUA: Custom regex excluding filter: files matching this regex will NOT be linted

LUA_FILTER_REGEX_INCLUDE string

LUA: Custom regex including filter: only files matching this regex will be linted

LUA_LUACHECK_ARGUMENTS array | string

LUA_LUACHECK: User custom arguments to add in linter CLI call

LUA_LUACHECK_CLI_EXECUTABLE string[]

LUA_LUACHECK: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "luacheck"
  ]
]
LUA_LUACHECK_CLI_LINT_MODE string

LUA_LUACHECK: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
LUA_LUACHECK_COMMAND_REMOVE_ARGUMENTS array | string

LUA_LUACHECK: User custom arguments to remove before calling linter

LUA_LUACHECK_CONFIG_FILE string

LUA_LUACHECK: User custom config file name if different from default

Default: ".luacheckrc"
LUA_LUACHECK_DISABLE_ERRORS boolean

LUA_LUACHECK: If true, LUA_LUACHECK doesn't make MegaLinter fail even if errors are found

Default: false
LUA_LUACHECK_DISABLE_ERRORS_IF_LESS_THAN number

LUA_LUACHECK: If the number of errors found is less than this value, LUA_LUACHECK doesn't make MegaLinter fail

Default: 0
LUA_LUACHECK_FILE_EXTENSIONS string[]

LUA_LUACHECK: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".lua"
]
Examples: ".py", ".myext"
LUA_LUACHECK_FILE_NAMES_REGEX string[]

LUA_LUACHECK: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
LUA_LUACHECK_FILTER_REGEX_EXCLUDE string

LUA_LUACHECK: Custom regex excluding filter: files matching this regex will NOT be linted

LUA_LUACHECK_FILTER_REGEX_INCLUDE string

LUA_LUACHECK: Custom regex including filter: only files matching this regex will be linted

LUA_LUACHECK_POST_COMMANDS command_info[]

LUA_LUACHECK: Define bash commands to run after running LUA_LUACHECK

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
LUA_LUACHECK_PRE_COMMANDS command_info[]

LUA_LUACHECK: Define bash commands to run before running LUA_LUACHECK

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
LUA_LUACHECK_RULES_PATH string

LUA_LUACHECK: Path where to find linter configuration file

LUA_LUACHECK_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling LUA_LUACHECK and its pre/post commands

Default:
[]
LUA_POST_COMMANDS command_info[]

LUA: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
LUA_PRE_COMMANDS command_info[]

LUA: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
LUA_SELENE_ARGUMENTS array | string

LUA_SELENE: User custom arguments to add in linter CLI call

LUA_SELENE_CLI_EXECUTABLE string[]

LUA_SELENE: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "selene"
  ]
]
LUA_SELENE_CLI_LINT_MODE string

LUA_SELENE: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
LUA_SELENE_COMMAND_REMOVE_ARGUMENTS array | string

LUA_SELENE: User custom arguments to remove before calling linter

LUA_SELENE_CONFIG_FILE string

LUA_SELENE: User custom config file name if different from default

Default: "selene.toml"
LUA_SELENE_DISABLE_ERRORS boolean

LUA_SELENE: If true, LUA_SELENE doesn't make MegaLinter fail even if errors are found

Default: false
LUA_SELENE_DISABLE_ERRORS_IF_LESS_THAN number

LUA_SELENE: If the number of errors found is less than this value, LUA_SELENE doesn't make MegaLinter fail

Default: 0
LUA_SELENE_FILE_EXTENSIONS string[]

LUA_SELENE: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".lua"
]
Examples: ".py", ".myext"
LUA_SELENE_FILE_NAMES_REGEX string[]

LUA_SELENE: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
LUA_SELENE_FILTER_REGEX_EXCLUDE string

LUA_SELENE: Custom regex excluding filter: files matching this regex will NOT be linted

LUA_SELENE_FILTER_REGEX_INCLUDE string

LUA_SELENE: Custom regex including filter: only files matching this regex will be linted

LUA_SELENE_POST_COMMANDS command_info[]

LUA_SELENE: Define bash commands to run after running LUA_SELENE

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
LUA_SELENE_PRE_COMMANDS command_info[]

LUA_SELENE: Define bash commands to run before running LUA_SELENE

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
LUA_SELENE_RULES_PATH string

LUA_SELENE: Path where to find linter configuration file

LUA_SELENE_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling LUA_SELENE and its pre/post commands

Default:
[]
LUA_STYLUA_ARGUMENTS array | string

LUA_STYLUA: User custom arguments to add in linter CLI call

LUA_STYLUA_CLI_EXECUTABLE string[]

LUA_STYLUA: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "stylua"
  ]
]
LUA_STYLUA_CLI_LINT_MODE string

LUA_STYLUA: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
LUA_STYLUA_COMMAND_REMOVE_ARGUMENTS array | string

LUA_STYLUA: User custom arguments to remove before calling linter

LUA_STYLUA_CONFIG_FILE string

LUA_STYLUA: User custom config file name if different from default

Default: "stylua.toml"
LUA_STYLUA_DISABLE_ERRORS boolean

LUA_STYLUA: If true, LUA_STYLUA doesn't make MegaLinter fail even if errors are found

Default: false
LUA_STYLUA_DISABLE_ERRORS_IF_LESS_THAN number

LUA_STYLUA: If the number of errors found is less than this value, LUA_STYLUA doesn't make MegaLinter fail

Default: 0
LUA_STYLUA_FILE_EXTENSIONS string[]

LUA_STYLUA: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".lua"
]
Examples: ".py", ".myext"
LUA_STYLUA_FILE_NAMES_REGEX string[]

LUA_STYLUA: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
LUA_STYLUA_FILTER_REGEX_EXCLUDE string

LUA_STYLUA: Custom regex excluding filter: files matching this regex will NOT be linted

LUA_STYLUA_FILTER_REGEX_INCLUDE string

LUA_STYLUA: Custom regex including filter: only files matching this regex will be linted

LUA_STYLUA_POST_COMMANDS command_info[]

LUA_STYLUA: Define bash commands to run after running LUA_STYLUA

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
LUA_STYLUA_PRE_COMMANDS command_info[]

LUA_STYLUA: Define bash commands to run before running LUA_STYLUA

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
LUA_STYLUA_RULES_PATH string

LUA_STYLUA: Path where to find linter configuration file

LUA_STYLUA_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling LUA_STYLUA and its pre/post commands

Default:
[]
MAKEFILE_CHECKMAKE_ARGUMENTS array | string

MAKEFILE_CHECKMAKE: User custom arguments to add in linter CLI call

MAKEFILE_CHECKMAKE_CLI_EXECUTABLE string[]

MAKEFILE_CHECKMAKE: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "checkmake"
  ]
]
MAKEFILE_CHECKMAKE_CLI_LINT_MODE string

MAKEFILE_CHECKMAKE: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
MAKEFILE_CHECKMAKE_COMMAND_REMOVE_ARGUMENTS array | string

MAKEFILE_CHECKMAKE: User custom arguments to remove before calling linter

MAKEFILE_CHECKMAKE_CONFIG_FILE string

MAKEFILE_CHECKMAKE: User custom config file name if different from default

Default: ".checkmake.ini"
MAKEFILE_CHECKMAKE_DISABLE_ERRORS boolean

MAKEFILE_CHECKMAKE: If true, MAKEFILE_CHECKMAKE doesn't make MegaLinter fail even if errors are found

Default: false
MAKEFILE_CHECKMAKE_DISABLE_ERRORS_IF_LESS_THAN number

MAKEFILE_CHECKMAKE: If the number of errors found is less than this value, MAKEFILE_CHECKMAKE doesn't make MegaLinter fail

Default: 0
MAKEFILE_CHECKMAKE_FILE_EXTENSIONS string[]

MAKEFILE_CHECKMAKE: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[]
Examples: ".py", ".myext"
MAKEFILE_CHECKMAKE_FILE_NAMES_REGEX string[]

MAKEFILE_CHECKMAKE: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[
  "Makefile"
]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
MAKEFILE_CHECKMAKE_FILTER_REGEX_EXCLUDE string

MAKEFILE_CHECKMAKE: Custom regex excluding filter: files matching this regex will NOT be linted

MAKEFILE_CHECKMAKE_FILTER_REGEX_INCLUDE string

MAKEFILE_CHECKMAKE: Custom regex including filter: only files matching this regex will be linted

MAKEFILE_CHECKMAKE_POST_COMMANDS command_info[]

MAKEFILE_CHECKMAKE: Define bash commands to run after running MAKEFILE_CHECKMAKE

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
MAKEFILE_CHECKMAKE_PRE_COMMANDS command_info[]

MAKEFILE_CHECKMAKE: Define bash commands to run before running MAKEFILE_CHECKMAKE

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
MAKEFILE_CHECKMAKE_RULES_PATH string

MAKEFILE_CHECKMAKE: Path where to find linter configuration file

MAKEFILE_CHECKMAKE_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling MAKEFILE_CHECKMAKE and its pre/post commands

Default:
[]
MAKEFILE_FILTER_REGEX_EXCLUDE string

MAKEFILE: Custom regex excluding filter: files matching this regex will NOT be linted

MAKEFILE_FILTER_REGEX_INCLUDE string

MAKEFILE: Custom regex including filter: only files matching this regex will be linted

MAKEFILE_POST_COMMANDS command_info[]

MAKEFILE: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
MAKEFILE_PRE_COMMANDS command_info[]

MAKEFILE: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_DEFAULT_STYLE string

Style of markdown formatting to apply

Default: "markdownlint"
Values: "markdownlint" "remark-lint" "rumdl"
MARKDOWN_FILTER_REGEX_EXCLUDE string

MARKDOWN: Custom regex excluding filter: files matching this regex will NOT be linted

MARKDOWN_FILTER_REGEX_INCLUDE string

MARKDOWN: Custom regex including filter: only files matching this regex will be linted

MARKDOWN_MARKDOWNLINT_ARGUMENTS array | string

MARKDOWN_MARKDOWNLINT: User custom arguments to add in linter CLI call

MARKDOWN_MARKDOWNLINT_CLI_EXECUTABLE string[]

MARKDOWN_MARKDOWNLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "markdownlint"
  ]
]
MARKDOWN_MARKDOWNLINT_CLI_LINT_MODE string

MARKDOWN_MARKDOWNLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
MARKDOWN_MARKDOWNLINT_COMMAND_REMOVE_ARGUMENTS array | string

MARKDOWN_MARKDOWNLINT: User custom arguments to remove before calling linter

MARKDOWN_MARKDOWNLINT_CONFIG_FILE string

MARKDOWN_MARKDOWNLINT: User custom config file name if different from default

Default: ".markdownlint.json"
MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS boolean

MARKDOWN_MARKDOWNLINT: If true, MARKDOWN_MARKDOWNLINT doesn't make MegaLinter fail even if errors are found

Default: false
MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS_IF_LESS_THAN number

MARKDOWN_MARKDOWNLINT: If the number of errors found is less than this value, MARKDOWN_MARKDOWNLINT doesn't make MegaLinter fail

Default: 0
MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS string[]

MARKDOWN_MARKDOWNLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".md"
]
Examples: ".py", ".myext"
MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX string[]

MARKDOWN_MARKDOWNLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
MARKDOWN_MARKDOWNLINT_FILTER_REGEX_EXCLUDE string

MARKDOWN_MARKDOWNLINT: Custom regex excluding filter: files matching this regex will NOT be linted

MARKDOWN_MARKDOWNLINT_FILTER_REGEX_INCLUDE string

MARKDOWN_MARKDOWNLINT: Custom regex including filter: only files matching this regex will be linted

MARKDOWN_MARKDOWNLINT_POST_COMMANDS command_info[]

MARKDOWN_MARKDOWNLINT: Define bash commands to run after running MARKDOWN_MARKDOWNLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_MARKDOWNLINT_PRE_COMMANDS command_info[]

MARKDOWN_MARKDOWNLINT: Define bash commands to run before running MARKDOWN_MARKDOWNLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_MARKDOWNLINT_RULES_PATH string

MARKDOWN_MARKDOWNLINT: Path where to find linter configuration file

MARKDOWN_MARKDOWNLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling MARKDOWN_MARKDOWNLINT and its pre/post commands

Default:
[]
MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS command_info[]
Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS array | string

MARKDOWN_MARKDOWN_TABLE_FORMATTER: User custom arguments to add in linter CLI call

MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_EXECUTABLE string[]

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "markdown-table-formatter"
  ]
]
MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_LINT_MODE string

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
MARKDOWN_MARKDOWN_TABLE_FORMATTER_COMMAND_REMOVE_ARGUMENTS array | string

MARKDOWN_MARKDOWN_TABLE_FORMATTER: User custom arguments to remove before calling linter

MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS boolean

MARKDOWN_MARKDOWN_TABLE_FORMATTER: If true, MARKDOWN_MARKDOWN_TABLE_FORMATTER doesn't make MegaLinter fail even if errors are found

Default: false
MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN number

MARKDOWN_MARKDOWN_TABLE_FORMATTER: If the number of errors found is less than this value, MARKDOWN_MARKDOWN_TABLE_FORMATTER doesn't make MegaLinter fail

Default: 0
MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS string[]

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".md"
]
Examples: ".py", ".myext"
MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX string[]

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_EXCLUDE string

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Custom regex excluding filter: files matching this regex will NOT be linted

MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_INCLUDE string

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Custom regex including filter: only files matching this regex will be linted

MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS command_info[]

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Define bash commands to run after running MARKDOWN_MARKDOWN_TABLE_FORMATTER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS command_info[]

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Define bash commands to run before running MARKDOWN_MARKDOWN_TABLE_FORMATTER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_MARKDOWN_TABLE_FORMATTER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling MARKDOWN_MARKDOWN_TABLE_FORMATTER and its pre/post commands

Default:
[]
MARKDOWN_MARKDOWN_TABLE_PRETTIFY_ARGUMENTS string[]

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: User custom arguments to add in linter CLI call

MARKDOWN_MARKDOWN_TABLE_PRETTIFY_DISABLE_ERRORS boolean
Default: false
MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_EXTENSIONS string[]
MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_NAMES_REGEX string[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILTER_REGEX_EXCLUDE string
MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILTER_REGEX_INCLUDE string
MARKDOWN_POST_COMMANDS command_info[]

MARKDOWN: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_PRE_COMMANDS command_info[]

MARKDOWN: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_REMARK_LINT_ARGUMENTS array | string

MARKDOWN_REMARK_LINT: User custom arguments to add in linter CLI call

MARKDOWN_REMARK_LINT_CLI_EXECUTABLE string[]

MARKDOWN_REMARK_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "remark"
  ]
]
MARKDOWN_REMARK_LINT_CLI_LINT_MODE string

MARKDOWN_REMARK_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
MARKDOWN_REMARK_LINT_COMMAND_REMOVE_ARGUMENTS array | string

MARKDOWN_REMARK_LINT: User custom arguments to remove before calling linter

MARKDOWN_REMARK_LINT_CONFIG_FILE string

MARKDOWN_REMARK_LINT: User custom config file name if different from default

Default: ".remarkrc"
MARKDOWN_REMARK_LINT_DISABLE_ERRORS boolean

MARKDOWN_REMARK_LINT: If true, MARKDOWN_REMARK_LINT doesn't make MegaLinter fail even if errors are found

Default: false
MARKDOWN_REMARK_LINT_DISABLE_ERRORS_IF_LESS_THAN number

MARKDOWN_REMARK_LINT: If the number of errors found is less than this value, MARKDOWN_REMARK_LINT doesn't make MegaLinter fail

Default: 0
MARKDOWN_REMARK_LINT_FILE_EXTENSIONS string[]

MARKDOWN_REMARK_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".md"
]
Examples: ".py", ".myext"
MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX string[]

MARKDOWN_REMARK_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
MARKDOWN_REMARK_LINT_FILTER_REGEX_EXCLUDE string

MARKDOWN_REMARK_LINT: Custom regex excluding filter: files matching this regex will NOT be linted

MARKDOWN_REMARK_LINT_FILTER_REGEX_INCLUDE string

MARKDOWN_REMARK_LINT: Custom regex including filter: only files matching this regex will be linted

MARKDOWN_REMARK_LINT_POST_COMMANDS command_info[]

MARKDOWN_REMARK_LINT: Define bash commands to run after running MARKDOWN_REMARK_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_REMARK_LINT_PRE_COMMANDS command_info[]

MARKDOWN_REMARK_LINT: Define bash commands to run before running MARKDOWN_REMARK_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_REMARK_LINT_RULES_PATH string

MARKDOWN_REMARK_LINT: Path where to find linter configuration file

MARKDOWN_REMARK_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling MARKDOWN_REMARK_LINT and its pre/post commands

Default:
[]
MARKDOWN_RUMDL_ARGUMENTS array | string

MARKDOWN_RUMDL: User custom arguments to add in linter CLI call

MARKDOWN_RUMDL_CLI_EXECUTABLE string[]

MARKDOWN_RUMDL: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "rumdl"
  ]
]
MARKDOWN_RUMDL_CLI_LINT_MODE string

MARKDOWN_RUMDL: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
MARKDOWN_RUMDL_COMMAND_REMOVE_ARGUMENTS array | string

MARKDOWN_RUMDL: User custom arguments to remove before calling linter

MARKDOWN_RUMDL_CONFIG_FILE string

MARKDOWN_RUMDL: User custom config file name if different from default

Default: ".rumdl.toml"
MARKDOWN_RUMDL_DISABLE_ERRORS boolean

MARKDOWN_RUMDL: If true, MARKDOWN_RUMDL doesn't make MegaLinter fail even if errors are found

Default: false
MARKDOWN_RUMDL_DISABLE_ERRORS_IF_LESS_THAN number

MARKDOWN_RUMDL: If the number of errors found is less than this value, MARKDOWN_RUMDL doesn't make MegaLinter fail

Default: 0
MARKDOWN_RUMDL_FILE_EXTENSIONS string[]

MARKDOWN_RUMDL: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".md"
]
Examples: ".py", ".myext"
MARKDOWN_RUMDL_FILE_NAMES_REGEX string[]

MARKDOWN_RUMDL: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
MARKDOWN_RUMDL_FILTER_REGEX_EXCLUDE string

MARKDOWN_RUMDL: Custom regex excluding filter: files matching this regex will NOT be linted

MARKDOWN_RUMDL_FILTER_REGEX_INCLUDE string

MARKDOWN_RUMDL: Custom regex including filter: only files matching this regex will be linted

MARKDOWN_RUMDL_POST_COMMANDS command_info[]

MARKDOWN_RUMDL: Define bash commands to run after running MARKDOWN_RUMDL

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_RUMDL_PRE_COMMANDS command_info[]

MARKDOWN_RUMDL: Define bash commands to run before running MARKDOWN_RUMDL

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
MARKDOWN_RUMDL_RULES_PATH string

MARKDOWN_RUMDL: Path where to find linter configuration file

MARKDOWN_RUMDL_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling MARKDOWN_RUMDL and its pre/post commands

Default:
[]
MARKDOWN_SUMMARY_REPORTER boolean

Generate SUMMARY reports that can be used to display issues directly in PR comment

Default: false
MARKDOWN_SUMMARY_REPORTER_FILE_NAME string

Override SUMMARY output file name

Default: "megalinter-summary.log"
MULTI_STATUS boolean

(DEPRECATED, use GITHUB_STATUS_REPORTER) Posts a status on the pull request for each processed linter

Default: true
OLLAMA_BASE_URL string

Base URL to connect to Ollama server

Default: "http://localhost:11434"
OUTPUT_DETAIL string

(DEPRECATED) Output detail for text reporter: only error files (simple) or all files (detailed)

Values: "simple" "detailed"
OUTPUT_FORMAT string

(DEPRECATED) Output format: text or tap

Values: "text" "tap"
PARALLEL boolean

Process linters in parallel to improve overall MegaLinter performance. If true, linters of same language or formats are grouped in the same parallel process to avoid lock issues if fixing the same files

Default: true
PARALLEL_PROCESS_NUMBER number

All available cores are used by default. If there are too many, you need to decrease the number of used cores in order to enhance performances

Examples: 4
PERL_FILTER_REGEX_EXCLUDE string

PERL: Custom regex excluding filter: files matching this regex will NOT be linted

PERL_FILTER_REGEX_INCLUDE string

PERL: Custom regex including filter: only files matching this regex will be linted

PERL_PERLCRITIC_ARGUMENTS array | string

PERL_PERLCRITIC: User custom arguments to add in linter CLI call

PERL_PERLCRITIC_CLI_EXECUTABLE string[]

PERL_PERLCRITIC: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "perlcritic"
  ]
]
PERL_PERLCRITIC_CLI_LINT_MODE string

PERL_PERLCRITIC: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
PERL_PERLCRITIC_COMMAND_REMOVE_ARGUMENTS array | string

PERL_PERLCRITIC: User custom arguments to remove before calling linter

PERL_PERLCRITIC_DISABLE_ERRORS boolean

PERL_PERLCRITIC: If true, PERL_PERLCRITIC doesn't make MegaLinter fail even if errors are found

Default: false
PERL_PERLCRITIC_DISABLE_ERRORS_IF_LESS_THAN number

PERL_PERLCRITIC: If the number of errors found is less than this value, PERL_PERLCRITIC doesn't make MegaLinter fail

Default: 0
PERL_PERLCRITIC_FILE_EXTENSIONS string[]

PERL_PERLCRITIC: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".pl",
  ".pm",
  ".t",
  ""
]
Examples: ".py", ".myext"
PERL_PERLCRITIC_FILE_NAMES_REGEX string[]

PERL_PERLCRITIC: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PERL_PERLCRITIC_FILTER_REGEX_EXCLUDE string

PERL_PERLCRITIC: Custom regex excluding filter: files matching this regex will NOT be linted

PERL_PERLCRITIC_FILTER_REGEX_INCLUDE string

PERL_PERLCRITIC: Custom regex including filter: only files matching this regex will be linted

PERL_PERLCRITIC_POST_COMMANDS command_info[]

PERL_PERLCRITIC: Define bash commands to run after running PERL_PERLCRITIC

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PERL_PERLCRITIC_PRE_COMMANDS command_info[]

PERL_PERLCRITIC: Define bash commands to run before running PERL_PERLCRITIC

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PERL_PERLCRITIC_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PERL_PERLCRITIC and its pre/post commands

Default:
[]
PERL_POST_COMMANDS command_info[]

PERL: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PERL_PRE_COMMANDS command_info[]

PERL: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
PHP_BUILTIN_ARGUMENTS array | string

PHP_BUILTIN: User custom arguments to add in linter CLI call

PHP_BUILTIN_CLI_EXECUTABLE string
PHP_BUILTIN_CLI_LINT_MODE string
Default: "file"
Values: "file" "list_of_files" "project"
PHP_BUILTIN_DISABLE_ERRORS boolean
Default: false
PHP_BUILTIN_DISABLE_ERRORS_IF_LESS_THAN number
Default: 0
PHP_BUILTIN_FILE_EXTENSIONS string[]
PHP_BUILTIN_FILE_NAMES_REGEX string[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PHP_BUILTIN_FILTER_REGEX_EXCLUDE string
PHP_BUILTIN_FILTER_REGEX_INCLUDE string
PHP_BUILTIN_POST_COMMANDS command_info[]
Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PHP_BUILTIN_PRE_COMMANDS command_info[]
Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PHP_FILTER_REGEX_EXCLUDE string

PHP: Custom regex excluding filter: files matching this regex will NOT be linted

PHP_FILTER_REGEX_INCLUDE string

PHP: Custom regex including filter: only files matching this regex will be linted

PHP_PHPCSFIXER_ARGUMENTS array | string

PHP_PHPCSFIXER: User custom arguments to add in linter CLI call

PHP_PHPCSFIXER_CLI_EXECUTABLE string[]

PHP_PHPCSFIXER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "php-cs-fixer"
  ]
]
PHP_PHPCSFIXER_CLI_LINT_MODE string

PHP_PHPCSFIXER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
PHP_PHPCSFIXER_COMMAND_REMOVE_ARGUMENTS array | string

PHP_PHPCSFIXER: User custom arguments to remove before calling linter

PHP_PHPCSFIXER_CONFIG_FILE string

PHP_PHPCSFIXER: User custom config file name if different from default

Default: ".php-cs-fixer.dist.php"
PHP_PHPCSFIXER_DISABLE_ERRORS boolean

PHP_PHPCSFIXER: If true, PHP_PHPCSFIXER doesn't make MegaLinter fail even if errors are found

Default: false
PHP_PHPCSFIXER_DISABLE_ERRORS_IF_LESS_THAN number

PHP_PHPCSFIXER: If the number of errors found is less than this value, PHP_PHPCSFIXER doesn't make MegaLinter fail

Default: 0
PHP_PHPCSFIXER_FILE_EXTENSIONS string[]

PHP_PHPCSFIXER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".php"
]
Examples: ".py", ".myext"
PHP_PHPCSFIXER_FILE_NAMES_REGEX string[]

PHP_PHPCSFIXER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PHP_PHPCSFIXER_POST_COMMANDS command_info[]

PHP_PHPCSFIXER: Define bash commands to run after running PHP_PHPCSFIXER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PHP_PHPCSFIXER_PRE_COMMANDS command_info[]

PHP_PHPCSFIXER: Define bash commands to run before running PHP_PHPCSFIXER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PHP_PHPCSFIXER_RULES_PATH string

PHP_PHPCSFIXER: Path where to find linter configuration file

PHP_PHPCSFIXER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PHP_PHPCSFIXER and its pre/post commands

Default:
[]
PHP_PHPCS_ARGUMENTS array | string

PHP_PHPCS: User custom arguments to add in linter CLI call

PHP_PHPCS_CLI_EXECUTABLE string[]

PHP_PHPCS: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "phpcs"
  ]
]
PHP_PHPCS_CLI_LINT_MODE string

PHP_PHPCS: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PHP_PHPCS_COMMAND_REMOVE_ARGUMENTS array | string

PHP_PHPCS: User custom arguments to remove before calling linter

PHP_PHPCS_CONFIG_FILE string

PHP_PHPCS: User custom config file name if different from default

Default: "phpcs.xml"
PHP_PHPCS_DISABLE_ERRORS boolean

PHP_PHPCS: If true, PHP_PHPCS doesn't make MegaLinter fail even if errors are found

Default: false
PHP_PHPCS_DISABLE_ERRORS_IF_LESS_THAN number

PHP_PHPCS: If the number of errors found is less than this value, PHP_PHPCS doesn't make MegaLinter fail

Default: 0
PHP_PHPCS_FILE_EXTENSIONS string[]

PHP_PHPCS: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".php"
]
Examples: ".py", ".myext"
PHP_PHPCS_FILE_NAMES_REGEX string[]

PHP_PHPCS: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PHP_PHPCS_FILTER_REGEX_EXCLUDE string

PHP_PHPCS: Custom regex excluding filter: files matching this regex will NOT be linted

PHP_PHPCS_FILTER_REGEX_INCLUDE string

PHP_PHPCS: Custom regex including filter: only files matching this regex will be linted

PHP_PHPCS_POST_COMMANDS command_info[]

PHP_PHPCS: Define bash commands to run after running PHP_PHPCS

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PHP_PHPCS_PRE_COMMANDS command_info[]

PHP_PHPCS: Define bash commands to run before running PHP_PHPCS

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PHP_PHPCS_RULES_PATH string

PHP_PHPCS: Path where to find linter configuration file

PHP_PHPCS_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PHP_PHPCS and its pre/post commands

Default:
[]
PHP_PHPLINT_ARGUMENTS array | string

PHP_PHPLINT: User custom arguments to add in linter CLI call

PHP_PHPLINT_CLI_EXECUTABLE string[]

PHP_PHPLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "phplint"
  ]
]
PHP_PHPLINT_CLI_LINT_MODE string

PHP_PHPLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PHP_PHPLINT_COMMAND_REMOVE_ARGUMENTS array | string

PHP_PHPLINT: User custom arguments to remove before calling linter

PHP_PHPLINT_CONFIG_FILE string

PHP_PHPLINT: User custom config file name if different from default

Default: ".phplint.yml"
PHP_PHPLINT_DISABLE_ERRORS boolean

PHP_PHPLINT: If true, PHP_PHPLINT doesn't make MegaLinter fail even if errors are found

Default: false
PHP_PHPLINT_DISABLE_ERRORS_IF_LESS_THAN number

PHP_PHPLINT: If the number of errors found is less than this value, PHP_PHPLINT doesn't make MegaLinter fail

Default: 0
PHP_PHPLINT_FILE_EXTENSIONS string[]

PHP_PHPLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".php"
]
Examples: ".py", ".myext"
PHP_PHPLINT_FILE_NAMES_REGEX string[]

PHP_PHPLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PHP_PHPLINT_FILTER_REGEX_EXCLUDE string

PHP_PHPLINT: Custom regex excluding filter: files matching this regex will NOT be linted

PHP_PHPLINT_FILTER_REGEX_INCLUDE string

PHP_PHPLINT: Custom regex including filter: only files matching this regex will be linted

PHP_PHPLINT_POST_COMMANDS command_info[]

PHP_PHPLINT: Define bash commands to run after running PHP_PHPLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PHP_PHPLINT_PRE_COMMANDS command_info[]

PHP_PHPLINT: Define bash commands to run before running PHP_PHPLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PHP_PHPLINT_RULES_PATH string

PHP_PHPLINT: Path where to find linter configuration file

PHP_PHPLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PHP_PHPLINT and its pre/post commands

Default:
[]
PHP_PHPSTAN_ARGUMENTS array | string

PHP_PHPSTAN: User custom arguments to add in linter CLI call

PHP_PHPSTAN_CLI_EXECUTABLE string[]

PHP_PHPSTAN: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "phpstan"
  ]
]
PHP_PHPSTAN_CLI_LINT_MODE string

PHP_PHPSTAN: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PHP_PHPSTAN_COMMAND_REMOVE_ARGUMENTS array | string

PHP_PHPSTAN: User custom arguments to remove before calling linter

PHP_PHPSTAN_CONFIG_FILE string

PHP_PHPSTAN: User custom config file name if different from default

Default: "phpstan.neon.dist"
PHP_PHPSTAN_DISABLE_ERRORS boolean

PHP_PHPSTAN: If true, PHP_PHPSTAN doesn't make MegaLinter fail even if errors are found

Default: false
PHP_PHPSTAN_DISABLE_ERRORS_IF_LESS_THAN number

PHP_PHPSTAN: If the number of errors found is less than this value, PHP_PHPSTAN doesn't make MegaLinter fail

Default: 0
PHP_PHPSTAN_FILE_EXTENSIONS string[]

PHP_PHPSTAN: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".php"
]
Examples: ".py", ".myext"
PHP_PHPSTAN_FILE_NAMES_REGEX string[]

PHP_PHPSTAN: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PHP_PHPSTAN_FILTER_REGEX_EXCLUDE string

PHP_PHPSTAN: Custom regex excluding filter: files matching this regex will NOT be linted

PHP_PHPSTAN_FILTER_REGEX_INCLUDE string

PHP_PHPSTAN: Custom regex including filter: only files matching this regex will be linted

PHP_PHPSTAN_POST_COMMANDS command_info[]

PHP_PHPSTAN: Define bash commands to run after running PHP_PHPSTAN

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PHP_PHPSTAN_PRE_COMMANDS command_info[]

PHP_PHPSTAN: Define bash commands to run before running PHP_PHPSTAN

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PHP_PHPSTAN_RULES_PATH string

PHP_PHPSTAN: Path where to find linter configuration file

PHP_PHPSTAN_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PHP_PHPSTAN and its pre/post commands

Default:
[]
PHP_POST_COMMANDS command_info[]

PHP: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PHP_PRE_COMMANDS command_info[]

PHP: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
PHP_PSALM_ARGUMENTS array | string

PHP_PSALM: User custom arguments to add in linter CLI call

PHP_PSALM_CLI_EXECUTABLE string[]

PHP_PSALM: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "psalm"
  ]
]
PHP_PSALM_CLI_LINT_MODE string

PHP_PSALM: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PHP_PSALM_COMMAND_REMOVE_ARGUMENTS array | string

PHP_PSALM: User custom arguments to remove before calling linter

PHP_PSALM_CONFIG_FILE string

PHP_PSALM: User custom config file name if different from default

Default: "psalm.xml"
PHP_PSALM_DISABLE_ERRORS boolean

PHP_PSALM: If true, PHP_PSALM doesn't make MegaLinter fail even if errors are found

Default: false
PHP_PSALM_DISABLE_ERRORS_IF_LESS_THAN number

PHP_PSALM: If the number of errors found is less than this value, PHP_PSALM doesn't make MegaLinter fail

Default: 0
PHP_PSALM_FILE_EXTENSIONS string[]

PHP_PSALM: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".php"
]
Examples: ".py", ".myext"
PHP_PSALM_FILE_NAMES_REGEX string[]

PHP_PSALM: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PHP_PSALM_FILTER_REGEX_EXCLUDE string

PHP_PSALM: Custom regex excluding filter: files matching this regex will NOT be linted

PHP_PSALM_FILTER_REGEX_INCLUDE string

PHP_PSALM: Custom regex including filter: only files matching this regex will be linted

PHP_PSALM_POST_COMMANDS command_info[]

PHP_PSALM: Define bash commands to run after running PHP_PSALM

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PHP_PSALM_PRE_COMMANDS command_info[]

PHP_PSALM: Define bash commands to run before running PHP_PSALM

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PHP_PSALM_RULES_PATH string

PHP_PSALM: Path where to find linter configuration file

PHP_PSALM_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PHP_PSALM and its pre/post commands

Default:
[]
PLUGINS string[]

List of MegaLinter plugins. URL must follow format https://**/mega-linter-plugin-**/**.mega-linter-descriptor.yml

Examples: ["https://raw.githubusercontent.com/cookiejar/megalinter-plugin-cookiejar/master/cookietemplate.mega-linter-descriptor.yml"]
POST_COMMANDS command_info[]

Custom bash commands to run after linters

Default:
[]
Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
POST_GITHUB_COMMENT boolean

(DEPRECATED, use GITHUB_COMMENT_REPORTER) Posts MegaLinter results summary in the comments of the related pull request (if existing)

Default: true
POST_GITLAB_COMMENT boolean

(DEPRECATED, use GITHUB_COMMENT_REPORTER) Posts MegaLinter results summary in the comments of the related merge request (if existing)

Default: true
POWERSHELL_FILTER_REGEX_EXCLUDE string

POWERSHELL: Custom regex excluding filter: files matching this regex will NOT be linted

POWERSHELL_FILTER_REGEX_INCLUDE string

POWERSHELL: Custom regex including filter: only files matching this regex will be linted

POWERSHELL_POST_COMMANDS command_info[]

POWERSHELL: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
POWERSHELL_POWERSHELL_ARGUMENTS array | string

POWERSHELL_POWERSHELL: User custom arguments to add in linter CLI call

POWERSHELL_POWERSHELL_CLI_EXECUTABLE string[]

POWERSHELL_POWERSHELL: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "pwsh"
  ]
]
POWERSHELL_POWERSHELL_CLI_LINT_MODE string

POWERSHELL_POWERSHELL: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
POWERSHELL_POWERSHELL_COMMAND_REMOVE_ARGUMENTS array | string

POWERSHELL_POWERSHELL: User custom arguments to remove before calling linter

POWERSHELL_POWERSHELL_CONFIG_FILE string

POWERSHELL_POWERSHELL: User custom config file name if different from default

Default: ".powershell-psscriptanalyzer.psd1"
POWERSHELL_POWERSHELL_DISABLE_ERRORS boolean

POWERSHELL_POWERSHELL: If true, POWERSHELL_POWERSHELL doesn't make MegaLinter fail even if errors are found

Default: false
POWERSHELL_POWERSHELL_DISABLE_ERRORS_IF_LESS_THAN number

POWERSHELL_POWERSHELL: If the number of errors found is less than this value, POWERSHELL_POWERSHELL doesn't make MegaLinter fail

Default: 0
POWERSHELL_POWERSHELL_FILE_EXTENSIONS string[]

POWERSHELL_POWERSHELL: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".ps1",
  ".psm1",
  ".psd1",
  ".ps1xml",
  ".pssc",
  ".psrc",
  ".cdxml"
]
Examples: ".py", ".myext"
POWERSHELL_POWERSHELL_FILE_NAMES_REGEX string[]

POWERSHELL_POWERSHELL: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
POWERSHELL_POWERSHELL_FILTER_REGEX_EXCLUDE string

POWERSHELL_POWERSHELL: Custom regex excluding filter: files matching this regex will NOT be linted

POWERSHELL_POWERSHELL_FILTER_REGEX_INCLUDE string

POWERSHELL_POWERSHELL: Custom regex including filter: only files matching this regex will be linted

POWERSHELL_POWERSHELL_FORMATTER_ARGUMENTS array | string

POWERSHELL_POWERSHELL_FORMATTER: User custom arguments to add in linter CLI call

POWERSHELL_POWERSHELL_FORMATTER_CLI_EXECUTABLE string[]

POWERSHELL_POWERSHELL_FORMATTER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "pwsh"
  ]
]
POWERSHELL_POWERSHELL_FORMATTER_CLI_LINT_MODE string

POWERSHELL_POWERSHELL_FORMATTER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
POWERSHELL_POWERSHELL_FORMATTER_COMMAND_REMOVE_ARGUMENTS array | string

POWERSHELL_POWERSHELL_FORMATTER: User custom arguments to remove before calling linter

POWERSHELL_POWERSHELL_FORMATTER_CONFIG_FILE string

POWERSHELL_POWERSHELL_FORMATTER: User custom config file name if different from default

Default: ".powershell-formatter.psd1"
POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS boolean

POWERSHELL_POWERSHELL_FORMATTER: If true, POWERSHELL_POWERSHELL_FORMATTER doesn't make MegaLinter fail even if errors are found

Default: false
POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN number

POWERSHELL_POWERSHELL_FORMATTER: If the number of errors found is less than this value, POWERSHELL_POWERSHELL_FORMATTER doesn't make MegaLinter fail

Default: 0
POWERSHELL_POWERSHELL_FORMATTER_FILE_EXTENSIONS string[]

POWERSHELL_POWERSHELL_FORMATTER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".ps1",
  ".psm1",
  ".psd1",
  ".ps1xml",
  ".pssc",
  ".psrc",
  ".cdxml"
]
Examples: ".py", ".myext"
POWERSHELL_POWERSHELL_FORMATTER_FILE_NAMES_REGEX string[]

POWERSHELL_POWERSHELL_FORMATTER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
POWERSHELL_POWERSHELL_FORMATTER_FILTER_REGEX_EXCLUDE string

POWERSHELL_POWERSHELL_FORMATTER: Custom regex excluding filter: files matching this regex will NOT be linted

POWERSHELL_POWERSHELL_FORMATTER_FILTER_REGEX_INCLUDE string

POWERSHELL_POWERSHELL_FORMATTER: Custom regex including filter: only files matching this regex will be linted

POWERSHELL_POWERSHELL_FORMATTER_OUTPUT_ENCODING string

POWERSHELL_POWERSHELL_FORMATTER: -Encoding to be used when writing content to the file

Default: "utf8"
POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS command_info[]

POWERSHELL_POWERSHELL_FORMATTER: Define bash commands to run after running POWERSHELL_POWERSHELL_FORMATTER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS command_info[]

POWERSHELL_POWERSHELL_FORMATTER: Define bash commands to run before running POWERSHELL_POWERSHELL_FORMATTER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
POWERSHELL_POWERSHELL_FORMATTER_RULES_PATH string

POWERSHELL_POWERSHELL_FORMATTER: Path where to find linter configuration file

POWERSHELL_POWERSHELL_FORMATTER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling POWERSHELL_POWERSHELL_FORMATTER and its pre/post commands

Default:
[]
POWERSHELL_POWERSHELL_POST_COMMANDS command_info[]

POWERSHELL_POWERSHELL: Define bash commands to run after running POWERSHELL_POWERSHELL

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
POWERSHELL_POWERSHELL_PRE_COMMANDS command_info[]

POWERSHELL_POWERSHELL: Define bash commands to run before running POWERSHELL_POWERSHELL

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
POWERSHELL_POWERSHELL_RULES_PATH string

POWERSHELL_POWERSHELL: Path where to find linter configuration file

POWERSHELL_POWERSHELL_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling POWERSHELL_POWERSHELL and its pre/post commands

Default:
[]
POWERSHELL_PRE_COMMANDS command_info[]

POWERSHELL: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
PRE_COMMANDS command_info[]

Custom bash commands to run before linters

Default:
[]
Examples: [{"command":"npm install java-caller","continue_if_failed":false,"cwd":"root"},{"command":"echo \"pre-run command has been called\"","cwd":"workspace"}]
PRINT_ALL_FILES boolean

If set to false, only fixed and error files are displayed in logs

Default: true
PRINT_ALPACA boolean

Enable printing alpaca image to console output

Default: true
PROTOBUF_FILTER_REGEX_EXCLUDE string

PROTOBUF: Custom regex excluding filter: files matching this regex will NOT be linted

PROTOBUF_FILTER_REGEX_INCLUDE string

PROTOBUF: Custom regex including filter: only files matching this regex will be linted

PROTOBUF_POST_COMMANDS command_info[]

PROTOBUF: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PROTOBUF_PRE_COMMANDS command_info[]

PROTOBUF: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
PROTOBUF_PROTOLINT_ARGUMENTS array | string

PROTOBUF_PROTOLINT: User custom arguments to add in linter CLI call

PROTOBUF_PROTOLINT_CLI_EXECUTABLE string[]

PROTOBUF_PROTOLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "protolint"
  ]
]
PROTOBUF_PROTOLINT_CLI_LINT_MODE string

PROTOBUF_PROTOLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
PROTOBUF_PROTOLINT_COMMAND_REMOVE_ARGUMENTS array | string

PROTOBUF_PROTOLINT: User custom arguments to remove before calling linter

PROTOBUF_PROTOLINT_CONFIG_FILE string

PROTOBUF_PROTOLINT: User custom config file name if different from default

Default: ".protolintrc.yml"
PROTOBUF_PROTOLINT_DISABLE_ERRORS boolean

PROTOBUF_PROTOLINT: If true, PROTOBUF_PROTOLINT doesn't make MegaLinter fail even if errors are found

Default: false
PROTOBUF_PROTOLINT_DISABLE_ERRORS_IF_LESS_THAN number

PROTOBUF_PROTOLINT: If the number of errors found is less than this value, PROTOBUF_PROTOLINT doesn't make MegaLinter fail

Default: 0
PROTOBUF_PROTOLINT_FILE_EXTENSIONS string[]

PROTOBUF_PROTOLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".proto"
]
Examples: ".py", ".myext"
PROTOBUF_PROTOLINT_FILE_NAMES_REGEX string[]

PROTOBUF_PROTOLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PROTOBUF_PROTOLINT_FILTER_REGEX_EXCLUDE string

PROTOBUF_PROTOLINT: Custom regex excluding filter: files matching this regex will NOT be linted

PROTOBUF_PROTOLINT_FILTER_REGEX_INCLUDE string

PROTOBUF_PROTOLINT: Custom regex including filter: only files matching this regex will be linted

PROTOBUF_PROTOLINT_POST_COMMANDS command_info[]

PROTOBUF_PROTOLINT: Define bash commands to run after running PROTOBUF_PROTOLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PROTOBUF_PROTOLINT_PRE_COMMANDS command_info[]

PROTOBUF_PROTOLINT: Define bash commands to run before running PROTOBUF_PROTOLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PROTOBUF_PROTOLINT_RULES_PATH string

PROTOBUF_PROTOLINT: Path where to find linter configuration file

PROTOBUF_PROTOLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PROTOBUF_PROTOLINT and its pre/post commands

Default:
[]
PUPPET_FILTER_REGEX_EXCLUDE string

PUPPET: Custom regex excluding filter: files matching this regex will NOT be linted

PUPPET_FILTER_REGEX_INCLUDE string

PUPPET: Custom regex including filter: only files matching this regex will be linted

PUPPET_POST_COMMANDS command_info[]

PUPPET: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PUPPET_PRE_COMMANDS command_info[]

PUPPET: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
PUPPET_PUPPET_LINT_ARGUMENTS array | string

PUPPET_PUPPET_LINT: User custom arguments to add in linter CLI call

PUPPET_PUPPET_LINT_CLI_EXECUTABLE string[]

PUPPET_PUPPET_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "puppet-lint"
  ]
]
PUPPET_PUPPET_LINT_CLI_LINT_MODE string

PUPPET_PUPPET_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
PUPPET_PUPPET_LINT_COMMAND_REMOVE_ARGUMENTS array | string

PUPPET_PUPPET_LINT: User custom arguments to remove before calling linter

PUPPET_PUPPET_LINT_CONFIG_FILE string

PUPPET_PUPPET_LINT: User custom config file name if different from default

Default: ".puppet-lint.rc"
PUPPET_PUPPET_LINT_DISABLE_ERRORS boolean

PUPPET_PUPPET_LINT: If true, PUPPET_PUPPET_LINT doesn't make MegaLinter fail even if errors are found

Default: false
PUPPET_PUPPET_LINT_DISABLE_ERRORS_IF_LESS_THAN number

PUPPET_PUPPET_LINT: If the number of errors found is less than this value, PUPPET_PUPPET_LINT doesn't make MegaLinter fail

Default: 0
PUPPET_PUPPET_LINT_FILE_EXTENSIONS string[]

PUPPET_PUPPET_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".pp"
]
Examples: ".py", ".myext"
PUPPET_PUPPET_LINT_FILE_NAMES_REGEX string[]

PUPPET_PUPPET_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PUPPET_PUPPET_LINT_FILTER_REGEX_EXCLUDE string

PUPPET_PUPPET_LINT: Custom regex excluding filter: files matching this regex will NOT be linted

PUPPET_PUPPET_LINT_FILTER_REGEX_INCLUDE string

PUPPET_PUPPET_LINT: Custom regex including filter: only files matching this regex will be linted

PUPPET_PUPPET_LINT_POST_COMMANDS command_info[]

PUPPET_PUPPET_LINT: Define bash commands to run after running PUPPET_PUPPET_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PUPPET_PUPPET_LINT_PRE_COMMANDS command_info[]

PUPPET_PUPPET_LINT: Define bash commands to run before running PUPPET_PUPPET_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PUPPET_PUPPET_LINT_RULES_PATH string

PUPPET_PUPPET_LINT: Path where to find linter configuration file

PUPPET_PUPPET_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PUPPET_PUPPET_LINT and its pre/post commands

Default:
[]
PYTHON_BANDIT_ARGUMENTS array | string

PYTHON_BANDIT: User custom arguments to add in linter CLI call

PYTHON_BANDIT_CLI_EXECUTABLE string[]

PYTHON_BANDIT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "bandit"
  ]
]
PYTHON_BANDIT_CLI_LINT_MODE string

PYTHON_BANDIT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PYTHON_BANDIT_COMMAND_REMOVE_ARGUMENTS array | string

PYTHON_BANDIT: User custom arguments to remove before calling linter

PYTHON_BANDIT_CONFIG_FILE string

PYTHON_BANDIT: User custom config file name if different from default

Default: ".bandit.yml"
PYTHON_BANDIT_DISABLE_ERRORS boolean

PYTHON_BANDIT: If true, PYTHON_BANDIT doesn't make MegaLinter fail even if errors are found

Default: false
PYTHON_BANDIT_DISABLE_ERRORS_IF_LESS_THAN number

PYTHON_BANDIT: If the number of errors found is less than this value, PYTHON_BANDIT doesn't make MegaLinter fail

Default: 0
PYTHON_BANDIT_FILE_EXTENSIONS string[]

PYTHON_BANDIT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".py",
  ".pyi",
  ".ipynb"
]
Examples: ".py", ".myext"
PYTHON_BANDIT_FILE_NAMES_REGEX string[]

PYTHON_BANDIT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PYTHON_BANDIT_FILTER_REGEX_EXCLUDE string

PYTHON_BANDIT: Custom regex excluding filter: files matching this regex will NOT be linted

PYTHON_BANDIT_FILTER_REGEX_INCLUDE string

PYTHON_BANDIT: Custom regex including filter: only files matching this regex will be linted

PYTHON_BANDIT_POST_COMMANDS command_info[]

PYTHON_BANDIT: Define bash commands to run after running PYTHON_BANDIT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_BANDIT_PRE_COMMANDS command_info[]

PYTHON_BANDIT: Define bash commands to run before running PYTHON_BANDIT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_BANDIT_RULES_PATH string

PYTHON_BANDIT: Path where to find linter configuration file

PYTHON_BANDIT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PYTHON_BANDIT and its pre/post commands

Default:
[]
PYTHON_BLACK_ARGUMENTS array | string

PYTHON_BLACK: User custom arguments to add in linter CLI call

PYTHON_BLACK_CLI_EXECUTABLE string[]

PYTHON_BLACK: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "black"
  ]
]
PYTHON_BLACK_CLI_LINT_MODE string

PYTHON_BLACK: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PYTHON_BLACK_COMMAND_REMOVE_ARGUMENTS array | string

PYTHON_BLACK: User custom arguments to remove before calling linter

PYTHON_BLACK_CONFIG_FILE string

PYTHON_BLACK: User custom config file name if different from default

Default: "pyproject.toml"
PYTHON_BLACK_DISABLE_ERRORS boolean

PYTHON_BLACK: If true, PYTHON_BLACK doesn't make MegaLinter fail even if errors are found

Default: false
PYTHON_BLACK_DISABLE_ERRORS_IF_LESS_THAN number

PYTHON_BLACK: If the number of errors found is less than this value, PYTHON_BLACK doesn't make MegaLinter fail

Default: 0
PYTHON_BLACK_FILE_EXTENSIONS string[]

PYTHON_BLACK: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".py",
  ".pyi",
  ".ipynb"
]
Examples: ".py", ".myext"
PYTHON_BLACK_FILE_NAMES_REGEX string[]

PYTHON_BLACK: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PYTHON_BLACK_FILTER_REGEX_EXCLUDE string

PYTHON_BLACK: Custom regex excluding filter: files matching this regex will NOT be linted

PYTHON_BLACK_FILTER_REGEX_INCLUDE string

PYTHON_BLACK: Custom regex including filter: only files matching this regex will be linted

PYTHON_BLACK_POST_COMMANDS command_info[]

PYTHON_BLACK: Define bash commands to run after running PYTHON_BLACK

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_BLACK_PRE_COMMANDS command_info[]

PYTHON_BLACK: Define bash commands to run before running PYTHON_BLACK

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_BLACK_RULES_PATH string

PYTHON_BLACK: Path where to find linter configuration file

PYTHON_BLACK_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PYTHON_BLACK and its pre/post commands

Default:
[]
PYTHON_DEFAULT_STYLE string

Style of python formatting to apply

Default: "black"
Values: "black" "ruff"
Examples: "black", "ruff"
PYTHON_FILTER_REGEX_EXCLUDE string

PYTHON: Custom regex excluding filter: files matching this regex will NOT be linted

PYTHON_FILTER_REGEX_INCLUDE string

PYTHON: Custom regex including filter: only files matching this regex will be linted

PYTHON_FLAKE8_ARGUMENTS array | string

PYTHON_FLAKE8: User custom arguments to add in linter CLI call

PYTHON_FLAKE8_CLI_EXECUTABLE string[]

PYTHON_FLAKE8: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "flake8"
  ]
]
PYTHON_FLAKE8_CLI_LINT_MODE string

PYTHON_FLAKE8: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PYTHON_FLAKE8_COMMAND_REMOVE_ARGUMENTS array | string

PYTHON_FLAKE8: User custom arguments to remove before calling linter

PYTHON_FLAKE8_CONFIG_FILE string

PYTHON_FLAKE8: User custom config file name if different from default

Default: ".flake8"
PYTHON_FLAKE8_DISABLE_ERRORS boolean

PYTHON_FLAKE8: If true, PYTHON_FLAKE8 doesn't make MegaLinter fail even if errors are found

Default: false
PYTHON_FLAKE8_DISABLE_ERRORS_IF_LESS_THAN number

PYTHON_FLAKE8: If the number of errors found is less than this value, PYTHON_FLAKE8 doesn't make MegaLinter fail

Default: 0
PYTHON_FLAKE8_FILE_EXTENSIONS string[]

PYTHON_FLAKE8: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".py"
]
Examples: ".py", ".myext"
PYTHON_FLAKE8_FILE_NAMES_REGEX string[]

PYTHON_FLAKE8: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PYTHON_FLAKE8_FILTER_REGEX_EXCLUDE string

PYTHON_FLAKE8: Custom regex excluding filter: files matching this regex will NOT be linted

PYTHON_FLAKE8_FILTER_REGEX_INCLUDE string

PYTHON_FLAKE8: Custom regex including filter: only files matching this regex will be linted

PYTHON_FLAKE8_POST_COMMANDS command_info[]

PYTHON_FLAKE8: Define bash commands to run after running PYTHON_FLAKE8

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_FLAKE8_PRE_COMMANDS command_info[]

PYTHON_FLAKE8: Define bash commands to run before running PYTHON_FLAKE8

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_FLAKE8_RULES_PATH string

PYTHON_FLAKE8: Path where to find linter configuration file

PYTHON_FLAKE8_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PYTHON_FLAKE8 and its pre/post commands

Default:
[]
PYTHON_ISORT_ARGUMENTS array | string

PYTHON_ISORT: User custom arguments to add in linter CLI call

PYTHON_ISORT_CLI_EXECUTABLE string[]

PYTHON_ISORT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "isort"
  ]
]
PYTHON_ISORT_CLI_LINT_MODE string

PYTHON_ISORT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PYTHON_ISORT_COMMAND_REMOVE_ARGUMENTS array | string

PYTHON_ISORT: User custom arguments to remove before calling linter

PYTHON_ISORT_CONFIG_FILE string

PYTHON_ISORT: User custom config file name if different from default

Default: ".isort.cfg"
PYTHON_ISORT_DISABLE_ERRORS boolean

PYTHON_ISORT: If true, PYTHON_ISORT doesn't make MegaLinter fail even if errors are found

Default: false
PYTHON_ISORT_DISABLE_ERRORS_IF_LESS_THAN number

PYTHON_ISORT: If the number of errors found is less than this value, PYTHON_ISORT doesn't make MegaLinter fail

Default: 0
PYTHON_ISORT_FILE_EXTENSIONS string[]

PYTHON_ISORT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".py",
  ".pyi",
  ".pyx",
  ".pxd"
]
Examples: ".py", ".myext"
PYTHON_ISORT_FILE_NAMES_REGEX string[]

PYTHON_ISORT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PYTHON_ISORT_FILTER_REGEX_EXCLUDE string

PYTHON_ISORT: Custom regex excluding filter: files matching this regex will NOT be linted

PYTHON_ISORT_FILTER_REGEX_INCLUDE string

PYTHON_ISORT: Custom regex including filter: only files matching this regex will be linted

PYTHON_ISORT_POST_COMMANDS command_info[]

PYTHON_ISORT: Define bash commands to run after running PYTHON_ISORT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_ISORT_PRE_COMMANDS command_info[]

PYTHON_ISORT: Define bash commands to run before running PYTHON_ISORT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_ISORT_RULES_PATH string

PYTHON_ISORT: Path where to find linter configuration file

PYTHON_ISORT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PYTHON_ISORT and its pre/post commands

Default:
[]
PYTHON_MYPY_ARGUMENTS array | string

PYTHON_MYPY: User custom arguments to add in linter CLI call

PYTHON_MYPY_CLI_EXECUTABLE string[]

PYTHON_MYPY: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "mypy"
  ]
]
PYTHON_MYPY_CLI_LINT_MODE string

PYTHON_MYPY: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PYTHON_MYPY_COMMAND_REMOVE_ARGUMENTS array | string

PYTHON_MYPY: User custom arguments to remove before calling linter

PYTHON_MYPY_CONFIG_FILE string

PYTHON_MYPY: User custom config file name if different from default

Default: ".mypy.ini"
PYTHON_MYPY_DISABLE_ERRORS boolean

PYTHON_MYPY: If true, PYTHON_MYPY doesn't make MegaLinter fail even if errors are found

Default: false
PYTHON_MYPY_DISABLE_ERRORS_IF_LESS_THAN number

PYTHON_MYPY: If the number of errors found is less than this value, PYTHON_MYPY doesn't make MegaLinter fail

Default: 0
PYTHON_MYPY_FILE_EXTENSIONS string[]

PYTHON_MYPY: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".py",
  ".pyi"
]
Examples: ".py", ".myext"
PYTHON_MYPY_FILE_NAMES_REGEX string[]

PYTHON_MYPY: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PYTHON_MYPY_FILTER_REGEX_EXCLUDE string

PYTHON_MYPY: Custom regex excluding filter: files matching this regex will NOT be linted

PYTHON_MYPY_FILTER_REGEX_INCLUDE string

PYTHON_MYPY: Custom regex including filter: only files matching this regex will be linted

PYTHON_MYPY_POST_COMMANDS command_info[]

PYTHON_MYPY: Define bash commands to run after running PYTHON_MYPY

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_MYPY_PRE_COMMANDS command_info[]

PYTHON_MYPY: Define bash commands to run before running PYTHON_MYPY

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_MYPY_RULES_PATH string

PYTHON_MYPY: Path where to find linter configuration file

PYTHON_MYPY_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PYTHON_MYPY and its pre/post commands

Default:
[]
PYTHON_NBQA_MYPY_ARGUMENTS array | string

PYTHON_NBQA_MYPY: User custom arguments to add in linter CLI call

PYTHON_NBQA_MYPY_CLI_EXECUTABLE string[]

PYTHON_NBQA_MYPY: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "nbqa"
  ]
]
PYTHON_NBQA_MYPY_CLI_LINT_MODE string

PYTHON_NBQA_MYPY: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PYTHON_NBQA_MYPY_COMMAND_REMOVE_ARGUMENTS array | string

PYTHON_NBQA_MYPY: User custom arguments to remove before calling linter

PYTHON_NBQA_MYPY_CONFIG_FILE string

PYTHON_NBQA_MYPY: User custom config file name if different from default

Default: ".mypy.ini"
PYTHON_NBQA_MYPY_DISABLE_ERRORS boolean

PYTHON_NBQA_MYPY: If true, PYTHON_NBQA_MYPY doesn't make MegaLinter fail even if errors are found

Default: false
PYTHON_NBQA_MYPY_DISABLE_ERRORS_IF_LESS_THAN number

PYTHON_NBQA_MYPY: If the number of errors found is less than this value, PYTHON_NBQA_MYPY doesn't make MegaLinter fail

Default: 0
PYTHON_NBQA_MYPY_FILE_EXTENSIONS string[]

PYTHON_NBQA_MYPY: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".ipynb"
]
Examples: ".py", ".myext"
PYTHON_NBQA_MYPY_FILE_NAMES_REGEX string[]

PYTHON_NBQA_MYPY: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PYTHON_NBQA_MYPY_FILTER_REGEX_EXCLUDE string

PYTHON_NBQA_MYPY: Custom regex excluding filter: files matching this regex will NOT be linted

PYTHON_NBQA_MYPY_FILTER_REGEX_INCLUDE string

PYTHON_NBQA_MYPY: Custom regex including filter: only files matching this regex will be linted

PYTHON_NBQA_MYPY_POST_COMMANDS command_info[]

PYTHON_NBQA_MYPY: Define bash commands to run after running PYTHON_NBQA_MYPY

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_NBQA_MYPY_PRE_COMMANDS command_info[]

PYTHON_NBQA_MYPY: Define bash commands to run before running PYTHON_NBQA_MYPY

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_NBQA_MYPY_RULES_PATH string

PYTHON_NBQA_MYPY: Path where to find linter configuration file

PYTHON_NBQA_MYPY_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PYTHON_NBQA_MYPY and its pre/post commands

Default:
[]
PYTHON_POST_COMMANDS command_info[]

PYTHON: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_PRE_COMMANDS command_info[]

PYTHON: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_PYLINT_ARGUMENTS array | string

PYTHON_PYLINT: User custom arguments to add in linter CLI call

PYTHON_PYLINT_CLI_EXECUTABLE string[]

PYTHON_PYLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "pylint"
  ]
]
PYTHON_PYLINT_CLI_LINT_MODE string

PYTHON_PYLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PYTHON_PYLINT_COMMAND_REMOVE_ARGUMENTS array | string

PYTHON_PYLINT: User custom arguments to remove before calling linter

PYTHON_PYLINT_CONFIG_FILE string

PYTHON_PYLINT: User custom config file name if different from default

Default: ".pylintrc"
PYTHON_PYLINT_DISABLE_ERRORS boolean

PYTHON_PYLINT: If true, PYTHON_PYLINT doesn't make MegaLinter fail even if errors are found

Default: false
PYTHON_PYLINT_DISABLE_ERRORS_IF_LESS_THAN number

PYTHON_PYLINT: If the number of errors found is less than this value, PYTHON_PYLINT doesn't make MegaLinter fail

Default: 0
PYTHON_PYLINT_FILE_EXTENSIONS string[]

PYTHON_PYLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".py",
  ".pyi"
]
Examples: ".py", ".myext"
PYTHON_PYLINT_FILE_NAMES_REGEX string[]

PYTHON_PYLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PYTHON_PYLINT_FILTER_REGEX_EXCLUDE string

PYTHON_PYLINT: Custom regex excluding filter: files matching this regex will NOT be linted

PYTHON_PYLINT_FILTER_REGEX_INCLUDE string

PYTHON_PYLINT: Custom regex including filter: only files matching this regex will be linted

PYTHON_PYLINT_POST_COMMANDS command_info[]

PYTHON_PYLINT: Define bash commands to run after running PYTHON_PYLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_PYLINT_PRE_COMMANDS command_info[]

PYTHON_PYLINT: Define bash commands to run before running PYTHON_PYLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_PYLINT_RULES_PATH string

PYTHON_PYLINT: Path where to find linter configuration file

PYTHON_PYLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PYTHON_PYLINT and its pre/post commands

Default:
[]
PYTHON_PYRIGHT_ARGUMENTS array | string

PYTHON_PYRIGHT: User custom arguments to add in linter CLI call

PYTHON_PYRIGHT_CLI_EXECUTABLE string[]

PYTHON_PYRIGHT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "pyright"
  ]
]
PYTHON_PYRIGHT_CLI_LINT_MODE string

PYTHON_PYRIGHT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PYTHON_PYRIGHT_COMMAND_REMOVE_ARGUMENTS array | string

PYTHON_PYRIGHT: User custom arguments to remove before calling linter

PYTHON_PYRIGHT_CONFIG_FILE string

PYTHON_PYRIGHT: User custom config file name if different from default

Default: "pyrightconfig.json"
PYTHON_PYRIGHT_DISABLE_ERRORS boolean

PYTHON_PYRIGHT: If true, PYTHON_PYRIGHT doesn't make MegaLinter fail even if errors are found

Default: false
PYTHON_PYRIGHT_DISABLE_ERRORS_IF_LESS_THAN number

PYTHON_PYRIGHT: If the number of errors found is less than this value, PYTHON_PYRIGHT doesn't make MegaLinter fail

Default: 0
PYTHON_PYRIGHT_FILE_EXTENSIONS string[]

PYTHON_PYRIGHT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".py",
  ".pyi"
]
Examples: ".py", ".myext"
PYTHON_PYRIGHT_FILE_NAMES_REGEX string[]

PYTHON_PYRIGHT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PYTHON_PYRIGHT_FILTER_REGEX_EXCLUDE string

PYTHON_PYRIGHT: Custom regex excluding filter: files matching this regex will NOT be linted

PYTHON_PYRIGHT_FILTER_REGEX_INCLUDE string

PYTHON_PYRIGHT: Custom regex including filter: only files matching this regex will be linted

PYTHON_PYRIGHT_POST_COMMANDS command_info[]

PYTHON_PYRIGHT: Define bash commands to run after running PYTHON_PYRIGHT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_PYRIGHT_PRE_COMMANDS command_info[]

PYTHON_PYRIGHT: Define bash commands to run before running PYTHON_PYRIGHT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_PYRIGHT_RULES_PATH string

PYTHON_PYRIGHT: Path where to find linter configuration file

PYTHON_PYRIGHT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PYTHON_PYRIGHT and its pre/post commands

Default:
[]
PYTHON_RUFF_ARGUMENTS array | string

PYTHON_RUFF: User custom arguments to add in linter CLI call

PYTHON_RUFF_CLI_EXECUTABLE string[]

PYTHON_RUFF: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "ruff"
  ]
]
PYTHON_RUFF_CLI_LINT_MODE string

PYTHON_RUFF: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PYTHON_RUFF_COMMAND_REMOVE_ARGUMENTS array | string

PYTHON_RUFF: User custom arguments to remove before calling linter

PYTHON_RUFF_CONFIG_FILE string

PYTHON_RUFF: User custom config file name if different from default

Default: ".ruff.toml"
PYTHON_RUFF_DISABLE_ERRORS boolean

PYTHON_RUFF: If true, PYTHON_RUFF doesn't make MegaLinter fail even if errors are found

Default: false
PYTHON_RUFF_DISABLE_ERRORS_IF_LESS_THAN number

PYTHON_RUFF: If the number of errors found is less than this value, PYTHON_RUFF doesn't make MegaLinter fail

Default: 0
PYTHON_RUFF_FILE_EXTENSIONS string[]

PYTHON_RUFF: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".py",
  ".pyi",
  ".ipynb"
]
Examples: ".py", ".myext"
PYTHON_RUFF_FILE_NAMES_REGEX string[]

PYTHON_RUFF: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PYTHON_RUFF_FILTER_REGEX_EXCLUDE string

PYTHON_RUFF: Custom regex excluding filter: files matching this regex will NOT be linted

PYTHON_RUFF_FILTER_REGEX_INCLUDE string

PYTHON_RUFF: Custom regex including filter: only files matching this regex will be linted

PYTHON_RUFF_FORMAT_ARGUMENTS array | string

PYTHON_RUFF_FORMAT: User custom arguments to add in linter CLI call

PYTHON_RUFF_FORMAT_CLI_EXECUTABLE string[]

PYTHON_RUFF_FORMAT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "ruff"
  ]
]
PYTHON_RUFF_FORMAT_CLI_LINT_MODE string

PYTHON_RUFF_FORMAT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
PYTHON_RUFF_FORMAT_COMMAND_REMOVE_ARGUMENTS array | string

PYTHON_RUFF_FORMAT: User custom arguments to remove before calling linter

PYTHON_RUFF_FORMAT_CONFIG_FILE string

PYTHON_RUFF_FORMAT: User custom config file name if different from default

Default: ".ruff.toml"
PYTHON_RUFF_FORMAT_DISABLE_ERRORS boolean

PYTHON_RUFF_FORMAT: If true, PYTHON_RUFF_FORMAT doesn't make MegaLinter fail even if errors are found

Default: false
PYTHON_RUFF_FORMAT_DISABLE_ERRORS_IF_LESS_THAN number

PYTHON_RUFF_FORMAT: If the number of errors found is less than this value, PYTHON_RUFF_FORMAT doesn't make MegaLinter fail

Default: 0
PYTHON_RUFF_FORMAT_FILE_EXTENSIONS string[]

PYTHON_RUFF_FORMAT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".py",
  ".pyi",
  ".ipynb"
]
Examples: ".py", ".myext"
PYTHON_RUFF_FORMAT_FILE_NAMES_REGEX string[]

PYTHON_RUFF_FORMAT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
PYTHON_RUFF_FORMAT_FILTER_REGEX_EXCLUDE string

PYTHON_RUFF_FORMAT: Custom regex excluding filter: files matching this regex will NOT be linted

PYTHON_RUFF_FORMAT_FILTER_REGEX_INCLUDE string

PYTHON_RUFF_FORMAT: Custom regex including filter: only files matching this regex will be linted

PYTHON_RUFF_FORMAT_POST_COMMANDS command_info[]

PYTHON_RUFF_FORMAT: Define bash commands to run after running PYTHON_RUFF_FORMAT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_RUFF_FORMAT_PRE_COMMANDS command_info[]

PYTHON_RUFF_FORMAT: Define bash commands to run before running PYTHON_RUFF_FORMAT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_RUFF_FORMAT_RULES_PATH string

PYTHON_RUFF_FORMAT: Path where to find linter configuration file

PYTHON_RUFF_FORMAT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PYTHON_RUFF_FORMAT and its pre/post commands

Default:
[]
PYTHON_RUFF_POST_COMMANDS command_info[]

PYTHON_RUFF: Define bash commands to run after running PYTHON_RUFF

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_RUFF_PRE_COMMANDS command_info[]

PYTHON_RUFF: Define bash commands to run before running PYTHON_RUFF

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
PYTHON_RUFF_RULES_PATH string

PYTHON_RUFF: Path where to find linter configuration file

PYTHON_RUFF_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling PYTHON_RUFF and its pre/post commands

Default:
[]
RAKU_FILTER_REGEX_EXCLUDE string

RAKU: Custom regex excluding filter: files matching this regex will NOT be linted

RAKU_FILTER_REGEX_INCLUDE string

RAKU: Custom regex including filter: only files matching this regex will be linted

RAKU_POST_COMMANDS command_info[]

RAKU: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
RAKU_PRE_COMMANDS command_info[]

RAKU: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
RAKU_RAKU_ARGUMENTS array | string

RAKU_RAKU: User custom arguments to add in linter CLI call

RAKU_RAKU_CLI_EXECUTABLE string[]

RAKU_RAKU: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "raku"
  ]
]
RAKU_RAKU_CLI_LINT_MODE string

RAKU_RAKU: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
RAKU_RAKU_COMMAND_REMOVE_ARGUMENTS array | string

RAKU_RAKU: User custom arguments to remove before calling linter

RAKU_RAKU_CONFIG_FILE string

RAKU_RAKU: User custom config file name if different from default

Default: "META6.json"
RAKU_RAKU_DISABLE_ERRORS boolean

RAKU_RAKU: If true, RAKU_RAKU doesn't make MegaLinter fail even if errors are found

Default: false
RAKU_RAKU_DISABLE_ERRORS_IF_LESS_THAN number

RAKU_RAKU: If the number of errors found is less than this value, RAKU_RAKU doesn't make MegaLinter fail

Default: 0
RAKU_RAKU_FILE_EXTENSIONS string[]

RAKU_RAKU: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".raku",
  ".rakumod",
  ".rakutest",
  ".pm6",
  ".pl6",
  ".p6"
]
Examples: ".py", ".myext"
RAKU_RAKU_FILE_NAMES_REGEX string[]

RAKU_RAKU: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
RAKU_RAKU_FILTER_REGEX_EXCLUDE string

RAKU_RAKU: Custom regex excluding filter: files matching this regex will NOT be linted

RAKU_RAKU_FILTER_REGEX_INCLUDE string

RAKU_RAKU: Custom regex including filter: only files matching this regex will be linted

RAKU_RAKU_POST_COMMANDS command_info[]

RAKU_RAKU: Define bash commands to run after running RAKU_RAKU

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
RAKU_RAKU_PRE_COMMANDS command_info[]

RAKU_RAKU: Define bash commands to run before running RAKU_RAKU

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
RAKU_RAKU_RULES_PATH string

RAKU_RAKU: Path where to find linter configuration file

RAKU_RAKU_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling RAKU_RAKU and its pre/post commands

Default:
[]
REPORTERS_MARKDOWN_SUMMARY_TYPE string

Display summary in PR/MR comments as sections, table or both

Default: "table-sections"
Values: "sections" "table" "sections-table" "table-sections"
REPORTERS_MARKDOWN_TYPE string

Define simple if you do not to have external images in PR/MR comments

Default: "advanced"
Values: "simple" "advanced"
REPORT_OUTPUT_FOLDER string

The location where the output reporting will be generated to

Default: "megalinter-reports"
REPOSITORY_CHECKOV_ARGUMENTS array | string

REPOSITORY_CHECKOV: User custom arguments to add in linter CLI call

REPOSITORY_CHECKOV_CLI_EXECUTABLE string[]

REPOSITORY_CHECKOV: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "checkov"
  ]
]
REPOSITORY_CHECKOV_CLI_LINT_MODE string

REPOSITORY_CHECKOV: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_CHECKOV_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_CHECKOV: User custom arguments to remove before calling linter

REPOSITORY_CHECKOV_CONFIG_FILE string

REPOSITORY_CHECKOV: User custom config file name if different from default

Default: ".checkov.yml"
REPOSITORY_CHECKOV_DISABLE_ERRORS boolean

REPOSITORY_CHECKOV: If true, REPOSITORY_CHECKOV doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_CHECKOV: If the number of errors found is less than this value, REPOSITORY_CHECKOV doesn't make MegaLinter fail

Default: 0
REPOSITORY_CHECKOV_POST_COMMANDS command_info[]

REPOSITORY_CHECKOV: Define bash commands to run after running REPOSITORY_CHECKOV

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_CHECKOV_PRE_COMMANDS command_info[]

REPOSITORY_CHECKOV: Define bash commands to run before running REPOSITORY_CHECKOV

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_CHECKOV_RULES_PATH string

REPOSITORY_CHECKOV: Path where to find linter configuration file

REPOSITORY_CHECKOV_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_CHECKOV and its pre/post commands

Default:
[]
REPOSITORY_DEVSKIM_ARGUMENTS array | string

REPOSITORY_DEVSKIM: User custom arguments to add in linter CLI call

REPOSITORY_DEVSKIM_CLI_EXECUTABLE string[]

REPOSITORY_DEVSKIM: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "devskim"
  ]
]
REPOSITORY_DEVSKIM_CLI_LINT_MODE string

REPOSITORY_DEVSKIM: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_DEVSKIM_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_DEVSKIM: User custom arguments to remove before calling linter

REPOSITORY_DEVSKIM_CONFIG_FILE string

REPOSITORY_DEVSKIM: User custom config file name if different from default

Default: ".devskim.json"
REPOSITORY_DEVSKIM_DISABLE_ERRORS boolean

REPOSITORY_DEVSKIM: If true, REPOSITORY_DEVSKIM doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_DEVSKIM_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_DEVSKIM: If the number of errors found is less than this value, REPOSITORY_DEVSKIM doesn't make MegaLinter fail

Default: 0
REPOSITORY_DEVSKIM_POST_COMMANDS command_info[]

REPOSITORY_DEVSKIM: Define bash commands to run after running REPOSITORY_DEVSKIM

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_DEVSKIM_PRE_COMMANDS command_info[]

REPOSITORY_DEVSKIM: Define bash commands to run before running REPOSITORY_DEVSKIM

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_DEVSKIM_RULES_PATH string

REPOSITORY_DEVSKIM: Path where to find linter configuration file

REPOSITORY_DEVSKIM_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_DEVSKIM and its pre/post commands

Default:
[]
REPOSITORY_DUSTILOCK_ARGUMENTS array | string

REPOSITORY_DUSTILOCK: User custom arguments to add in linter CLI call

REPOSITORY_DUSTILOCK_CLI_EXECUTABLE string[]

REPOSITORY_DUSTILOCK: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "dustilock"
  ]
]
REPOSITORY_DUSTILOCK_CLI_LINT_MODE string

REPOSITORY_DUSTILOCK: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_DUSTILOCK_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_DUSTILOCK: User custom arguments to remove before calling linter

REPOSITORY_DUSTILOCK_DISABLE_ERRORS boolean

REPOSITORY_DUSTILOCK: If true, REPOSITORY_DUSTILOCK doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_DUSTILOCK_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_DUSTILOCK: If the number of errors found is less than this value, REPOSITORY_DUSTILOCK doesn't make MegaLinter fail

Default: 0
REPOSITORY_DUSTILOCK_POST_COMMANDS command_info[]

REPOSITORY_DUSTILOCK: Define bash commands to run after running REPOSITORY_DUSTILOCK

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_DUSTILOCK_PRE_COMMANDS command_info[]

REPOSITORY_DUSTILOCK: Define bash commands to run before running REPOSITORY_DUSTILOCK

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_DUSTILOCK_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_DUSTILOCK and its pre/post commands

Default:
[]
REPOSITORY_FILTER_REGEX_EXCLUDE string

REPOSITORY: Custom regex excluding filter: files matching this regex will NOT be linted

REPOSITORY_FILTER_REGEX_INCLUDE string

REPOSITORY: Custom regex including filter: only files matching this regex will be linted

REPOSITORY_GITLEAKS_ARGUMENTS array | string

REPOSITORY_GITLEAKS: User custom arguments to add in linter CLI call

REPOSITORY_GITLEAKS_CLI_EXECUTABLE string[]

REPOSITORY_GITLEAKS: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "gitleaks"
  ]
]
REPOSITORY_GITLEAKS_CLI_LINT_MODE string

REPOSITORY_GITLEAKS: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_GITLEAKS_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_GITLEAKS: User custom arguments to remove before calling linter

REPOSITORY_GITLEAKS_CONFIG_FILE string

REPOSITORY_GITLEAKS: User custom config file name if different from default

Default: ".gitleaks.toml"
REPOSITORY_GITLEAKS_DISABLE_ERRORS boolean

REPOSITORY_GITLEAKS: If true, REPOSITORY_GITLEAKS doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_GITLEAKS_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_GITLEAKS: If the number of errors found is less than this value, REPOSITORY_GITLEAKS doesn't make MegaLinter fail

Default: 0
REPOSITORY_GITLEAKS_POST_COMMANDS command_info[]

REPOSITORY_GITLEAKS: Define bash commands to run after running REPOSITORY_GITLEAKS

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_GITLEAKS_PRE_COMMANDS command_info[]

REPOSITORY_GITLEAKS: Define bash commands to run before running REPOSITORY_GITLEAKS

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_GITLEAKS_PR_COMMITS_SCAN boolean
Default: false
REPOSITORY_GITLEAKS_PR_SOURCE_SHA string
Default: ""
REPOSITORY_GITLEAKS_PR_TARGET_SHA string
Default: ""
REPOSITORY_GITLEAKS_RULES_PATH string

REPOSITORY_GITLEAKS: Path where to find linter configuration file

REPOSITORY_GITLEAKS_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_GITLEAKS and its pre/post commands

Default:
[]
REPOSITORY_GIT_DIFF_ARGUMENTS array | string

REPOSITORY_GIT_DIFF: User custom arguments to add in linter CLI call

REPOSITORY_GIT_DIFF_CLI_EXECUTABLE string[]

REPOSITORY_GIT_DIFF: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "git"
  ]
]
REPOSITORY_GIT_DIFF_CLI_LINT_MODE string

REPOSITORY_GIT_DIFF: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_GIT_DIFF_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_GIT_DIFF: User custom arguments to remove before calling linter

REPOSITORY_GIT_DIFF_DISABLE_ERRORS boolean

REPOSITORY_GIT_DIFF: If true, REPOSITORY_GIT_DIFF doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_GIT_DIFF_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_GIT_DIFF: If the number of errors found is less than this value, REPOSITORY_GIT_DIFF doesn't make MegaLinter fail

Default: 0
REPOSITORY_GIT_DIFF_POST_COMMANDS command_info[]

REPOSITORY_GIT_DIFF: Define bash commands to run after running REPOSITORY_GIT_DIFF

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_GIT_DIFF_PRE_COMMANDS command_info[]

REPOSITORY_GIT_DIFF: Define bash commands to run before running REPOSITORY_GIT_DIFF

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_GIT_DIFF_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_GIT_DIFF and its pre/post commands

Default:
[]
REPOSITORY_GOODCHECK_ARGUMENTS array | string

REPOSITORY_GOODCHECK: User custom arguments to add in linter CLI call

REPOSITORY_GOODCHECK_CLI_EXECUTABLE string[]
Default:
[
  [
    "goodcheck"
  ]
]
REPOSITORY_GOODCHECK_CONFIG_FILE string

REPOSITORY_GOODCHECK: User custom config file name if different from default

Default: "goodcheck.yml"
REPOSITORY_GOODCHECK_DISABLE_ERRORS boolean
Default: false
REPOSITORY_GOODCHECK_DISABLE_ERRORS_IF_LESS_THAN number
Default: 0
REPOSITORY_GOODCHECK_POST_COMMANDS command_info[]
Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_GOODCHECK_PRE_COMMANDS command_info[]
Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_GOODCHECK_RULES_PATH string

REPOSITORY_GOODCHECK: Path where to find linter configuration file

REPOSITORY_GRYPE_ARGUMENTS array | string

REPOSITORY_GRYPE: User custom arguments to add in linter CLI call

REPOSITORY_GRYPE_CLI_EXECUTABLE string[]

REPOSITORY_GRYPE: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "grype"
  ]
]
REPOSITORY_GRYPE_CLI_LINT_MODE string

REPOSITORY_GRYPE: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_GRYPE_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_GRYPE: User custom arguments to remove before calling linter

REPOSITORY_GRYPE_CONFIG_FILE string

REPOSITORY_GRYPE: User custom config file name if different from default

Default: ".grype.yaml"
REPOSITORY_GRYPE_DISABLE_ERRORS boolean

REPOSITORY_GRYPE: If true, REPOSITORY_GRYPE doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_GRYPE_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_GRYPE: If the number of errors found is less than this value, REPOSITORY_GRYPE doesn't make MegaLinter fail

Default: 0
REPOSITORY_GRYPE_POST_COMMANDS command_info[]

REPOSITORY_GRYPE: Define bash commands to run after running REPOSITORY_GRYPE

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_GRYPE_PRE_COMMANDS command_info[]

REPOSITORY_GRYPE: Define bash commands to run before running REPOSITORY_GRYPE

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_GRYPE_RULES_PATH string

REPOSITORY_GRYPE: Path where to find linter configuration file

REPOSITORY_GRYPE_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_GRYPE and its pre/post commands

Default:
[]
REPOSITORY_KICS_ARGUMENTS array | string

REPOSITORY_KICS: User custom arguments to add in linter CLI call

REPOSITORY_KICS_CLI_EXECUTABLE string[]

REPOSITORY_KICS: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "kics"
  ]
]
REPOSITORY_KICS_CLI_LINT_MODE string

REPOSITORY_KICS: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_KICS_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_KICS: User custom arguments to remove before calling linter

REPOSITORY_KICS_CONFIG_FILE string

REPOSITORY_KICS: User custom config file name if different from default

Default: "kics.config"
REPOSITORY_KICS_DISABLE_ERRORS boolean

REPOSITORY_KICS: If true, REPOSITORY_KICS doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_KICS_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_KICS: If the number of errors found is less than this value, REPOSITORY_KICS doesn't make MegaLinter fail

Default: 0
REPOSITORY_KICS_POST_COMMANDS command_info[]

REPOSITORY_KICS: Define bash commands to run after running REPOSITORY_KICS

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_KICS_PRE_COMMANDS command_info[]

REPOSITORY_KICS: Define bash commands to run before running REPOSITORY_KICS

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_KICS_RULES_PATH string

REPOSITORY_KICS: Path where to find linter configuration file

REPOSITORY_KICS_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_KICS and its pre/post commands

Default:
[]
REPOSITORY_KINGFISHER_ARGUMENTS array | string

REPOSITORY_KINGFISHER: User custom arguments to add in linter CLI call

REPOSITORY_KINGFISHER_CLI_EXECUTABLE string[]

REPOSITORY_KINGFISHER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "kingfisher"
  ]
]
REPOSITORY_KINGFISHER_CLI_LINT_MODE string

REPOSITORY_KINGFISHER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_KINGFISHER_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_KINGFISHER: User custom arguments to remove before calling linter

REPOSITORY_KINGFISHER_DISABLE_ERRORS boolean

REPOSITORY_KINGFISHER: If true, REPOSITORY_KINGFISHER doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_KINGFISHER_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_KINGFISHER: If the number of errors found is less than this value, REPOSITORY_KINGFISHER doesn't make MegaLinter fail

Default: 0
REPOSITORY_KINGFISHER_POST_COMMANDS command_info[]

REPOSITORY_KINGFISHER: Define bash commands to run after running REPOSITORY_KINGFISHER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_KINGFISHER_PRE_COMMANDS command_info[]

REPOSITORY_KINGFISHER: Define bash commands to run before running REPOSITORY_KINGFISHER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_KINGFISHER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_KINGFISHER and its pre/post commands

Default:
[]
REPOSITORY_LS_LINT_ARGUMENTS array | string

REPOSITORY_LS_LINT: User custom arguments to add in linter CLI call

REPOSITORY_LS_LINT_CLI_EXECUTABLE string[]

REPOSITORY_LS_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "ls-lint"
  ]
]
REPOSITORY_LS_LINT_CLI_LINT_MODE string

REPOSITORY_LS_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_LS_LINT_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_LS_LINT: User custom arguments to remove before calling linter

REPOSITORY_LS_LINT_CONFIG_FILE string

REPOSITORY_LS_LINT: User custom config file name if different from default

Default: ".ls-lint.yml"
REPOSITORY_LS_LINT_DISABLE_ERRORS boolean

REPOSITORY_LS_LINT: If true, REPOSITORY_LS_LINT doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_LS_LINT_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_LS_LINT: If the number of errors found is less than this value, REPOSITORY_LS_LINT doesn't make MegaLinter fail

Default: 0
REPOSITORY_LS_LINT_POST_COMMANDS command_info[]

REPOSITORY_LS_LINT: Define bash commands to run after running REPOSITORY_LS_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_LS_LINT_PRE_COMMANDS command_info[]

REPOSITORY_LS_LINT: Define bash commands to run before running REPOSITORY_LS_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_LS_LINT_RULES_PATH string

REPOSITORY_LS_LINT: Path where to find linter configuration file

REPOSITORY_LS_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_LS_LINT and its pre/post commands

Default:
[]
REPOSITORY_POST_COMMANDS command_info[]

REPOSITORY: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_PRE_COMMANDS command_info[]

REPOSITORY: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_SECRETLINT_ARGUMENTS array | string

REPOSITORY_SECRETLINT: User custom arguments to add in linter CLI call

REPOSITORY_SECRETLINT_CLI_EXECUTABLE string[]

REPOSITORY_SECRETLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "secretlint"
  ]
]
REPOSITORY_SECRETLINT_CLI_LINT_MODE string

REPOSITORY_SECRETLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_SECRETLINT_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_SECRETLINT: User custom arguments to remove before calling linter

REPOSITORY_SECRETLINT_CONFIG_FILE string

REPOSITORY_SECRETLINT: User custom config file name if different from default

Default: ".secretlintrc.json"
REPOSITORY_SECRETLINT_DISABLE_ERRORS boolean

REPOSITORY_SECRETLINT: If true, REPOSITORY_SECRETLINT doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_SECRETLINT_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_SECRETLINT: If the number of errors found is less than this value, REPOSITORY_SECRETLINT doesn't make MegaLinter fail

Default: 0
REPOSITORY_SECRETLINT_POST_COMMANDS command_info[]

REPOSITORY_SECRETLINT: Define bash commands to run after running REPOSITORY_SECRETLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_SECRETLINT_PRE_COMMANDS command_info[]

REPOSITORY_SECRETLINT: Define bash commands to run before running REPOSITORY_SECRETLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_SECRETLINT_RULES_PATH string

REPOSITORY_SECRETLINT: Path where to find linter configuration file

REPOSITORY_SECRETLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_SECRETLINT and its pre/post commands

Default:
[]
REPOSITORY_SEMGREP_ARGUMENTS array | string

REPOSITORY_SEMGREP: User custom arguments to add in linter CLI call

REPOSITORY_SEMGREP_CLI_EXECUTABLE string[]

REPOSITORY_SEMGREP: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "semgrep"
  ]
]
REPOSITORY_SEMGREP_CLI_LINT_MODE string

REPOSITORY_SEMGREP: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_SEMGREP_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_SEMGREP: User custom arguments to remove before calling linter

REPOSITORY_SEMGREP_DISABLE_ERRORS boolean

REPOSITORY_SEMGREP: If true, REPOSITORY_SEMGREP doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_SEMGREP_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_SEMGREP: If the number of errors found is less than this value, REPOSITORY_SEMGREP doesn't make MegaLinter fail

Default: 0
REPOSITORY_SEMGREP_POST_COMMANDS command_info[]

REPOSITORY_SEMGREP: Define bash commands to run after running REPOSITORY_SEMGREP

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_SEMGREP_PRE_COMMANDS command_info[]

REPOSITORY_SEMGREP: Define bash commands to run before running REPOSITORY_SEMGREP

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_SEMGREP_RULESETS array | string

REPOSITORY_SEMGREP: Specify custom ruleset(s) for semgrep

REPOSITORY_SEMGREP_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_SEMGREP and its pre/post commands

Default:
[]
REPOSITORY_SYFT_ARGUMENTS array | string

REPOSITORY_SYFT: User custom arguments to add in linter CLI call

REPOSITORY_SYFT_CLI_EXECUTABLE string[]

REPOSITORY_SYFT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "syft"
  ]
]
REPOSITORY_SYFT_CLI_LINT_MODE string

REPOSITORY_SYFT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_SYFT_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_SYFT: User custom arguments to remove before calling linter

REPOSITORY_SYFT_CONFIG_FILE string

REPOSITORY_SYFT: User custom config file name if different from default

Default: ".syft.yaml"
REPOSITORY_SYFT_DISABLE_ERRORS boolean

REPOSITORY_SYFT: If true, REPOSITORY_SYFT doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_SYFT_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_SYFT: If the number of errors found is less than this value, REPOSITORY_SYFT doesn't make MegaLinter fail

Default: 0
REPOSITORY_SYFT_POST_COMMANDS command_info[]

REPOSITORY_SYFT: Define bash commands to run after running REPOSITORY_SYFT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_SYFT_PRE_COMMANDS command_info[]

REPOSITORY_SYFT: Define bash commands to run before running REPOSITORY_SYFT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_SYFT_RULES_PATH string

REPOSITORY_SYFT: Path where to find linter configuration file

REPOSITORY_SYFT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_SYFT and its pre/post commands

Default:
[]
REPOSITORY_TRIVY_ARGUMENTS array | string

REPOSITORY_TRIVY: User custom arguments to add in linter CLI call

REPOSITORY_TRIVY_CLI_EXECUTABLE string[]

REPOSITORY_TRIVY: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "trivy"
  ]
]
REPOSITORY_TRIVY_CLI_LINT_MODE string

REPOSITORY_TRIVY: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_TRIVY_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_TRIVY: User custom arguments to remove before calling linter

REPOSITORY_TRIVY_CONFIG_FILE string

REPOSITORY_TRIVY: User custom config file name if different from default

Default: "trivy.yaml"
REPOSITORY_TRIVY_DISABLE_ERRORS boolean

REPOSITORY_TRIVY: If true, REPOSITORY_TRIVY doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_TRIVY_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_TRIVY: If the number of errors found is less than this value, REPOSITORY_TRIVY doesn't make MegaLinter fail

Default: 0
REPOSITORY_TRIVY_POST_COMMANDS command_info[]

REPOSITORY_TRIVY: Define bash commands to run after running REPOSITORY_TRIVY

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_TRIVY_PRE_COMMANDS command_info[]

REPOSITORY_TRIVY: Define bash commands to run before running REPOSITORY_TRIVY

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_TRIVY_RULES_PATH string

REPOSITORY_TRIVY: Path where to find linter configuration file

REPOSITORY_TRIVY_SBOM_ARGUMENTS array | string

REPOSITORY_TRIVY_SBOM: User custom arguments to add in linter CLI call

REPOSITORY_TRIVY_SBOM_CLI_EXECUTABLE string[]

REPOSITORY_TRIVY_SBOM: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "trivy"
  ]
]
REPOSITORY_TRIVY_SBOM_CLI_LINT_MODE string

REPOSITORY_TRIVY_SBOM: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_TRIVY_SBOM_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_TRIVY_SBOM: User custom arguments to remove before calling linter

REPOSITORY_TRIVY_SBOM_CONFIG_FILE string

REPOSITORY_TRIVY_SBOM: User custom config file name if different from default

Default: "trivy-sbom.yaml"
REPOSITORY_TRIVY_SBOM_DISABLE_ERRORS boolean

REPOSITORY_TRIVY_SBOM: If true, REPOSITORY_TRIVY_SBOM doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_TRIVY_SBOM_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_TRIVY_SBOM: If the number of errors found is less than this value, REPOSITORY_TRIVY_SBOM doesn't make MegaLinter fail

Default: 0
REPOSITORY_TRIVY_SBOM_POST_COMMANDS command_info[]

REPOSITORY_TRIVY_SBOM: Define bash commands to run after running REPOSITORY_TRIVY_SBOM

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_TRIVY_SBOM_PRE_COMMANDS command_info[]

REPOSITORY_TRIVY_SBOM: Define bash commands to run before running REPOSITORY_TRIVY_SBOM

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_TRIVY_SBOM_RULES_PATH string

REPOSITORY_TRIVY_SBOM: Path where to find linter configuration file

REPOSITORY_TRIVY_SBOM_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_TRIVY_SBOM and its pre/post commands

Default:
[]
REPOSITORY_TRIVY_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_TRIVY and its pre/post commands

Default:
[]
REPOSITORY_TRUFFLEHOG_ARGUMENTS array | string

REPOSITORY_TRUFFLEHOG: User custom arguments to add in linter CLI call

REPOSITORY_TRUFFLEHOG_CLI_EXECUTABLE string[]

REPOSITORY_TRUFFLEHOG: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "trufflehog"
  ]
]
REPOSITORY_TRUFFLEHOG_CLI_LINT_MODE string

REPOSITORY_TRUFFLEHOG: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
REPOSITORY_TRUFFLEHOG_COMMAND_REMOVE_ARGUMENTS array | string

REPOSITORY_TRUFFLEHOG: User custom arguments to remove before calling linter

REPOSITORY_TRUFFLEHOG_CONFIG_FILE string

REPOSITORY_TRUFFLEHOG: User custom config file name if different from default

Default: ".trufflehog.yml"
REPOSITORY_TRUFFLEHOG_DISABLE_ERRORS boolean

REPOSITORY_TRUFFLEHOG: If true, REPOSITORY_TRUFFLEHOG doesn't make MegaLinter fail even if errors are found

Default: false
REPOSITORY_TRUFFLEHOG_DISABLE_ERRORS_IF_LESS_THAN number

REPOSITORY_TRUFFLEHOG: If the number of errors found is less than this value, REPOSITORY_TRUFFLEHOG doesn't make MegaLinter fail

Default: 0
REPOSITORY_TRUFFLEHOG_POST_COMMANDS command_info[]

REPOSITORY_TRUFFLEHOG: Define bash commands to run after running REPOSITORY_TRUFFLEHOG

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_TRUFFLEHOG_PRE_COMMANDS command_info[]

REPOSITORY_TRUFFLEHOG: Define bash commands to run before running REPOSITORY_TRUFFLEHOG

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
REPOSITORY_TRUFFLEHOG_RULES_PATH string

REPOSITORY_TRUFFLEHOG: Path where to find linter configuration file

REPOSITORY_TRUFFLEHOG_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling REPOSITORY_TRUFFLEHOG and its pre/post commands

Default:
[]
ROBOTFRAMEWORK_FILTER_REGEX_EXCLUDE string

ROBOTFRAMEWORK: Custom regex excluding filter: files matching this regex will NOT be linted

ROBOTFRAMEWORK_FILTER_REGEX_INCLUDE string

ROBOTFRAMEWORK: Custom regex including filter: only files matching this regex will be linted

ROBOTFRAMEWORK_POST_COMMANDS command_info[]

ROBOTFRAMEWORK: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
ROBOTFRAMEWORK_PRE_COMMANDS command_info[]

ROBOTFRAMEWORK: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
ROBOTFRAMEWORK_ROBOCOP_ARGUMENTS array | string

ROBOTFRAMEWORK_ROBOCOP: User custom arguments to add in linter CLI call

ROBOTFRAMEWORK_ROBOCOP_CLI_EXECUTABLE string[]

ROBOTFRAMEWORK_ROBOCOP: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "robocop"
  ]
]
ROBOTFRAMEWORK_ROBOCOP_CLI_LINT_MODE string

ROBOTFRAMEWORK_ROBOCOP: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
ROBOTFRAMEWORK_ROBOCOP_COMMAND_REMOVE_ARGUMENTS array | string

ROBOTFRAMEWORK_ROBOCOP: User custom arguments to remove before calling linter

ROBOTFRAMEWORK_ROBOCOP_CONFIG_FILE string

ROBOTFRAMEWORK_ROBOCOP: User custom config file name if different from default

Default: "robocop.toml"
ROBOTFRAMEWORK_ROBOCOP_DISABLE_ERRORS boolean

ROBOTFRAMEWORK_ROBOCOP: If true, ROBOTFRAMEWORK_ROBOCOP doesn't make MegaLinter fail even if errors are found

Default: false
ROBOTFRAMEWORK_ROBOCOP_DISABLE_ERRORS_IF_LESS_THAN number

ROBOTFRAMEWORK_ROBOCOP: If the number of errors found is less than this value, ROBOTFRAMEWORK_ROBOCOP doesn't make MegaLinter fail

Default: 0
ROBOTFRAMEWORK_ROBOCOP_FILE_EXTENSIONS string[]

ROBOTFRAMEWORK_ROBOCOP: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".robot",
  ".resource"
]
Examples: ".py", ".myext"
ROBOTFRAMEWORK_ROBOCOP_FILE_NAMES_REGEX string[]

ROBOTFRAMEWORK_ROBOCOP: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
ROBOTFRAMEWORK_ROBOCOP_FILTER_REGEX_EXCLUDE string

ROBOTFRAMEWORK_ROBOCOP: Custom regex excluding filter: files matching this regex will NOT be linted

ROBOTFRAMEWORK_ROBOCOP_FILTER_REGEX_INCLUDE string

ROBOTFRAMEWORK_ROBOCOP: Custom regex including filter: only files matching this regex will be linted

ROBOTFRAMEWORK_ROBOCOP_POST_COMMANDS command_info[]

ROBOTFRAMEWORK_ROBOCOP: Define bash commands to run after running ROBOTFRAMEWORK_ROBOCOP

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
ROBOTFRAMEWORK_ROBOCOP_PRE_COMMANDS command_info[]

ROBOTFRAMEWORK_ROBOCOP: Define bash commands to run before running ROBOTFRAMEWORK_ROBOCOP

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
ROBOTFRAMEWORK_ROBOCOP_RULES_PATH string

ROBOTFRAMEWORK_ROBOCOP: Path where to find linter configuration file

ROBOTFRAMEWORK_ROBOCOP_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling ROBOTFRAMEWORK_ROBOCOP and its pre/post commands

Default:
[]
RST_FILTER_REGEX_EXCLUDE string

RST: Custom regex excluding filter: files matching this regex will NOT be linted

RST_FILTER_REGEX_INCLUDE string

RST: Custom regex including filter: only files matching this regex will be linted

RST_POST_COMMANDS command_info[]

RST: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
RST_PRE_COMMANDS command_info[]

RST: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
RST_RSTCHECK_ARGUMENTS array | string

RST_RSTCHECK: User custom arguments to add in linter CLI call

RST_RSTCHECK_CLI_EXECUTABLE string[]

RST_RSTCHECK: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "rstcheck"
  ]
]
RST_RSTCHECK_CLI_LINT_MODE string

RST_RSTCHECK: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
RST_RSTCHECK_COMMAND_REMOVE_ARGUMENTS array | string

RST_RSTCHECK: User custom arguments to remove before calling linter

RST_RSTCHECK_CONFIG_FILE string

RST_RSTCHECK: User custom config file name if different from default

Default: ".rstcheck.cfg"
RST_RSTCHECK_DISABLE_ERRORS boolean

RST_RSTCHECK: If true, RST_RSTCHECK doesn't make MegaLinter fail even if errors are found

Default: false
RST_RSTCHECK_DISABLE_ERRORS_IF_LESS_THAN number

RST_RSTCHECK: If the number of errors found is less than this value, RST_RSTCHECK doesn't make MegaLinter fail

Default: 0
RST_RSTCHECK_FILE_EXTENSIONS string[]

RST_RSTCHECK: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".rst"
]
Examples: ".py", ".myext"
RST_RSTCHECK_FILE_NAMES_REGEX string[]

RST_RSTCHECK: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
RST_RSTCHECK_FILTER_REGEX_EXCLUDE string

RST_RSTCHECK: Custom regex excluding filter: files matching this regex will NOT be linted

RST_RSTCHECK_FILTER_REGEX_INCLUDE string

RST_RSTCHECK: Custom regex including filter: only files matching this regex will be linted

RST_RSTCHECK_POST_COMMANDS command_info[]

RST_RSTCHECK: Define bash commands to run after running RST_RSTCHECK

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
RST_RSTCHECK_PRE_COMMANDS command_info[]

RST_RSTCHECK: Define bash commands to run before running RST_RSTCHECK

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
RST_RSTCHECK_RULES_PATH string

RST_RSTCHECK: Path where to find linter configuration file

RST_RSTCHECK_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling RST_RSTCHECK and its pre/post commands

Default:
[]
RST_RSTFMT_ARGUMENTS array | string

RST_RSTFMT: User custom arguments to add in linter CLI call

RST_RSTFMT_CLI_EXECUTABLE string[]

RST_RSTFMT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "rstfmt"
  ]
]
RST_RSTFMT_CLI_LINT_MODE string

RST_RSTFMT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
RST_RSTFMT_COMMAND_REMOVE_ARGUMENTS array | string

RST_RSTFMT: User custom arguments to remove before calling linter

RST_RSTFMT_DISABLE_ERRORS boolean

RST_RSTFMT: If true, RST_RSTFMT doesn't make MegaLinter fail even if errors are found

Default: false
RST_RSTFMT_DISABLE_ERRORS_IF_LESS_THAN number

RST_RSTFMT: If the number of errors found is less than this value, RST_RSTFMT doesn't make MegaLinter fail

Default: 0
RST_RSTFMT_FILE_EXTENSIONS string[]

RST_RSTFMT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".rst"
]
Examples: ".py", ".myext"
RST_RSTFMT_FILE_NAMES_REGEX string[]

RST_RSTFMT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
RST_RSTFMT_FILTER_REGEX_EXCLUDE string

RST_RSTFMT: Custom regex excluding filter: files matching this regex will NOT be linted

RST_RSTFMT_FILTER_REGEX_INCLUDE string

RST_RSTFMT: Custom regex including filter: only files matching this regex will be linted

RST_RSTFMT_POST_COMMANDS command_info[]

RST_RSTFMT: Define bash commands to run after running RST_RSTFMT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
RST_RSTFMT_PRE_COMMANDS command_info[]

RST_RSTFMT: Define bash commands to run before running RST_RSTFMT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
RST_RSTFMT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling RST_RSTFMT and its pre/post commands

Default:
[]
RST_RST_LINT_ARGUMENTS array | string

RST_RST_LINT: User custom arguments to add in linter CLI call

RST_RST_LINT_CLI_EXECUTABLE string[]

RST_RST_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "rst-lint"
  ]
]
RST_RST_LINT_CLI_LINT_MODE string

RST_RST_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
RST_RST_LINT_COMMAND_REMOVE_ARGUMENTS array | string

RST_RST_LINT: User custom arguments to remove before calling linter

RST_RST_LINT_DISABLE_ERRORS boolean

RST_RST_LINT: If true, RST_RST_LINT doesn't make MegaLinter fail even if errors are found

Default: false
RST_RST_LINT_DISABLE_ERRORS_IF_LESS_THAN number

RST_RST_LINT: If the number of errors found is less than this value, RST_RST_LINT doesn't make MegaLinter fail

Default: 0
RST_RST_LINT_FILE_EXTENSIONS string[]

RST_RST_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".rst"
]
Examples: ".py", ".myext"
RST_RST_LINT_FILE_NAMES_REGEX string[]

RST_RST_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
RST_RST_LINT_FILTER_REGEX_EXCLUDE string

RST_RST_LINT: Custom regex excluding filter: files matching this regex will NOT be linted

RST_RST_LINT_FILTER_REGEX_INCLUDE string

RST_RST_LINT: Custom regex including filter: only files matching this regex will be linted

RST_RST_LINT_POST_COMMANDS command_info[]

RST_RST_LINT: Define bash commands to run after running RST_RST_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
RST_RST_LINT_PRE_COMMANDS command_info[]

RST_RST_LINT: Define bash commands to run before running RST_RST_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
RST_RST_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling RST_RST_LINT and its pre/post commands

Default:
[]
RUBY_FILTER_REGEX_EXCLUDE string

RUBY: Custom regex excluding filter: files matching this regex will NOT be linted

RUBY_FILTER_REGEX_INCLUDE string

RUBY: Custom regex including filter: only files matching this regex will be linted

RUBY_POST_COMMANDS command_info[]

RUBY: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
RUBY_PRE_COMMANDS command_info[]

RUBY: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
RUBY_RUBOCOP_ARGUMENTS array | string

RUBY_RUBOCOP: User custom arguments to add in linter CLI call

RUBY_RUBOCOP_CLI_EXECUTABLE string[]

RUBY_RUBOCOP: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "rubocop"
  ]
]
RUBY_RUBOCOP_CLI_LINT_MODE string

RUBY_RUBOCOP: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
RUBY_RUBOCOP_COMMAND_REMOVE_ARGUMENTS array | string

RUBY_RUBOCOP: User custom arguments to remove before calling linter

RUBY_RUBOCOP_CONFIG_FILE string

RUBY_RUBOCOP: User custom config file name if different from default

Default: ".ruby-lint.yml"
RUBY_RUBOCOP_DISABLE_ERRORS boolean

RUBY_RUBOCOP: If true, RUBY_RUBOCOP doesn't make MegaLinter fail even if errors are found

Default: false
RUBY_RUBOCOP_DISABLE_ERRORS_IF_LESS_THAN number

RUBY_RUBOCOP: If the number of errors found is less than this value, RUBY_RUBOCOP doesn't make MegaLinter fail

Default: 0
RUBY_RUBOCOP_FILE_EXTENSIONS string[]

RUBY_RUBOCOP: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".rb"
]
Examples: ".py", ".myext"
RUBY_RUBOCOP_FILE_NAMES_REGEX string[]

RUBY_RUBOCOP: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
RUBY_RUBOCOP_FILTER_REGEX_EXCLUDE string

RUBY_RUBOCOP: Custom regex excluding filter: files matching this regex will NOT be linted

RUBY_RUBOCOP_FILTER_REGEX_INCLUDE string

RUBY_RUBOCOP: Custom regex including filter: only files matching this regex will be linted

RUBY_RUBOCOP_POST_COMMANDS command_info[]

RUBY_RUBOCOP: Define bash commands to run after running RUBY_RUBOCOP

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
RUBY_RUBOCOP_PRE_COMMANDS command_info[]

RUBY_RUBOCOP: Define bash commands to run before running RUBY_RUBOCOP

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
RUBY_RUBOCOP_RULES_PATH string

RUBY_RUBOCOP: Path where to find linter configuration file

RUBY_RUBOCOP_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling RUBY_RUBOCOP and its pre/post commands

Default:
[]
RUST_CLIPPY_ARGUMENTS array | string

RUST_CLIPPY: User custom arguments to add in linter CLI call

RUST_CLIPPY_CLI_EXECUTABLE string[]

RUST_CLIPPY: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "cargo-clippy"
  ]
]
RUST_CLIPPY_CLI_LINT_MODE string

RUST_CLIPPY: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
RUST_CLIPPY_COMMAND_REMOVE_ARGUMENTS array | string

RUST_CLIPPY: User custom arguments to remove before calling linter

RUST_CLIPPY_CONFIG_FILE string

RUST_CLIPPY: User custom config file name if different from default

Default: ".clippy.toml"
RUST_CLIPPY_DISABLE_ERRORS boolean

RUST_CLIPPY: If true, RUST_CLIPPY doesn't make MegaLinter fail even if errors are found

Default: false
RUST_CLIPPY_DISABLE_ERRORS_IF_LESS_THAN number

RUST_CLIPPY: If the number of errors found is less than this value, RUST_CLIPPY doesn't make MegaLinter fail

Default: 0
RUST_CLIPPY_FILE_EXTENSIONS string[]

RUST_CLIPPY: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".rs"
]
Examples: ".py", ".myext"
RUST_CLIPPY_FILE_NAMES_REGEX string[]

RUST_CLIPPY: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
RUST_CLIPPY_POST_COMMANDS command_info[]

RUST_CLIPPY: Define bash commands to run after running RUST_CLIPPY

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
RUST_CLIPPY_PRE_COMMANDS command_info[]

RUST_CLIPPY: Define bash commands to run before running RUST_CLIPPY

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
RUST_CLIPPY_RULES_PATH string

RUST_CLIPPY: Path where to find linter configuration file

RUST_CLIPPY_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling RUST_CLIPPY and its pre/post commands

Default:
[]
RUST_FILTER_REGEX_EXCLUDE string

RUST: Custom regex excluding filter: files matching this regex will NOT be linted

RUST_FILTER_REGEX_INCLUDE string

RUST: Custom regex including filter: only files matching this regex will be linted

RUST_POST_COMMANDS command_info[]

RUST: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
RUST_PRE_COMMANDS command_info[]

RUST: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
R_FILTER_REGEX_EXCLUDE string

R: Custom regex excluding filter: files matching this regex will NOT be linted

R_FILTER_REGEX_INCLUDE string

R: Custom regex including filter: only files matching this regex will be linted

R_LINTR_ARGUMENTS array | string

R_LINTR: User custom arguments to add in linter CLI call

R_LINTR_CLI_EXECUTABLE string[]

R_LINTR: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "lintr"
  ]
]
R_LINTR_CLI_LINT_MODE string

R_LINTR: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
R_LINTR_COMMAND_REMOVE_ARGUMENTS array | string

R_LINTR: User custom arguments to remove before calling linter

R_LINTR_CONFIG_FILE string

R_LINTR: User custom config file name if different from default

Default: ".lintr"
R_LINTR_DISABLE_ERRORS boolean

R_LINTR: If true, R_LINTR doesn't make MegaLinter fail even if errors are found

Default: false
R_LINTR_DISABLE_ERRORS_IF_LESS_THAN number

R_LINTR: If the number of errors found is less than this value, R_LINTR doesn't make MegaLinter fail

Default: 0
R_LINTR_FILE_EXTENSIONS string[]

R_LINTR: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".r",
  ".R",
  ".Rmd",
  ".RMD"
]
Examples: ".py", ".myext"
R_LINTR_FILE_NAMES_REGEX string[]

R_LINTR: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
R_LINTR_FILTER_REGEX_EXCLUDE string

R_LINTR: Custom regex excluding filter: files matching this regex will NOT be linted

R_LINTR_FILTER_REGEX_INCLUDE string

R_LINTR: Custom regex including filter: only files matching this regex will be linted

R_LINTR_POST_COMMANDS command_info[]

R_LINTR: Define bash commands to run after running R_LINTR

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
R_LINTR_PRE_COMMANDS command_info[]

R_LINTR: Define bash commands to run before running R_LINTR

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
R_LINTR_RULES_PATH string

R_LINTR: Path where to find linter configuration file

R_LINTR_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling R_LINTR and its pre/post commands

Default:
[]
R_POST_COMMANDS command_info[]

R: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
R_PRE_COMMANDS command_info[]

R: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_CODE_ANALYZER_APEX_ARGUMENTS array | string

SALESFORCE_CODE_ANALYZER_APEX: User custom arguments to add in linter CLI call

SALESFORCE_CODE_ANALYZER_APEX_CLI_EXECUTABLE string[]

SALESFORCE_CODE_ANALYZER_APEX: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "sf"
  ]
]
SALESFORCE_CODE_ANALYZER_APEX_CLI_LINT_MODE string

SALESFORCE_CODE_ANALYZER_APEX: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
SALESFORCE_CODE_ANALYZER_APEX_COMMAND_REMOVE_ARGUMENTS array | string

SALESFORCE_CODE_ANALYZER_APEX: User custom arguments to remove before calling linter

SALESFORCE_CODE_ANALYZER_APEX_CONFIG_FILE string

SALESFORCE_CODE_ANALYZER_APEX: User custom config file name if different from default

Default: "code-analyzer.yml"
SALESFORCE_CODE_ANALYZER_APEX_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: "force-app"
SALESFORCE_CODE_ANALYZER_APEX_DISABLE_ERRORS boolean

SALESFORCE_CODE_ANALYZER_APEX: If true, SALESFORCE_CODE_ANALYZER_APEX doesn't make MegaLinter fail even if errors are found

Default: false
SALESFORCE_CODE_ANALYZER_APEX_DISABLE_ERRORS_IF_LESS_THAN number

SALESFORCE_CODE_ANALYZER_APEX: If the number of errors found is less than this value, SALESFORCE_CODE_ANALYZER_APEX doesn't make MegaLinter fail

Default: 0
SALESFORCE_CODE_ANALYZER_APEX_POST_COMMANDS command_info[]

SALESFORCE_CODE_ANALYZER_APEX: Define bash commands to run after running SALESFORCE_CODE_ANALYZER_APEX

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_CODE_ANALYZER_APEX_PRE_COMMANDS command_info[]

SALESFORCE_CODE_ANALYZER_APEX: Define bash commands to run before running SALESFORCE_CODE_ANALYZER_APEX

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_CODE_ANALYZER_APEX_RULES_PATH string

SALESFORCE_CODE_ANALYZER_APEX: Path where to find linter configuration file

SALESFORCE_CODE_ANALYZER_APEX_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SALESFORCE_CODE_ANALYZER_APEX and its pre/post commands

Default:
[]
SALESFORCE_CODE_ANALYZER_AURA_ARGUMENTS array | string

SALESFORCE_CODE_ANALYZER_AURA: User custom arguments to add in linter CLI call

SALESFORCE_CODE_ANALYZER_AURA_CLI_EXECUTABLE string[]

SALESFORCE_CODE_ANALYZER_AURA: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "sf"
  ]
]
SALESFORCE_CODE_ANALYZER_AURA_CLI_LINT_MODE string

SALESFORCE_CODE_ANALYZER_AURA: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
SALESFORCE_CODE_ANALYZER_AURA_COMMAND_REMOVE_ARGUMENTS array | string

SALESFORCE_CODE_ANALYZER_AURA: User custom arguments to remove before calling linter

SALESFORCE_CODE_ANALYZER_AURA_CONFIG_FILE string

SALESFORCE_CODE_ANALYZER_AURA: User custom config file name if different from default

Default: "code-analyzer.yml"
SALESFORCE_CODE_ANALYZER_AURA_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: "force-app"
SALESFORCE_CODE_ANALYZER_AURA_DISABLE_ERRORS boolean

SALESFORCE_CODE_ANALYZER_AURA: If true, SALESFORCE_CODE_ANALYZER_AURA doesn't make MegaLinter fail even if errors are found

Default: false
SALESFORCE_CODE_ANALYZER_AURA_DISABLE_ERRORS_IF_LESS_THAN number

SALESFORCE_CODE_ANALYZER_AURA: If the number of errors found is less than this value, SALESFORCE_CODE_ANALYZER_AURA doesn't make MegaLinter fail

Default: 0
SALESFORCE_CODE_ANALYZER_AURA_POST_COMMANDS command_info[]

SALESFORCE_CODE_ANALYZER_AURA: Define bash commands to run after running SALESFORCE_CODE_ANALYZER_AURA

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_CODE_ANALYZER_AURA_PRE_COMMANDS command_info[]

SALESFORCE_CODE_ANALYZER_AURA: Define bash commands to run before running SALESFORCE_CODE_ANALYZER_AURA

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_CODE_ANALYZER_AURA_RULES_PATH string

SALESFORCE_CODE_ANALYZER_AURA: Path where to find linter configuration file

SALESFORCE_CODE_ANALYZER_AURA_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SALESFORCE_CODE_ANALYZER_AURA and its pre/post commands

Default:
[]
SALESFORCE_CODE_ANALYZER_LWC_ARGUMENTS array | string

SALESFORCE_CODE_ANALYZER_LWC: User custom arguments to add in linter CLI call

SALESFORCE_CODE_ANALYZER_LWC_CLI_EXECUTABLE string[]

SALESFORCE_CODE_ANALYZER_LWC: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "sf"
  ]
]
SALESFORCE_CODE_ANALYZER_LWC_CLI_LINT_MODE string

SALESFORCE_CODE_ANALYZER_LWC: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
SALESFORCE_CODE_ANALYZER_LWC_COMMAND_REMOVE_ARGUMENTS array | string

SALESFORCE_CODE_ANALYZER_LWC: User custom arguments to remove before calling linter

SALESFORCE_CODE_ANALYZER_LWC_CONFIG_FILE string

SALESFORCE_CODE_ANALYZER_LWC: User custom config file name if different from default

Default: "code-analyzer.yml"
SALESFORCE_CODE_ANALYZER_LWC_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: "force-app"
SALESFORCE_CODE_ANALYZER_LWC_DISABLE_ERRORS boolean

SALESFORCE_CODE_ANALYZER_LWC: If true, SALESFORCE_CODE_ANALYZER_LWC doesn't make MegaLinter fail even if errors are found

Default: false
SALESFORCE_CODE_ANALYZER_LWC_DISABLE_ERRORS_IF_LESS_THAN number

SALESFORCE_CODE_ANALYZER_LWC: If the number of errors found is less than this value, SALESFORCE_CODE_ANALYZER_LWC doesn't make MegaLinter fail

Default: 0
SALESFORCE_CODE_ANALYZER_LWC_POST_COMMANDS command_info[]

SALESFORCE_CODE_ANALYZER_LWC: Define bash commands to run after running SALESFORCE_CODE_ANALYZER_LWC

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_CODE_ANALYZER_LWC_PRE_COMMANDS command_info[]

SALESFORCE_CODE_ANALYZER_LWC: Define bash commands to run before running SALESFORCE_CODE_ANALYZER_LWC

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_CODE_ANALYZER_LWC_RULES_PATH string

SALESFORCE_CODE_ANALYZER_LWC: Path where to find linter configuration file

SALESFORCE_CODE_ANALYZER_LWC_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SALESFORCE_CODE_ANALYZER_LWC and its pre/post commands

Default:
[]
SALESFORCE_DIRECTORY string
Default: "force-app"
SALESFORCE_FILTER_REGEX_EXCLUDE string

SALESFORCE: Custom regex excluding filter: files matching this regex will NOT be linted

SALESFORCE_FILTER_REGEX_INCLUDE string

SALESFORCE: Custom regex including filter: only files matching this regex will be linted

SALESFORCE_LIGHTNING_FLOW_SCANNER_ARGUMENTS array | string

SALESFORCE_LIGHTNING_FLOW_SCANNER: User custom arguments to add in linter CLI call

SALESFORCE_LIGHTNING_FLOW_SCANNER_CLI_EXECUTABLE string[]

SALESFORCE_LIGHTNING_FLOW_SCANNER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "sf"
  ]
]
SALESFORCE_LIGHTNING_FLOW_SCANNER_CLI_LINT_MODE string

SALESFORCE_LIGHTNING_FLOW_SCANNER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
SALESFORCE_LIGHTNING_FLOW_SCANNER_COMMAND_REMOVE_ARGUMENTS array | string

SALESFORCE_LIGHTNING_FLOW_SCANNER: User custom arguments to remove before calling linter

SALESFORCE_LIGHTNING_FLOW_SCANNER_CONFIG_FILE string

SALESFORCE_LIGHTNING_FLOW_SCANNER: User custom config file name if different from default

Default: ".flow-scanner.json"
SALESFORCE_LIGHTNING_FLOW_SCANNER_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: "force-app"
SALESFORCE_LIGHTNING_FLOW_SCANNER_DISABLE_ERRORS boolean

SALESFORCE_LIGHTNING_FLOW_SCANNER: If true, SALESFORCE_LIGHTNING_FLOW_SCANNER doesn't make MegaLinter fail even if errors are found

Default: false
SALESFORCE_LIGHTNING_FLOW_SCANNER_DISABLE_ERRORS_IF_LESS_THAN number

SALESFORCE_LIGHTNING_FLOW_SCANNER: If the number of errors found is less than this value, SALESFORCE_LIGHTNING_FLOW_SCANNER doesn't make MegaLinter fail

Default: 0
SALESFORCE_LIGHTNING_FLOW_SCANNER_POST_COMMANDS command_info[]

SALESFORCE_LIGHTNING_FLOW_SCANNER: Define bash commands to run after running SALESFORCE_LIGHTNING_FLOW_SCANNER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_LIGHTNING_FLOW_SCANNER_PRE_COMMANDS command_info[]

SALESFORCE_LIGHTNING_FLOW_SCANNER: Define bash commands to run before running SALESFORCE_LIGHTNING_FLOW_SCANNER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_LIGHTNING_FLOW_SCANNER_RULES_PATH string

SALESFORCE_LIGHTNING_FLOW_SCANNER: Path where to find linter configuration file

SALESFORCE_LIGHTNING_FLOW_SCANNER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SALESFORCE_LIGHTNING_FLOW_SCANNER and its pre/post commands

Default:
[]
SALESFORCE_POST_COMMANDS command_info[]

SALESFORCE: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_PRE_COMMANDS command_info[]

SALESFORCE: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS array | string

SALESFORCE_SFDX_SCANNER_APEX: User custom arguments to add in linter CLI call

SALESFORCE_SFDX_SCANNER_APEX_CLI_EXECUTABLE string[]

SALESFORCE_SFDX_SCANNER_APEX: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "sf"
  ]
]
SALESFORCE_SFDX_SCANNER_APEX_CLI_LINT_MODE string

SALESFORCE_SFDX_SCANNER_APEX: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
SALESFORCE_SFDX_SCANNER_APEX_COMMAND_REMOVE_ARGUMENTS array | string

SALESFORCE_SFDX_SCANNER_APEX: User custom arguments to remove before calling linter

SALESFORCE_SFDX_SCANNER_APEX_CONFIG_FILE string

SALESFORCE_SFDX_SCANNER_APEX: User custom config file name if different from default

Default: "apex-pmd-ruleset.xml"
SALESFORCE_SFDX_SCANNER_APEX_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: "force-app"
SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS boolean

SALESFORCE_SFDX_SCANNER_APEX: If true, SALESFORCE_SFDX_SCANNER_APEX doesn't make MegaLinter fail even if errors are found

Default: false
SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS_IF_LESS_THAN number

SALESFORCE_SFDX_SCANNER_APEX: If the number of errors found is less than this value, SALESFORCE_SFDX_SCANNER_APEX doesn't make MegaLinter fail

Default: 0
SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS command_info[]

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Define bash commands to run after running SALESFORCE_SFDX_SCANNER_APEX

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS command_info[]

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Define bash commands to run before running SALESFORCE_SFDX_SCANNER_APEX

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_SFDX_SCANNER_APEX_RULES_PATH string

SALESFORCE_SFDX_SCANNER_APEX: Path where to find linter configuration file

SALESFORCE_SFDX_SCANNER_APEX_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SALESFORCE_SFDX_SCANNER_APEX and its pre/post commands

Default:
[]
SALESFORCE_SFDX_SCANNER_ARGUMENTS array | string

SALESFORCE_SFDX_SCANNER: User custom arguments to add in linter CLI call

SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS array | string

SALESFORCE_SFDX_SCANNER_AURA: User custom arguments to add in linter CLI call

SALESFORCE_SFDX_SCANNER_AURA_CLI_EXECUTABLE string[]

SALESFORCE_SFDX_SCANNER_AURA: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "sf"
  ]
]
SALESFORCE_SFDX_SCANNER_AURA_CLI_LINT_MODE string

SALESFORCE_SFDX_SCANNER_AURA: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
SALESFORCE_SFDX_SCANNER_AURA_COMMAND_REMOVE_ARGUMENTS array | string

SALESFORCE_SFDX_SCANNER_AURA: User custom arguments to remove before calling linter

SALESFORCE_SFDX_SCANNER_AURA_CONFIG_FILE string

SALESFORCE_SFDX_SCANNER_AURA: User custom config file name if different from default

Default: "--eslintconfig"
SALESFORCE_SFDX_SCANNER_AURA_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: "force-app"
SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS boolean

SALESFORCE_SFDX_SCANNER_AURA: If true, SALESFORCE_SFDX_SCANNER_AURA doesn't make MegaLinter fail even if errors are found

Default: false
SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS_IF_LESS_THAN number

SALESFORCE_SFDX_SCANNER_AURA: If the number of errors found is less than this value, SALESFORCE_SFDX_SCANNER_AURA doesn't make MegaLinter fail

Default: 0
SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS command_info[]

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Define bash commands to run after running SALESFORCE_SFDX_SCANNER_AURA

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS command_info[]

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Define bash commands to run before running SALESFORCE_SFDX_SCANNER_AURA

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_SFDX_SCANNER_AURA_RULES_PATH string

SALESFORCE_SFDX_SCANNER_AURA: Path where to find linter configuration file

SALESFORCE_SFDX_SCANNER_AURA_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SALESFORCE_SFDX_SCANNER_AURA and its pre/post commands

Default:
[]
SALESFORCE_SFDX_SCANNER_DIRECTORY string
Default: "force-app"
SALESFORCE_SFDX_SCANNER_DISABLE_ERRORS boolean
Default: false
SALESFORCE_SFDX_SCANNER_DISABLE_ERRORS_IF_LESS_THAN number
Default: 0
SALESFORCE_SFDX_SCANNER_FILE_EXTENSIONS string[]
SALESFORCE_SFDX_SCANNER_FILE_NAMES_REGEX string[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SALESFORCE_SFDX_SCANNER_FILTER_REGEX_EXCLUDE string
SALESFORCE_SFDX_SCANNER_FILTER_REGEX_INCLUDE string
SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS array | string

SALESFORCE_SFDX_SCANNER_LWC: User custom arguments to add in linter CLI call

SALESFORCE_SFDX_SCANNER_LWC_CLI_EXECUTABLE string[]

SALESFORCE_SFDX_SCANNER_LWC: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "sf"
  ]
]
SALESFORCE_SFDX_SCANNER_LWC_CLI_LINT_MODE string

SALESFORCE_SFDX_SCANNER_LWC: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
SALESFORCE_SFDX_SCANNER_LWC_COMMAND_REMOVE_ARGUMENTS array | string

SALESFORCE_SFDX_SCANNER_LWC: User custom arguments to remove before calling linter

SALESFORCE_SFDX_SCANNER_LWC_CONFIG_FILE string

SALESFORCE_SFDX_SCANNER_LWC: User custom config file name if different from default

Default: "--eslintconfig"
SALESFORCE_SFDX_SCANNER_LWC_DIRECTORY string

Directory that must be found to activate linter. Use value "any" to always activate

Default: "force-app"
SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS boolean

SALESFORCE_SFDX_SCANNER_LWC: If true, SALESFORCE_SFDX_SCANNER_LWC doesn't make MegaLinter fail even if errors are found

Default: false
SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS_IF_LESS_THAN number

SALESFORCE_SFDX_SCANNER_LWC: If the number of errors found is less than this value, SALESFORCE_SFDX_SCANNER_LWC doesn't make MegaLinter fail

Default: 0
SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS command_info[]

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Define bash commands to run after running SALESFORCE_SFDX_SCANNER_LWC

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS command_info[]

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Define bash commands to run before running SALESFORCE_SFDX_SCANNER_LWC

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SALESFORCE_SFDX_SCANNER_LWC_RULES_PATH string

SALESFORCE_SFDX_SCANNER_LWC: Path where to find linter configuration file

SALESFORCE_SFDX_SCANNER_LWC_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SALESFORCE_SFDX_SCANNER_LWC and its pre/post commands

Default:
[]
SARIF_REPORTER boolean

Generate SARIF reports that can be used to display issues directly in GitHub UI

Default: false
SARIF_REPORTER_FILE_NAME string

Override SARIF output file name

Default: "mega-linter-report.sarif"
SARIF_REPORTER_LINTERS enum_linter_keys[]

If SARIF_REPORTER_LINTERS is set, only the linters in the list will output SARIF

Examples: ["BASH_BASH_SHFMT","JAVASCRIPT_STANDARD"]
SCALA_FILTER_REGEX_EXCLUDE string

SCALA: Custom regex excluding filter: files matching this regex will NOT be linted

SCALA_FILTER_REGEX_INCLUDE string

SCALA: Custom regex including filter: only files matching this regex will be linted

SCALA_POST_COMMANDS command_info[]

SCALA: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SCALA_PRE_COMMANDS command_info[]

SCALA: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
SCALA_SCALAFIX_ARGUMENTS array | string

SCALA_SCALAFIX: User custom arguments to add in linter CLI call

SCALA_SCALAFIX_CLI_EXECUTABLE string[]

SCALA_SCALAFIX: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "scalafix"
  ]
]
SCALA_SCALAFIX_CLI_LINT_MODE string

SCALA_SCALAFIX: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
SCALA_SCALAFIX_COMMAND_REMOVE_ARGUMENTS array | string

SCALA_SCALAFIX: User custom arguments to remove before calling linter

SCALA_SCALAFIX_CONFIG_FILE string

SCALA_SCALAFIX: User custom config file name if different from default

Default: ".scalafix.conf"
SCALA_SCALAFIX_DISABLE_ERRORS boolean

SCALA_SCALAFIX: If true, SCALA_SCALAFIX doesn't make MegaLinter fail even if errors are found

Default: false
SCALA_SCALAFIX_DISABLE_ERRORS_IF_LESS_THAN number

SCALA_SCALAFIX: If the number of errors found is less than this value, SCALA_SCALAFIX doesn't make MegaLinter fail

Default: 0
SCALA_SCALAFIX_FILE_EXTENSIONS string[]

SCALA_SCALAFIX: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".scala"
]
Examples: ".py", ".myext"
SCALA_SCALAFIX_FILE_NAMES_REGEX string[]

SCALA_SCALAFIX: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SCALA_SCALAFIX_FILTER_REGEX_EXCLUDE string

SCALA_SCALAFIX: Custom regex excluding filter: files matching this regex will NOT be linted

SCALA_SCALAFIX_FILTER_REGEX_INCLUDE string

SCALA_SCALAFIX: Custom regex including filter: only files matching this regex will be linted

SCALA_SCALAFIX_POST_COMMANDS command_info[]

SCALA_SCALAFIX: Define bash commands to run after running SCALA_SCALAFIX

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SCALA_SCALAFIX_PRE_COMMANDS command_info[]

SCALA_SCALAFIX: Define bash commands to run before running SCALA_SCALAFIX

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SCALA_SCALAFIX_RULES_PATH string

SCALA_SCALAFIX: Path where to find linter configuration file

SCALA_SCALAFIX_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SCALA_SCALAFIX and its pre/post commands

Default:
[]
SECURED_ENV_VARIABLES string[]

List of additional secured environment variables to hide when calling linters. Can contain string or regex patterns.

Default:
[]
SECURED_ENV_VARIABLES_DEFAULT string[]

List of default secured environment variables that will be hidden when calling linters. Can contain string or regex patterns. This should generally not be overridden, use (additional) SECURED_ENV_VARIABLES instead to add more variables to the list.

Default:
[
  "PAT",
  "GIT_AUTHORIZATION_BEARER",
  "GITLAB_CUSTOM_CERTIFICATE",
  "(USERNAME)",
  "(PASSWORD)",
  "(TOKEN)",
  "(SFDX_CLIENT_ID_.*)",
  "(SFDX_CLIENT_KEY_.*)"
]
SHOW_ELAPSED_TIME boolean

Displays elapsed time for each linter in reports

Default: false
SHOW_SKIPPED_LINTERS boolean

Displays all linters that mega-linter could run but didn't

Default: true
SKIP_CLI_LINT_MODES enum[]

Comma-separated list of cli_lint_modes. To use if you want to skip linters with some CLI lint modes (ex: "file,project"). Available values: file,cli_lint_mode,project

SNAKEMAKE_FILTER_REGEX_EXCLUDE string

SNAKEMAKE: Custom regex excluding filter: files matching this regex will NOT be linted

SNAKEMAKE_FILTER_REGEX_INCLUDE string

SNAKEMAKE: Custom regex including filter: only files matching this regex will be linted

SNAKEMAKE_LINT_ARGUMENTS array | string

SNAKEMAKE_LINT: User custom arguments to add in linter CLI call

SNAKEMAKE_LINT_CLI_EXECUTABLE string[]

SNAKEMAKE_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "snakemake"
  ]
]
SNAKEMAKE_LINT_CLI_LINT_MODE string

SNAKEMAKE_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
SNAKEMAKE_LINT_COMMAND_REMOVE_ARGUMENTS array | string

SNAKEMAKE_LINT: User custom arguments to remove before calling linter

SNAKEMAKE_LINT_DISABLE_ERRORS boolean

SNAKEMAKE_LINT: If true, SNAKEMAKE_LINT doesn't make MegaLinter fail even if errors are found

Default: false
SNAKEMAKE_LINT_DISABLE_ERRORS_IF_LESS_THAN number

SNAKEMAKE_LINT: If the number of errors found is less than this value, SNAKEMAKE_LINT doesn't make MegaLinter fail

Default: 0
SNAKEMAKE_LINT_FILE_EXTENSIONS string[]

SNAKEMAKE_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".smk"
]
Examples: ".py", ".myext"
SNAKEMAKE_LINT_FILE_NAMES_REGEX string[]

SNAKEMAKE_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[
  "Snakefile"
]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SNAKEMAKE_LINT_FILTER_REGEX_EXCLUDE string

SNAKEMAKE_LINT: Custom regex excluding filter: files matching this regex will NOT be linted

SNAKEMAKE_LINT_FILTER_REGEX_INCLUDE string

SNAKEMAKE_LINT: Custom regex including filter: only files matching this regex will be linted

SNAKEMAKE_LINT_POST_COMMANDS command_info[]

SNAKEMAKE_LINT: Define bash commands to run after running SNAKEMAKE_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SNAKEMAKE_LINT_PRE_COMMANDS command_info[]

SNAKEMAKE_LINT: Define bash commands to run before running SNAKEMAKE_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SNAKEMAKE_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SNAKEMAKE_LINT and its pre/post commands

Default:
[]
SNAKEMAKE_POST_COMMANDS command_info[]

SNAKEMAKE: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SNAKEMAKE_PRE_COMMANDS command_info[]

SNAKEMAKE: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
SNAKEMAKE_SNAKEFMT_ARGUMENTS array | string

SNAKEMAKE_SNAKEFMT: User custom arguments to add in linter CLI call

SNAKEMAKE_SNAKEFMT_CLI_EXECUTABLE string[]

SNAKEMAKE_SNAKEFMT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "snakefmt"
  ]
]
SNAKEMAKE_SNAKEFMT_CLI_LINT_MODE string

SNAKEMAKE_SNAKEFMT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
SNAKEMAKE_SNAKEFMT_COMMAND_REMOVE_ARGUMENTS array | string

SNAKEMAKE_SNAKEFMT: User custom arguments to remove before calling linter

SNAKEMAKE_SNAKEFMT_CONFIG_FILE string

SNAKEMAKE_SNAKEFMT: User custom config file name if different from default

Default: ".snakefmt.toml"
SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS boolean

SNAKEMAKE_SNAKEFMT: If true, SNAKEMAKE_SNAKEFMT doesn't make MegaLinter fail even if errors are found

Default: false
SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS_IF_LESS_THAN number

SNAKEMAKE_SNAKEFMT: If the number of errors found is less than this value, SNAKEMAKE_SNAKEFMT doesn't make MegaLinter fail

Default: 0
SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS string[]

SNAKEMAKE_SNAKEFMT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".smk"
]
Examples: ".py", ".myext"
SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX string[]

SNAKEMAKE_SNAKEFMT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[
  "Snakefile"
]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SNAKEMAKE_SNAKEFMT_FILTER_REGEX_EXCLUDE string

SNAKEMAKE_SNAKEFMT: Custom regex excluding filter: files matching this regex will NOT be linted

SNAKEMAKE_SNAKEFMT_FILTER_REGEX_INCLUDE string

SNAKEMAKE_SNAKEFMT: Custom regex including filter: only files matching this regex will be linted

SNAKEMAKE_SNAKEFMT_POST_COMMANDS command_info[]

SNAKEMAKE_SNAKEFMT: Define bash commands to run after running SNAKEMAKE_SNAKEFMT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SNAKEMAKE_SNAKEFMT_PRE_COMMANDS command_info[]

SNAKEMAKE_SNAKEFMT: Define bash commands to run before running SNAKEMAKE_SNAKEFMT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SNAKEMAKE_SNAKEFMT_RULES_PATH string

SNAKEMAKE_SNAKEFMT: Path where to find linter configuration file

SNAKEMAKE_SNAKEFMT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SNAKEMAKE_SNAKEFMT and its pre/post commands

Default:
[]
SPELL_CODESPELL_ARGUMENTS array | string

SPELL_CODESPELL: User custom arguments to add in linter CLI call

SPELL_CODESPELL_CLI_EXECUTABLE string[]

SPELL_CODESPELL: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "codespell"
  ]
]
SPELL_CODESPELL_CLI_LINT_MODE string

SPELL_CODESPELL: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
SPELL_CODESPELL_COMMAND_REMOVE_ARGUMENTS array | string

SPELL_CODESPELL: User custom arguments to remove before calling linter

SPELL_CODESPELL_CONFIG_FILE string

SPELL_CODESPELL: User custom config file name if different from default

Default: ".codespellrc"
SPELL_CODESPELL_DISABLE_ERRORS boolean

SPELL_CODESPELL: If true, SPELL_CODESPELL doesn't make MegaLinter fail even if errors are found

Default: false
SPELL_CODESPELL_DISABLE_ERRORS_IF_LESS_THAN number

SPELL_CODESPELL: If the number of errors found is less than this value, SPELL_CODESPELL doesn't make MegaLinter fail

Default: 0
SPELL_CODESPELL_FILE_EXTENSIONS string[]

SPELL_CODESPELL: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".md",
  ".mdx",
  ".markdown",
  ".html",
  ".htm",
  ".rst",
  ".txt",
  ".json",
  ".jsonc",
  ".json5",
  ".yaml",
  ".yml"
]
Examples: ".py", ".myext"
SPELL_CODESPELL_FILE_NAMES_REGEX string[]

SPELL_CODESPELL: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SPELL_CODESPELL_FILTER_REGEX_EXCLUDE string

SPELL_CODESPELL: Custom regex excluding filter: files matching this regex will NOT be linted

SPELL_CODESPELL_FILTER_REGEX_INCLUDE string

SPELL_CODESPELL: Custom regex including filter: only files matching this regex will be linted

SPELL_CODESPELL_POST_COMMANDS command_info[]

SPELL_CODESPELL: Define bash commands to run after running SPELL_CODESPELL

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SPELL_CODESPELL_PRE_COMMANDS command_info[]

SPELL_CODESPELL: Define bash commands to run before running SPELL_CODESPELL

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SPELL_CODESPELL_RULES_PATH string

SPELL_CODESPELL: Path where to find linter configuration file

SPELL_CODESPELL_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SPELL_CODESPELL and its pre/post commands

Default:
[]
SPELL_CSPELL_ANALYZE_FILE_NAMES boolean

If set to true, MegaLinter will also send file names to cspell for analysis.

Default: false
SPELL_CSPELL_ARGUMENTS array | string

SPELL_CSPELL: User custom arguments to add in linter CLI call

SPELL_CSPELL_CLI_EXECUTABLE string[]

SPELL_CSPELL: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "cspell"
  ]
]
SPELL_CSPELL_CLI_LINT_MODE string

SPELL_CSPELL: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
SPELL_CSPELL_COMMAND_REMOVE_ARGUMENTS array | string

SPELL_CSPELL: User custom arguments to remove before calling linter

SPELL_CSPELL_CONFIG_FILE string

SPELL_CSPELL: User custom config file name if different from default

Default: ".cspell.json"
SPELL_CSPELL_DISABLE_ERRORS boolean

SPELL_CSPELL: If true, SPELL_CSPELL doesn't make MegaLinter fail even if errors are found

Default: false
SPELL_CSPELL_DISABLE_ERRORS_IF_LESS_THAN number

SPELL_CSPELL: If the number of errors found is less than this value, SPELL_CSPELL doesn't make MegaLinter fail

Default: 0
SPELL_CSPELL_FILE_EXTENSIONS string[]

SPELL_CSPELL: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[]
Examples: ".py", ".myext"
SPELL_CSPELL_FILE_NAMES_REGEX string[]

SPELL_CSPELL: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SPELL_CSPELL_FILTER_REGEX_EXCLUDE string

SPELL_CSPELL: Custom regex excluding filter: files matching this regex will NOT be linted

SPELL_CSPELL_FILTER_REGEX_INCLUDE string

SPELL_CSPELL: Custom regex including filter: only files matching this regex will be linted

SPELL_CSPELL_POST_COMMANDS command_info[]

SPELL_CSPELL: Define bash commands to run after running SPELL_CSPELL

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SPELL_CSPELL_PRE_COMMANDS command_info[]

SPELL_CSPELL: Define bash commands to run before running SPELL_CSPELL

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SPELL_CSPELL_RULES_PATH string

SPELL_CSPELL: Path where to find linter configuration file

SPELL_CSPELL_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SPELL_CSPELL and its pre/post commands

Default:
[]
SPELL_FILTER_REGEX_EXCLUDE string

SPELL: Custom regex excluding filter: files matching this regex will NOT be linted

SPELL_FILTER_REGEX_INCLUDE string

SPELL: Custom regex including filter: only files matching this regex will be linted

SPELL_LYCHEE_ARGUMENTS array | string

SPELL_LYCHEE: User custom arguments to add in linter CLI call

SPELL_LYCHEE_CLI_EXECUTABLE string[]

SPELL_LYCHEE: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "lychee"
  ]
]
SPELL_LYCHEE_CLI_LINT_MODE string

SPELL_LYCHEE: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
SPELL_LYCHEE_COMMAND_REMOVE_ARGUMENTS array | string

SPELL_LYCHEE: User custom arguments to remove before calling linter

SPELL_LYCHEE_CONFIG_FILE string

SPELL_LYCHEE: User custom config file name if different from default

Default: "lychee.toml"
SPELL_LYCHEE_DISABLE_ERRORS boolean

SPELL_LYCHEE: If true, SPELL_LYCHEE doesn't make MegaLinter fail even if errors are found

Default: false
SPELL_LYCHEE_DISABLE_ERRORS_IF_LESS_THAN number

SPELL_LYCHEE: If the number of errors found is less than this value, SPELL_LYCHEE doesn't make MegaLinter fail

Default: 0
SPELL_LYCHEE_FILE_EXTENSIONS string[]

SPELL_LYCHEE: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".md",
  ".mdx",
  ".markdown",
  ".html",
  ".htm",
  ".rst",
  ".txt",
  ".json",
  ".jsonc",
  ".json5",
  ".yaml",
  ".yml"
]
Examples: ".py", ".myext"
SPELL_LYCHEE_FILE_NAMES_REGEX string[]

SPELL_LYCHEE: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SPELL_LYCHEE_FILTER_REGEX_EXCLUDE string

SPELL_LYCHEE: Custom regex excluding filter: files matching this regex will NOT be linted

SPELL_LYCHEE_FILTER_REGEX_INCLUDE string

SPELL_LYCHEE: Custom regex including filter: only files matching this regex will be linted

SPELL_LYCHEE_POST_COMMANDS command_info[]

SPELL_LYCHEE: Define bash commands to run after running SPELL_LYCHEE

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SPELL_LYCHEE_PRE_COMMANDS command_info[]

SPELL_LYCHEE: Define bash commands to run before running SPELL_LYCHEE

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SPELL_LYCHEE_RULES_PATH string

SPELL_LYCHEE: Path where to find linter configuration file

SPELL_LYCHEE_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SPELL_LYCHEE and its pre/post commands

Default:
[]
SPELL_MISSPELL_ARGUMENTS array | string

SPELL_MISSPELL: User custom arguments to add in linter CLI call

SPELL_MISSPELL_CLI_EXECUTABLE string[]
Default:
[
  [
    "misspell"
  ]
]
SPELL_MISSPELL_CLI_LINT_MODE string
Default: "list_of_files"
Values: "file" "list_of_files" "project"
SPELL_MISSPELL_DISABLE_ERRORS boolean
Default: false
SPELL_MISSPELL_DISABLE_ERRORS_IF_LESS_THAN number
Default: 0
SPELL_MISSPELL_FILE_EXTENSIONS string[]
SPELL_MISSPELL_FILE_NAMES_REGEX string[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SPELL_MISSPELL_FILTER_REGEX_EXCLUDE string
SPELL_MISSPELL_FILTER_REGEX_INCLUDE string
SPELL_MISSPELL_POST_COMMANDS command_info[]
Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SPELL_MISSPELL_PRE_COMMANDS command_info[]
Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SPELL_POST_COMMANDS command_info[]

SPELL: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SPELL_PRE_COMMANDS command_info[]

SPELL: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
SPELL_PROSELINT_ARGUMENTS array | string

SPELL_PROSELINT: User custom arguments to add in linter CLI call

SPELL_PROSELINT_CLI_EXECUTABLE string[]

SPELL_PROSELINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "proselint"
  ]
]
SPELL_PROSELINT_CLI_LINT_MODE string

SPELL_PROSELINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
SPELL_PROSELINT_COMMAND_REMOVE_ARGUMENTS array | string

SPELL_PROSELINT: User custom arguments to remove before calling linter

SPELL_PROSELINT_CONFIG_FILE string

SPELL_PROSELINT: User custom config file name if different from default

Default: ".proselintrc"
SPELL_PROSELINT_DISABLE_ERRORS boolean

SPELL_PROSELINT: If true, SPELL_PROSELINT doesn't make MegaLinter fail even if errors are found

Default: false
SPELL_PROSELINT_DISABLE_ERRORS_IF_LESS_THAN number

SPELL_PROSELINT: If the number of errors found is less than this value, SPELL_PROSELINT doesn't make MegaLinter fail

Default: 0
SPELL_PROSELINT_FILE_EXTENSIONS string[]

SPELL_PROSELINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".md",
  ".txt"
]
Examples: ".py", ".myext"
SPELL_PROSELINT_FILE_NAMES_REGEX string[]

SPELL_PROSELINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SPELL_PROSELINT_FILTER_REGEX_EXCLUDE string

SPELL_PROSELINT: Custom regex excluding filter: files matching this regex will NOT be linted

SPELL_PROSELINT_FILTER_REGEX_INCLUDE string

SPELL_PROSELINT: Custom regex including filter: only files matching this regex will be linted

SPELL_PROSELINT_POST_COMMANDS command_info[]

SPELL_PROSELINT: Define bash commands to run after running SPELL_PROSELINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SPELL_PROSELINT_PRE_COMMANDS command_info[]

SPELL_PROSELINT: Define bash commands to run before running SPELL_PROSELINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SPELL_PROSELINT_RULES_PATH string

SPELL_PROSELINT: Path where to find linter configuration file

SPELL_PROSELINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SPELL_PROSELINT and its pre/post commands

Default:
[]
SPELL_VALE_ARGUMENTS array | string

SPELL_VALE: User custom arguments to add in linter CLI call

SPELL_VALE_CLI_EXECUTABLE string[]

SPELL_VALE: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "vale"
  ]
]
SPELL_VALE_CLI_LINT_MODE string

SPELL_VALE: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
SPELL_VALE_COMMAND_REMOVE_ARGUMENTS array | string

SPELL_VALE: User custom arguments to remove before calling linter

SPELL_VALE_CONFIG_FILE string

SPELL_VALE: User custom config file name if different from default

Default: ".vale.ini"
SPELL_VALE_DISABLE_ERRORS boolean

SPELL_VALE: If true, SPELL_VALE doesn't make MegaLinter fail even if errors are found

Default: false
SPELL_VALE_DISABLE_ERRORS_IF_LESS_THAN number

SPELL_VALE: If the number of errors found is less than this value, SPELL_VALE doesn't make MegaLinter fail

Default: 0
SPELL_VALE_FILE_EXTENSIONS string[]

SPELL_VALE: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".md",
  ".rst"
]
Examples: ".py", ".myext"
SPELL_VALE_FILE_NAMES_REGEX string[]

SPELL_VALE: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SPELL_VALE_FILTER_REGEX_EXCLUDE string

SPELL_VALE: Custom regex excluding filter: files matching this regex will NOT be linted

SPELL_VALE_FILTER_REGEX_INCLUDE string

SPELL_VALE: Custom regex including filter: only files matching this regex will be linted

SPELL_VALE_POST_COMMANDS command_info[]

SPELL_VALE: Define bash commands to run after running SPELL_VALE

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SPELL_VALE_PRE_COMMANDS command_info[]

SPELL_VALE: Define bash commands to run before running SPELL_VALE

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SPELL_VALE_RULES_PATH string

SPELL_VALE: Path where to find linter configuration file

SPELL_VALE_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SPELL_VALE and its pre/post commands

Default:
[]
SQL_FILTER_REGEX_EXCLUDE string

SQL: Custom regex excluding filter: files matching this regex will NOT be linted

SQL_FILTER_REGEX_INCLUDE string

SQL: Custom regex including filter: only files matching this regex will be linted

SQL_POST_COMMANDS command_info[]

SQL: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SQL_PRE_COMMANDS command_info[]

SQL: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
SQL_SQLFLUFF_ARGUMENTS array | string

SQL_SQLFLUFF: User custom arguments to add in linter CLI call

SQL_SQLFLUFF_CLI_EXECUTABLE string[]

SQL_SQLFLUFF: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "sqlfluff"
  ]
]
SQL_SQLFLUFF_CLI_LINT_MODE string

SQL_SQLFLUFF: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
SQL_SQLFLUFF_COMMAND_REMOVE_ARGUMENTS array | string

SQL_SQLFLUFF: User custom arguments to remove before calling linter

SQL_SQLFLUFF_CONFIG_FILE string

SQL_SQLFLUFF: User custom config file name if different from default

Default: ".sqlfluff"
SQL_SQLFLUFF_DISABLE_ERRORS boolean

SQL_SQLFLUFF: If true, SQL_SQLFLUFF doesn't make MegaLinter fail even if errors are found

Default: false
SQL_SQLFLUFF_DISABLE_ERRORS_IF_LESS_THAN number

SQL_SQLFLUFF: If the number of errors found is less than this value, SQL_SQLFLUFF doesn't make MegaLinter fail

Default: 0
SQL_SQLFLUFF_FILE_EXTENSIONS string[]

SQL_SQLFLUFF: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".sql"
]
Examples: ".py", ".myext"
SQL_SQLFLUFF_FILE_NAMES_REGEX string[]

SQL_SQLFLUFF: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SQL_SQLFLUFF_FILTER_REGEX_EXCLUDE string

SQL_SQLFLUFF: Custom regex excluding filter: files matching this regex will NOT be linted

SQL_SQLFLUFF_FILTER_REGEX_INCLUDE string

SQL_SQLFLUFF: Custom regex including filter: only files matching this regex will be linted

SQL_SQLFLUFF_POST_COMMANDS command_info[]

SQL_SQLFLUFF: Define bash commands to run after running SQL_SQLFLUFF

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SQL_SQLFLUFF_PRE_COMMANDS command_info[]

SQL_SQLFLUFF: Define bash commands to run before running SQL_SQLFLUFF

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SQL_SQLFLUFF_RULES_PATH string

SQL_SQLFLUFF: Path where to find linter configuration file

SQL_SQLFLUFF_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SQL_SQLFLUFF and its pre/post commands

Default:
[]
SQL_SQL_LINT_ARGUMENTS array | string

SQL_SQL_LINT: User custom arguments to add in linter CLI call

SQL_SQL_LINT_CLI_EXECUTABLE string[]
Default:
[
  [
    "sql-lint"
  ]
]
SQL_SQL_LINT_CLI_LINT_MODE string
Default: "file"
Values: "file" "project"
SQL_SQL_LINT_COMMAND_REMOVE_ARGUMENTS array | string

SQL_SQL_LINT: User custom arguments to remove before calling linter

SQL_SQL_LINT_CONFIG_FILE string

SQL_SQL_LINT: User custom config file name if different from default

Default: ".sql-config.json"
SQL_SQL_LINT_DISABLE_ERRORS boolean
Default: false
SQL_SQL_LINT_DISABLE_ERRORS_IF_LESS_THAN number
Default: 0
SQL_SQL_LINT_FILE_EXTENSIONS string[]
SQL_SQL_LINT_FILE_NAME string

SQL_SQL_LINT: User custom config file name if different from default

Default: ".sql-config.json"
SQL_SQL_LINT_FILE_NAMES_REGEX string[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SQL_SQL_LINT_FILTER_REGEX_EXCLUDE string
SQL_SQL_LINT_FILTER_REGEX_INCLUDE string
SQL_SQL_LINT_POST_COMMANDS command_info[]
Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SQL_SQL_LINT_PRE_COMMANDS command_info[]
Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SQL_SQL_LINT_RULES_PATH string

SQL_SQL_LINT: Path where to find linter configuration file

SQL_SQL_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SQL_SQL_LINT and its pre/post commands

Default:
[]
SQL_TSQLLINT_ARGUMENTS array | string

SQL_TSQLLINT: User custom arguments to add in linter CLI call

SQL_TSQLLINT_CLI_EXECUTABLE string[]

SQL_TSQLLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "tsqllint"
  ]
]
SQL_TSQLLINT_CLI_LINT_MODE string

SQL_TSQLLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
SQL_TSQLLINT_COMMAND_REMOVE_ARGUMENTS array | string

SQL_TSQLLINT: User custom arguments to remove before calling linter

SQL_TSQLLINT_CONFIG_FILE string

SQL_TSQLLINT: User custom config file name if different from default

Default: ".tsqllintrc"
SQL_TSQLLINT_DISABLE_ERRORS boolean

SQL_TSQLLINT: If true, SQL_TSQLLINT doesn't make MegaLinter fail even if errors are found

Default: false
SQL_TSQLLINT_DISABLE_ERRORS_IF_LESS_THAN number

SQL_TSQLLINT: If the number of errors found is less than this value, SQL_TSQLLINT doesn't make MegaLinter fail

Default: 0
SQL_TSQLLINT_FILE_EXTENSIONS string[]

SQL_TSQLLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".sql"
]
Examples: ".py", ".myext"
SQL_TSQLLINT_FILE_NAMES_REGEX string[]

SQL_TSQLLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SQL_TSQLLINT_FILTER_REGEX_EXCLUDE string

SQL_TSQLLINT: Custom regex excluding filter: files matching this regex will NOT be linted

SQL_TSQLLINT_FILTER_REGEX_INCLUDE string

SQL_TSQLLINT: Custom regex including filter: only files matching this regex will be linted

SQL_TSQLLINT_POST_COMMANDS command_info[]

SQL_TSQLLINT: Define bash commands to run after running SQL_TSQLLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SQL_TSQLLINT_PRE_COMMANDS command_info[]

SQL_TSQLLINT: Define bash commands to run before running SQL_TSQLLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SQL_TSQLLINT_RULES_PATH string

SQL_TSQLLINT: Path where to find linter configuration file

SQL_TSQLLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SQL_TSQLLINT and its pre/post commands

Default:
[]
SWIFT_FILTER_REGEX_EXCLUDE string

SWIFT: Custom regex excluding filter: files matching this regex will NOT be linted

SWIFT_FILTER_REGEX_INCLUDE string

SWIFT: Custom regex including filter: only files matching this regex will be linted

SWIFT_POST_COMMANDS command_info[]

SWIFT: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SWIFT_PRE_COMMANDS command_info[]

SWIFT: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
SWIFT_SWIFTLINT_ARGUMENTS array | string

SWIFT_SWIFTLINT: User custom arguments to add in linter CLI call

SWIFT_SWIFTLINT_CLI_EXECUTABLE string[]

SWIFT_SWIFTLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "swiftlint"
  ]
]
SWIFT_SWIFTLINT_CLI_LINT_MODE string

SWIFT_SWIFTLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
SWIFT_SWIFTLINT_COMMAND_REMOVE_ARGUMENTS array | string

SWIFT_SWIFTLINT: User custom arguments to remove before calling linter

SWIFT_SWIFTLINT_CONFIG_FILE string

SWIFT_SWIFTLINT: User custom config file name if different from default

Default: ".swiftlint.yml"
SWIFT_SWIFTLINT_DISABLE_ERRORS boolean

SWIFT_SWIFTLINT: If true, SWIFT_SWIFTLINT doesn't make MegaLinter fail even if errors are found

Default: false
SWIFT_SWIFTLINT_DISABLE_ERRORS_IF_LESS_THAN number

SWIFT_SWIFTLINT: If the number of errors found is less than this value, SWIFT_SWIFTLINT doesn't make MegaLinter fail

Default: 0
SWIFT_SWIFTLINT_FILE_EXTENSIONS string[]

SWIFT_SWIFTLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".swift"
]
Examples: ".py", ".myext"
SWIFT_SWIFTLINT_FILE_NAMES_REGEX string[]

SWIFT_SWIFTLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
SWIFT_SWIFTLINT_POST_COMMANDS command_info[]

SWIFT_SWIFTLINT: Define bash commands to run after running SWIFT_SWIFTLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
SWIFT_SWIFTLINT_PRE_COMMANDS command_info[]

SWIFT_SWIFTLINT: Define bash commands to run before running SWIFT_SWIFTLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
SWIFT_SWIFTLINT_RULES_PATH string

SWIFT_SWIFTLINT: Path where to find linter configuration file

SWIFT_SWIFTLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling SWIFT_SWIFTLINT and its pre/post commands

Default:
[]
TAP_REPORTER boolean

General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter

Default: false
TAP_REPORTER_SUB_FOLDER string

Sub-folder of reports folder containing TAP logs

Default: "tap"
TEKTON_FILTER_REGEX_EXCLUDE string

TEKTON: Custom regex excluding filter: files matching this regex will NOT be linted

TEKTON_FILTER_REGEX_INCLUDE string

TEKTON: Custom regex including filter: only files matching this regex will be linted

TEKTON_POST_COMMANDS command_info[]

TEKTON: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TEKTON_PRE_COMMANDS command_info[]

TEKTON: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
TEKTON_TEKTON_LINT_ARGUMENTS array | string

TEKTON_TEKTON_LINT: User custom arguments to add in linter CLI call

TEKTON_TEKTON_LINT_CLI_EXECUTABLE string[]

TEKTON_TEKTON_LINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "tekton-lint"
  ]
]
TEKTON_TEKTON_LINT_CLI_LINT_MODE string

TEKTON_TEKTON_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
TEKTON_TEKTON_LINT_COMMAND_REMOVE_ARGUMENTS array | string

TEKTON_TEKTON_LINT: User custom arguments to remove before calling linter

TEKTON_TEKTON_LINT_CONFIG_FILE string

TEKTON_TEKTON_LINT: User custom config file name if different from default

Default: ".tektonlintrc.yaml"
TEKTON_TEKTON_LINT_DISABLE_ERRORS boolean

TEKTON_TEKTON_LINT: If true, TEKTON_TEKTON_LINT doesn't make MegaLinter fail even if errors are found

Default: false
TEKTON_TEKTON_LINT_DISABLE_ERRORS_IF_LESS_THAN number

TEKTON_TEKTON_LINT: If the number of errors found is less than this value, TEKTON_TEKTON_LINT doesn't make MegaLinter fail

Default: 0
TEKTON_TEKTON_LINT_FILE_EXTENSIONS string[]

TEKTON_TEKTON_LINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".yml",
  ".yaml"
]
Examples: ".py", ".myext"
TEKTON_TEKTON_LINT_FILE_NAMES_REGEX string[]

TEKTON_TEKTON_LINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
TEKTON_TEKTON_LINT_FILTER_REGEX_EXCLUDE string

TEKTON_TEKTON_LINT: Custom regex excluding filter: files matching this regex will NOT be linted

TEKTON_TEKTON_LINT_FILTER_REGEX_INCLUDE string

TEKTON_TEKTON_LINT: Custom regex including filter: only files matching this regex will be linted

TEKTON_TEKTON_LINT_POST_COMMANDS command_info[]

TEKTON_TEKTON_LINT: Define bash commands to run after running TEKTON_TEKTON_LINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TEKTON_TEKTON_LINT_PRE_COMMANDS command_info[]

TEKTON_TEKTON_LINT: Define bash commands to run before running TEKTON_TEKTON_LINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
TEKTON_TEKTON_LINT_RULES_PATH string

TEKTON_TEKTON_LINT: Path where to find linter configuration file

TEKTON_TEKTON_LINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling TEKTON_TEKTON_LINT and its pre/post commands

Default:
[]
TERRAFORM_CHECKOV_ARGUMENTS array | string

TERRAFORM_CHECKOV: User custom arguments to add in linter CLI call

TERRAFORM_CHECKOV_CLI_EXECUTABLE string[]
Default:
[
  [
    "checkov"
  ]
]
TERRAFORM_CHECKOV_CLI_LINT_MODE string
Default: "file"
Values: "file" "project"
TERRAFORM_CHECKOV_DISABLE_ERRORS boolean
Default: false
TERRAFORM_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN number
Default: 0
TERRAFORM_CHECKOV_FILE_EXTENSIONS string[]
TERRAFORM_CHECKOV_FILE_NAMES_REGEX string[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
TERRAFORM_CHECKOV_FILTER_REGEX_EXCLUDE string
TERRAFORM_CHECKOV_FILTER_REGEX_INCLUDE string
TERRAFORM_CHECKOV_POST_COMMANDS command_info[]
Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_CHECKOV_PRE_COMMANDS command_info[]
Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_FILTER_REGEX_EXCLUDE string

TERRAFORM: Custom regex excluding filter: files matching this regex will NOT be linted

TERRAFORM_FILTER_REGEX_INCLUDE string

TERRAFORM: Custom regex including filter: only files matching this regex will be linted

TERRAFORM_KICS_ARGUMENTS array | string

TERRAFORM_KICS: User custom arguments to add in linter CLI call

TERRAFORM_KICS_CLI_EXECUTABLE string[]
Default:
[
  [
    "kics"
  ]
]
TERRAFORM_KICS_CLI_LINT_MODE string
Default: "file"
Values: "file" "project"
TERRAFORM_KICS_DISABLE_ERRORS boolean
Default: false
TERRAFORM_KICS_DISABLE_ERRORS_IF_LESS_THAN number
Default: 0
TERRAFORM_KICS_FILE_EXTENSIONS string[]
TERRAFORM_KICS_FILE_NAMES_REGEX string[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
TERRAFORM_KICS_FILTER_REGEX_EXCLUDE string
TERRAFORM_KICS_FILTER_REGEX_INCLUDE string
TERRAFORM_KICS_POST_COMMANDS command_info[]
Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_KICS_PRE_COMMANDS command_info[]
Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_POST_COMMANDS command_info[]

TERRAFORM: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_PRE_COMMANDS command_info[]

TERRAFORM: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_TERRAFORM_FMT_ARGUMENTS array | string

TERRAFORM_TERRAFORM_FMT: User custom arguments to add in linter CLI call

TERRAFORM_TERRAFORM_FMT_CLI_EXECUTABLE string[]

TERRAFORM_TERRAFORM_FMT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "terraform"
  ]
]
TERRAFORM_TERRAFORM_FMT_CLI_LINT_MODE string

TERRAFORM_TERRAFORM_FMT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
TERRAFORM_TERRAFORM_FMT_COMMAND_REMOVE_ARGUMENTS array | string

TERRAFORM_TERRAFORM_FMT: User custom arguments to remove before calling linter

TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS boolean

TERRAFORM_TERRAFORM_FMT: If true, TERRAFORM_TERRAFORM_FMT doesn't make MegaLinter fail even if errors are found

Default: false
TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS_IF_LESS_THAN number

TERRAFORM_TERRAFORM_FMT: If the number of errors found is less than this value, TERRAFORM_TERRAFORM_FMT doesn't make MegaLinter fail

Default: 0
TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS string[]

TERRAFORM_TERRAFORM_FMT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".tf"
]
Examples: ".py", ".myext"
TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX string[]

TERRAFORM_TERRAFORM_FMT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_EXCLUDE string

TERRAFORM_TERRAFORM_FMT: Custom regex excluding filter: files matching this regex will NOT be linted

TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_INCLUDE string

TERRAFORM_TERRAFORM_FMT: Custom regex including filter: only files matching this regex will be linted

TERRAFORM_TERRAFORM_FMT_POST_COMMANDS command_info[]

TERRAFORM_TERRAFORM_FMT: Define bash commands to run after running TERRAFORM_TERRAFORM_FMT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS command_info[]

TERRAFORM_TERRAFORM_FMT: Define bash commands to run before running TERRAFORM_TERRAFORM_FMT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_TERRAFORM_FMT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling TERRAFORM_TERRAFORM_FMT and its pre/post commands

Default:
[]
TERRAFORM_TERRAGRUNT_ARGUMENTS array | string

TERRAFORM_TERRAGRUNT: User custom arguments to add in linter CLI call

TERRAFORM_TERRAGRUNT_CLI_EXECUTABLE string[]

TERRAFORM_TERRAGRUNT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "terragrunt"
  ]
]
TERRAFORM_TERRAGRUNT_CLI_LINT_MODE string

TERRAFORM_TERRAGRUNT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "file"
Values: "file" "project"
TERRAFORM_TERRAGRUNT_COMMAND_REMOVE_ARGUMENTS array | string

TERRAFORM_TERRAGRUNT: User custom arguments to remove before calling linter

TERRAFORM_TERRAGRUNT_CONFIG_FILE string

TERRAFORM_TERRAGRUNT: User custom config file name if different from default

Default: "terragrunt.hcl"
TERRAFORM_TERRAGRUNT_DISABLE_ERRORS boolean

TERRAFORM_TERRAGRUNT: If true, TERRAFORM_TERRAGRUNT doesn't make MegaLinter fail even if errors are found

Default: false
TERRAFORM_TERRAGRUNT_DISABLE_ERRORS_IF_LESS_THAN number

TERRAFORM_TERRAGRUNT: If the number of errors found is less than this value, TERRAFORM_TERRAGRUNT doesn't make MegaLinter fail

Default: 0
TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS string[]

TERRAFORM_TERRAGRUNT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".hcl"
]
Examples: ".py", ".myext"
TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX string[]

TERRAFORM_TERRAGRUNT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
TERRAFORM_TERRAGRUNT_FILTER_REGEX_EXCLUDE string

TERRAFORM_TERRAGRUNT: Custom regex excluding filter: files matching this regex will NOT be linted

TERRAFORM_TERRAGRUNT_FILTER_REGEX_INCLUDE string

TERRAFORM_TERRAGRUNT: Custom regex including filter: only files matching this regex will be linted

TERRAFORM_TERRAGRUNT_POST_COMMANDS command_info[]

TERRAFORM_TERRAGRUNT: Define bash commands to run after running TERRAFORM_TERRAGRUNT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_TERRAGRUNT_PRE_COMMANDS command_info[]

TERRAFORM_TERRAGRUNT: Define bash commands to run before running TERRAFORM_TERRAGRUNT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_TERRAGRUNT_RULES_PATH string

TERRAFORM_TERRAGRUNT: Path where to find linter configuration file

TERRAFORM_TERRAGRUNT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling TERRAFORM_TERRAGRUNT and its pre/post commands

Default:
[]
TERRAFORM_TERRASCAN_ARGUMENTS array | string

TERRAFORM_TERRASCAN: User custom arguments to add in linter CLI call

TERRAFORM_TERRASCAN_CLI_EXECUTABLE string[]

TERRAFORM_TERRASCAN: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "terrascan"
  ]
]
TERRAFORM_TERRASCAN_CLI_LINT_MODE string

TERRAFORM_TERRASCAN: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
TERRAFORM_TERRASCAN_COMMAND_REMOVE_ARGUMENTS array | string

TERRAFORM_TERRASCAN: User custom arguments to remove before calling linter

TERRAFORM_TERRASCAN_CONFIG_FILE string

TERRAFORM_TERRASCAN: User custom config file name if different from default

Default: "terrascan.toml"
TERRAFORM_TERRASCAN_DISABLE_ERRORS boolean

TERRAFORM_TERRASCAN: If true, TERRAFORM_TERRASCAN doesn't make MegaLinter fail even if errors are found

Default: false
TERRAFORM_TERRASCAN_DISABLE_ERRORS_IF_LESS_THAN number

TERRAFORM_TERRASCAN: If the number of errors found is less than this value, TERRAFORM_TERRASCAN doesn't make MegaLinter fail

Default: 0
TERRAFORM_TERRASCAN_FILE_EXTENSIONS string[]

TERRAFORM_TERRASCAN: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".tf"
]
Examples: ".py", ".myext"
TERRAFORM_TERRASCAN_FILE_NAMES_REGEX string[]

TERRAFORM_TERRASCAN: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
TERRAFORM_TERRASCAN_POST_COMMANDS command_info[]

(deprecated) TERRAFORM_TERRASCAN: Define bash commands to run after running TERRAFORM_TERRASCAN

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_TERRASCAN_PRE_COMMANDS command_info[]

(deprecated) TERRAFORM_TERRASCAN: Define bash commands to run before running TERRAFORM_TERRASCAN

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_TERRASCAN_RULES_PATH string

TERRAFORM_TERRASCAN: Path where to find linter configuration file

TERRAFORM_TERRASCAN_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling TERRAFORM_TERRASCAN and its pre/post commands

Default:
[]
TERRAFORM_TFLINT_ARGUMENTS array | string

TERRAFORM_TFLINT: User custom arguments to add in linter CLI call

TERRAFORM_TFLINT_CLI_EXECUTABLE string[]

TERRAFORM_TFLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "tflint"
  ]
]
TERRAFORM_TFLINT_CLI_LINT_MODE string

TERRAFORM_TFLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
TERRAFORM_TFLINT_COMMAND_REMOVE_ARGUMENTS array | string

TERRAFORM_TFLINT: User custom arguments to remove before calling linter

TERRAFORM_TFLINT_CONFIG_FILE string

TERRAFORM_TFLINT: User custom config file name if different from default

Default: ".tflint.hcl"
TERRAFORM_TFLINT_DISABLE_ERRORS boolean

TERRAFORM_TFLINT: If true, TERRAFORM_TFLINT doesn't make MegaLinter fail even if errors are found

Default: false
TERRAFORM_TFLINT_DISABLE_ERRORS_IF_LESS_THAN number

TERRAFORM_TFLINT: If the number of errors found is less than this value, TERRAFORM_TFLINT doesn't make MegaLinter fail

Default: 0
TERRAFORM_TFLINT_FILE_EXTENSIONS string[]

TERRAFORM_TFLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".tf"
]
Examples: ".py", ".myext"
TERRAFORM_TFLINT_FILE_NAMES_REGEX string[]

TERRAFORM_TFLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
TERRAFORM_TFLINT_POST_COMMANDS command_info[]

TERRAFORM_TFLINT: Define bash commands to run after running TERRAFORM_TFLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_TFLINT_PRE_COMMANDS command_info[]

TERRAFORM_TFLINT: Define bash commands to run before running TERRAFORM_TFLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
TERRAFORM_TFLINT_RULES_PATH string

TERRAFORM_TFLINT: Path where to find linter configuration file

TERRAFORM_TFLINT_SECURED_ENV boolean

TERRAFORM_TFLINT: Allows to send the full env to tflint --init. Initialized with default value true. Set to false to allow tflint --init to access your env vars.

Default: true
TERRAFORM_TFLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling TERRAFORM_TFLINT and its pre/post commands

Default:
[]
TEXT_REPORTER boolean

General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter

Default: true
TEXT_REPORTER_SUB_FOLDER string

Sub-folder of reports folder containing text logs

Default: "linters_logs"
TSX_ESLINT_ARGUMENTS array | string

TSX_ESLINT: User custom arguments to add in linter CLI call

TSX_ESLINT_CLI_EXECUTABLE string[]

TSX_ESLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "eslint"
  ]
]
TSX_ESLINT_CLI_LINT_MODE string

TSX_ESLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
TSX_ESLINT_COMMAND_REMOVE_ARGUMENTS array | string

TSX_ESLINT: User custom arguments to remove before calling linter

TSX_ESLINT_CONFIG_FILE string

TSX_ESLINT: User custom config file name if different from default

Default: ".eslintrc.json"
TSX_ESLINT_DISABLE_ERRORS boolean

TSX_ESLINT: If true, TSX_ESLINT doesn't make MegaLinter fail even if errors are found

Default: false
TSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN number

TSX_ESLINT: If the number of errors found is less than this value, TSX_ESLINT doesn't make MegaLinter fail

Default: 0
TSX_ESLINT_FILE_EXTENSIONS string[]

TSX_ESLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".tsx"
]
Examples: ".py", ".myext"
TSX_ESLINT_FILE_NAMES_REGEX string[]

TSX_ESLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
TSX_ESLINT_FILTER_REGEX_EXCLUDE string

TSX_ESLINT: Custom regex excluding filter: files matching this regex will NOT be linted

TSX_ESLINT_FILTER_REGEX_INCLUDE string

TSX_ESLINT: Custom regex including filter: only files matching this regex will be linted

TSX_ESLINT_POST_COMMANDS command_info[]

TSX_ESLINT: Define bash commands to run after running TSX_ESLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TSX_ESLINT_PRE_COMMANDS command_info[]

TSX_ESLINT: Define bash commands to run before running TSX_ESLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
TSX_ESLINT_RULES_PATH string

TSX_ESLINT: Path where to find linter configuration file

TSX_ESLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling TSX_ESLINT and its pre/post commands

Default:
[]
TSX_FILTER_REGEX_EXCLUDE string

TSX: Custom regex excluding filter: files matching this regex will NOT be linted

TSX_FILTER_REGEX_INCLUDE string

TSX: Custom regex including filter: only files matching this regex will be linted

TSX_POST_COMMANDS command_info[]

TSX: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TSX_PRE_COMMANDS command_info[]

TSX: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
TYPESCRIPT_DEFAULT_STYLE string

Style of typescript formatting to apply

Default: "prettier"
Values: "standard" "prettier"
Examples: "standard", "prettier"
TYPESCRIPT_ES_ARGUMENTS array | string

TYPESCRIPT_ES: User custom arguments to add in linter CLI call

TYPESCRIPT_ES_CLI_EXECUTABLE string[]

TYPESCRIPT_ES: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "eslint"
  ]
]
TYPESCRIPT_ES_CLI_LINT_MODE string

TYPESCRIPT_ES: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
TYPESCRIPT_ES_COMMAND_REMOVE_ARGUMENTS array | string

TYPESCRIPT_ES: User custom arguments to remove before calling linter

TYPESCRIPT_ES_CONFIG_FILE string

TYPESCRIPT_ES: User custom config file name if different from default

Default: ".eslintrc.json"
TYPESCRIPT_ES_DISABLE_ERRORS boolean

TYPESCRIPT_ES: If true, TYPESCRIPT_ES doesn't make MegaLinter fail even if errors are found

Default: false
TYPESCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN number

TYPESCRIPT_ES: If the number of errors found is less than this value, TYPESCRIPT_ES doesn't make MegaLinter fail

Default: 0
TYPESCRIPT_ES_FILE_EXTENSIONS string[]

TYPESCRIPT_ES: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".ts"
]
Examples: ".py", ".myext"
TYPESCRIPT_ES_FILE_NAMES_REGEX string[]

TYPESCRIPT_ES: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
TYPESCRIPT_ES_FILTER_REGEX_EXCLUDE string

TYPESCRIPT_ES: Custom regex excluding filter: files matching this regex will NOT be linted

TYPESCRIPT_ES_FILTER_REGEX_INCLUDE string

TYPESCRIPT_ES: Custom regex including filter: only files matching this regex will be linted

TYPESCRIPT_ES_POST_COMMANDS command_info[]

TYPESCRIPT_ES: Define bash commands to run after running TYPESCRIPT_ES

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TYPESCRIPT_ES_PRE_COMMANDS command_info[]

TYPESCRIPT_ES: Define bash commands to run before running TYPESCRIPT_ES

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
TYPESCRIPT_ES_RULES_PATH string

TYPESCRIPT_ES: Path where to find linter configuration file

TYPESCRIPT_ES_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling TYPESCRIPT_ES and its pre/post commands

Default:
[]
TYPESCRIPT_FILTER_REGEX_EXCLUDE string

TYPESCRIPT: Custom regex excluding filter: files matching this regex will NOT be linted

TYPESCRIPT_FILTER_REGEX_INCLUDE string

TYPESCRIPT: Custom regex including filter: only files matching this regex will be linted

TYPESCRIPT_POST_COMMANDS command_info[]

TYPESCRIPT: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TYPESCRIPT_PRETTIER_ARGUMENTS array | string

TYPESCRIPT_PRETTIER: User custom arguments to add in linter CLI call

TYPESCRIPT_PRETTIER_CLI_EXECUTABLE string[]

TYPESCRIPT_PRETTIER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "prettier"
  ]
]
TYPESCRIPT_PRETTIER_CLI_LINT_MODE string

TYPESCRIPT_PRETTIER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
TYPESCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS array | string

TYPESCRIPT_PRETTIER: User custom arguments to remove before calling linter

TYPESCRIPT_PRETTIER_CONFIG_FILE string

TYPESCRIPT_PRETTIER: User custom config file name if different from default

Default: ".prettierrc.json"
TYPESCRIPT_PRETTIER_DISABLE_ERRORS boolean

TYPESCRIPT_PRETTIER: If true, TYPESCRIPT_PRETTIER doesn't make MegaLinter fail even if errors are found

Default: false
TYPESCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN number

TYPESCRIPT_PRETTIER: If the number of errors found is less than this value, TYPESCRIPT_PRETTIER doesn't make MegaLinter fail

Default: 0
TYPESCRIPT_PRETTIER_FILE_EXTENSIONS string[]

TYPESCRIPT_PRETTIER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".ts"
]
Examples: ".py", ".myext"
TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX string[]

TYPESCRIPT_PRETTIER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
TYPESCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE string

TYPESCRIPT_PRETTIER: Custom regex excluding filter: files matching this regex will NOT be linted

TYPESCRIPT_PRETTIER_FILTER_REGEX_INCLUDE string

TYPESCRIPT_PRETTIER: Custom regex including filter: only files matching this regex will be linted

TYPESCRIPT_PRETTIER_POST_COMMANDS command_info[]

TYPESCRIPT_PRETTIER: Define bash commands to run after running TYPESCRIPT_PRETTIER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TYPESCRIPT_PRETTIER_PRE_COMMANDS command_info[]

TYPESCRIPT_PRETTIER: Define bash commands to run before running TYPESCRIPT_PRETTIER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
TYPESCRIPT_PRETTIER_RULES_PATH string

TYPESCRIPT_PRETTIER: Path where to find linter configuration file

TYPESCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling TYPESCRIPT_PRETTIER and its pre/post commands

Default:
[]
TYPESCRIPT_PRE_COMMANDS command_info[]

TYPESCRIPT: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
TYPESCRIPT_STANDARD_ARGUMENTS array | string

TYPESCRIPT_STANDARD: User custom arguments to add in linter CLI call

TYPESCRIPT_STANDARD_CLI_EXECUTABLE string[]

TYPESCRIPT_STANDARD: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "ts-standard"
  ]
]
TYPESCRIPT_STANDARD_CLI_LINT_MODE string

TYPESCRIPT_STANDARD: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
TYPESCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS array | string

TYPESCRIPT_STANDARD: User custom arguments to remove before calling linter

TYPESCRIPT_STANDARD_DISABLE_ERRORS boolean

TYPESCRIPT_STANDARD: If true, TYPESCRIPT_STANDARD doesn't make MegaLinter fail even if errors are found

Default: false
TYPESCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN number

TYPESCRIPT_STANDARD: If the number of errors found is less than this value, TYPESCRIPT_STANDARD doesn't make MegaLinter fail

Default: 0
TYPESCRIPT_STANDARD_FILE_EXTENSIONS string[]

TYPESCRIPT_STANDARD: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".ts"
]
Examples: ".py", ".myext"
TYPESCRIPT_STANDARD_FILE_NAMES_REGEX string[]

TYPESCRIPT_STANDARD: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
TYPESCRIPT_STANDARD_FILTER_REGEX_EXCLUDE string

TYPESCRIPT_STANDARD: Custom regex excluding filter: files matching this regex will NOT be linted

TYPESCRIPT_STANDARD_FILTER_REGEX_INCLUDE string

TYPESCRIPT_STANDARD: Custom regex including filter: only files matching this regex will be linted

TYPESCRIPT_STANDARD_POST_COMMANDS command_info[]

TYPESCRIPT_STANDARD: Define bash commands to run after running TYPESCRIPT_STANDARD

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
TYPESCRIPT_STANDARD_PRE_COMMANDS command_info[]

TYPESCRIPT_STANDARD: Define bash commands to run before running TYPESCRIPT_STANDARD

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
TYPESCRIPT_STANDARD_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling TYPESCRIPT_STANDARD and its pre/post commands

Default:
[]
UPDATED_SOURCES_REPORTER boolean
UPDATED_SOURCES_REPORTER_DIR string
VALIDATE_ALL_CODEBASE boolean

Will parse the entire repository and find all files to validate across all types. When set to false, only new or edited files will be parsed for validation.

Default: true
VBDOTNET_DOTNET_FORMAT_ARGUMENTS array | string

VBDOTNET_DOTNET_FORMAT: User custom arguments to add in linter CLI call

VBDOTNET_DOTNET_FORMAT_CLI_EXECUTABLE string[]

VBDOTNET_DOTNET_FORMAT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "dotnet"
  ]
]
VBDOTNET_DOTNET_FORMAT_CLI_LINT_MODE string

VBDOTNET_DOTNET_FORMAT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "project"
Values: "file" "list_of_files" "project"
VBDOTNET_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS array | string

VBDOTNET_DOTNET_FORMAT: User custom arguments to remove before calling linter

VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS boolean

VBDOTNET_DOTNET_FORMAT: If true, VBDOTNET_DOTNET_FORMAT doesn't make MegaLinter fail even if errors are found

Default: false
VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN number

VBDOTNET_DOTNET_FORMAT: If the number of errors found is less than this value, VBDOTNET_DOTNET_FORMAT doesn't make MegaLinter fail

Default: 0
VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS string[]

VBDOTNET_DOTNET_FORMAT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".vb"
]
Examples: ".py", ".myext"
VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX string[]

VBDOTNET_DOTNET_FORMAT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
VBDOTNET_DOTNET_FORMAT_POST_COMMANDS command_info[]

VBDOTNET_DOTNET_FORMAT: Define bash commands to run after running VBDOTNET_DOTNET_FORMAT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS command_info[]

VBDOTNET_DOTNET_FORMAT: Define bash commands to run before running VBDOTNET_DOTNET_FORMAT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
VBDOTNET_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling VBDOTNET_DOTNET_FORMAT and its pre/post commands

Default:
[]
VBDOTNET_FILTER_REGEX_EXCLUDE string

VBDOTNET: Custom regex excluding filter: files matching this regex will NOT be linted

VBDOTNET_FILTER_REGEX_INCLUDE string

VBDOTNET: Custom regex including filter: only files matching this regex will be linted

VBDOTNET_POST_COMMANDS command_info[]

VBDOTNET: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
VBDOTNET_PRE_COMMANDS command_info[]

VBDOTNET: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
XML_FILTER_REGEX_EXCLUDE string

XML: Custom regex excluding filter: files matching this regex will NOT be linted

XML_FILTER_REGEX_INCLUDE string

XML: Custom regex including filter: only files matching this regex will be linted

XML_POST_COMMANDS command_info[]

XML: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
XML_PRE_COMMANDS command_info[]

XML: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
XML_XMLLINT_ARGUMENTS array | string

XML_XMLLINT: User custom arguments to add in linter CLI call

XML_XMLLINT_AUTOFORMAT boolean
Default: false
XML_XMLLINT_CLI_EXECUTABLE string[]

XML_XMLLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "xmllint"
  ]
]
XML_XMLLINT_CLI_LINT_MODE string

XML_XMLLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
XML_XMLLINT_COMMAND_REMOVE_ARGUMENTS array | string

XML_XMLLINT: User custom arguments to remove before calling linter

XML_XMLLINT_DISABLE_ERRORS boolean

XML_XMLLINT: If true, XML_XMLLINT doesn't make MegaLinter fail even if errors are found

Default: false
XML_XMLLINT_DISABLE_ERRORS_IF_LESS_THAN number

XML_XMLLINT: If the number of errors found is less than this value, XML_XMLLINT doesn't make MegaLinter fail

Default: 0
XML_XMLLINT_FILE_EXTENSIONS string[]

XML_XMLLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".xml",
  ".xsd"
]
Examples: ".py", ".myext"
XML_XMLLINT_FILE_NAMES_REGEX string[]

XML_XMLLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
XML_XMLLINT_FILTER_REGEX_EXCLUDE string

XML_XMLLINT: Custom regex excluding filter: files matching this regex will NOT be linted

XML_XMLLINT_FILTER_REGEX_INCLUDE string

XML_XMLLINT: Custom regex including filter: only files matching this regex will be linted

XML_XMLLINT_INDENT string
Default: " "
XML_XMLLINT_POST_COMMANDS command_info[]

XML_XMLLINT: Define bash commands to run after running XML_XMLLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
XML_XMLLINT_PRE_COMMANDS command_info[]

XML_XMLLINT: Define bash commands to run before running XML_XMLLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
XML_XMLLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling XML_XMLLINT and its pre/post commands

Default:
[]
YAML_FILTER_REGEX_EXCLUDE string

YAML: Custom regex excluding filter: files matching this regex will NOT be linted

YAML_FILTER_REGEX_INCLUDE string

YAML: Custom regex including filter: only files matching this regex will be linted

YAML_POST_COMMANDS command_info[]

YAML: List of bash commands to run after the linters

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
YAML_PRETTIER_ARGUMENTS array | string

YAML_PRETTIER: User custom arguments to add in linter CLI call

YAML_PRETTIER_CLI_EXECUTABLE string[]

YAML_PRETTIER: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "prettier"
  ]
]
YAML_PRETTIER_CLI_LINT_MODE string

YAML_PRETTIER: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
YAML_PRETTIER_COMMAND_REMOVE_ARGUMENTS array | string

YAML_PRETTIER: User custom arguments to remove before calling linter

YAML_PRETTIER_CONFIG_FILE string

YAML_PRETTIER: User custom config file name if different from default

Default: ".prettierrc.json"
YAML_PRETTIER_DISABLE_ERRORS boolean

YAML_PRETTIER: If true, YAML_PRETTIER doesn't make MegaLinter fail even if errors are found

Default: false
YAML_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN number

YAML_PRETTIER: If the number of errors found is less than this value, YAML_PRETTIER doesn't make MegaLinter fail

Default: 0
YAML_PRETTIER_FILE_EXTENSIONS string[]

YAML_PRETTIER: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".yml",
  ".yaml"
]
Examples: ".py", ".myext"
YAML_PRETTIER_FILE_NAMES_REGEX string[]

YAML_PRETTIER: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
YAML_PRETTIER_FILTER_REGEX_EXCLUDE string

YAML_PRETTIER: Custom regex excluding filter: files matching this regex will NOT be linted

YAML_PRETTIER_FILTER_REGEX_INCLUDE string

YAML_PRETTIER: Custom regex including filter: only files matching this regex will be linted

YAML_PRETTIER_POST_COMMANDS command_info[]

YAML_PRETTIER: Define bash commands to run after running YAML_PRETTIER

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
YAML_PRETTIER_PRE_COMMANDS command_info[]

YAML_PRETTIER: Define bash commands to run before running YAML_PRETTIER

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
YAML_PRETTIER_RULES_PATH string

YAML_PRETTIER: Path where to find linter configuration file

YAML_PRETTIER_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling YAML_PRETTIER and its pre/post commands

Default:
[]
YAML_PRE_COMMANDS command_info[]

YAML: List of bash commands to run before the linters

Examples: [{"command":"composer install","continue_if_failed":false,"cwd":"workspace"}]
YAML_V8R_ARGUMENTS array | string

YAML_V8R: User custom arguments to add in linter CLI call

YAML_V8R_CLI_EXECUTABLE string[]

YAML_V8R: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "v8r"
  ]
]
YAML_V8R_CLI_LINT_MODE string

YAML_V8R: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
YAML_V8R_COMMAND_REMOVE_ARGUMENTS array | string

YAML_V8R: User custom arguments to remove before calling linter

YAML_V8R_CONFIG_FILE string

YAML_V8R: User custom config file name if different from default

Default: ".v8rrc.yml"
YAML_V8R_DISABLE_ERRORS boolean

YAML_V8R: If true, YAML_V8R doesn't make MegaLinter fail even if errors are found

Default: false
YAML_V8R_DISABLE_ERRORS_IF_LESS_THAN number

YAML_V8R: If the number of errors found is less than this value, YAML_V8R doesn't make MegaLinter fail

Default: 0
YAML_V8R_FILE_EXTENSIONS string[]

YAML_V8R: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".yml",
  ".yaml"
]
Examples: ".py", ".myext"
YAML_V8R_FILE_NAMES_REGEX string[]

YAML_V8R: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
YAML_V8R_FILTER_REGEX_EXCLUDE string

YAML_V8R: Custom regex excluding filter: files matching this regex will NOT be linted

YAML_V8R_FILTER_REGEX_INCLUDE string

YAML_V8R: Custom regex including filter: only files matching this regex will be linted

YAML_V8R_POST_COMMANDS command_info[]

YAML_V8R: Define bash commands to run after running YAML_V8R

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
YAML_V8R_PRE_COMMANDS command_info[]

YAML_V8R: Define bash commands to run before running YAML_V8R

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
YAML_V8R_RULES_PATH string

YAML_V8R: Path where to find linter configuration file

YAML_V8R_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling YAML_V8R and its pre/post commands

Default:
[]
YAML_YAMLLINT_ARGUMENTS array | string

YAML_YAMLLINT: User custom arguments to add in linter CLI call

YAML_YAMLLINT_CLI_EXECUTABLE string[]

YAML_YAMLLINT: Override CLI executable used to build the linter command line (rarely needed)

Default:
[
  [
    "yamllint"
  ]
]
YAML_YAMLLINT_CLI_LINT_MODE string

YAML_YAMLLINT: Override default CLI lint mode used to call the linter (rarely needed)

Default: "list_of_files"
Values: "file" "list_of_files" "project"
YAML_YAMLLINT_COMMAND_REMOVE_ARGUMENTS array | string

YAML_YAMLLINT: User custom arguments to remove before calling linter

YAML_YAMLLINT_CONFIG_FILE string

YAML_YAMLLINT: User custom config file name if different from default

Default: ".yamllint.yml"
YAML_YAMLLINT_DISABLE_ERRORS boolean

YAML_YAMLLINT: If true, YAML_YAMLLINT doesn't make MegaLinter fail even if errors are found

Default: false
YAML_YAMLLINT_DISABLE_ERRORS_IF_LESS_THAN number

YAML_YAMLLINT: If the number of errors found is less than this value, YAML_YAMLLINT doesn't make MegaLinter fail

Default: 0
YAML_YAMLLINT_FILE_EXTENSIONS string[]

YAML_YAMLLINT: Override descriptor/linter matching files extensions that will be used to select files to lint

Default:
[
  ".yml",
  ".yaml"
]
Examples: ".py", ".myext"
YAML_YAMLLINT_FILE_NAMES_REGEX string[]

YAML_YAMLLINT: Override descriptor/linter matching file name regexes that will be used to select files to lint

Default:
[]
Examples: "Dockerfile(-.+)?", "Jenkinsfile"
YAML_YAMLLINT_FILTER_REGEX_EXCLUDE string

YAML_YAMLLINT: Custom regex excluding filter: files matching this regex will NOT be linted

YAML_YAMLLINT_FILTER_REGEX_INCLUDE string

YAML_YAMLLINT: Custom regex including filter: only files matching this regex will be linted

YAML_YAMLLINT_POST_COMMANDS command_info[]

YAML_YAMLLINT: Define bash commands to run after running YAML_YAMLLINT

Examples: [{"command":"npm run test","continue_if_failed":false,"cwd":"workspace"}]
YAML_YAMLLINT_PRE_COMMANDS command_info[]

YAML_YAMLLINT: Define bash commands to run before running YAML_YAMLLINT

Examples: [{"command":"tflint --init","continue_if_failed":false,"cwd":"workspace"}]
YAML_YAMLLINT_RULES_PATH string

YAML_YAMLLINT: Path where to find linter configuration file

YAML_YAMLLINT_UNSECURED_ENV_VARIABLES string[]

List of env variables explicitly not filtered before calling YAML_YAMLLINT and its pre/post commands

Default:
[]

Definitions

command_info object

Command information

command string required

Enter a bash command. Do not hardcode secret values in the command, as it is not secured

Examples: "npm run test", "echo "This is a custom command""
continue_if_failed boolean

If the command fails, continue MegaLinter process

Default: true
cwd string

Select if the command will be run at the root of MegaLinter execution (root) or in the workspace folder where code is checked out (workspace)

Default: "root"
Values: "root" "workspace"
Examples: "root", "workspace"
output_variables string[]

ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused by other custom command and linters.

secured_env boolean

Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it, it will expose all env variables to the command, including secret ones.

Default: true
tag string

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Default: "default"
Values: "default" "before_plugins"
Examples: "default", "before_plugins"
venv string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.

Examples: "flake8"
enum_descriptor_keys string
enum_generic_categories enum
enum_generic_sections string
enum_linter_keys string