Command

Type: object

MegaLinter configuration file

No Additional Properties

ACTION_ACTIONLINT: Custom arguments

Type: array of string or string

ACTION_ACTIONLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

ACTION_ACTIONLINT: CLI Executable

Type: array of string Default: [["actionlint"]]

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

No Additional Items

Each item of this array must be:

ACTION_ACTIONLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"

ACTION_ACTIONLINT: Custom remove arguments

Type: array of string or string

ACTION_ACTIONLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

ACTION_ACTIONLINT: Custom config file name

Type: string Default: "actionlint.yml"

ACTION_ACTIONLINT: User custom config file name if different from default

ACTION_ACTIONLINT: Directory containing ACTION files

Type: string Default: ".github/workflows"

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

ACTION_ACTIONLINT: Disable errors

Type: boolean Default: false

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

ACTION_ACTIONLINT: Maximum number of errors allowed

Type: number Default: 0

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

ACTION_ACTIONLINT: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

ACTION_ACTIONLINT: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

ACTION_ACTIONLINT: Excluding Regex

Type: string or array of string

ACTION_ACTIONLINT: Including Regex

Type: string or array of string

ACTION_ACTIONLINT: Post-run commands

Type: array

ACTIONACTIONLINT: Define bash commands to run after running ACTIONACTIONLINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

ACTION_ACTIONLINT: Pre-run commands

Type: array

ACTIONACTIONLINT: Define bash commands to run before running ACTIONACTIONLINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

ACTION_ACTIONLINT: Custom config file path

Type: string

ACTION_ACTIONLINT: Path where to find linter configuration file

ACTION_ACTIONLINT: Timeout in seconds

Type: integer

ACTIONACTIONLINT: Maximum duration in seconds of the ACTIONACTIONLINT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

ACTION_ACTIONLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for ACTION descriptor

Type: string or array of string

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

Including regex filter for ACTION descriptor

Type: string or array of string

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

Post commands for ACTION descriptor

Type: array

ACTION: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for ACTION descriptor

Type: array

ACTION: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

ACTION_ZIZMOR: Custom arguments

Type: array of string or string

ACTION_ZIZMOR: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

ACTION_ZIZMOR: CLI Executable

Type: array of string Default: [["zizmor"]]

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

No Additional Items

Each item of this array must be:

ACTION_ZIZMOR: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"

ACTION_ZIZMOR: Custom remove arguments

Type: array of string or string

ACTION_ZIZMOR: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

ACTION_ZIZMOR: Custom config file name

Type: string Default: "zizmor.yml"

ACTION_ZIZMOR: User custom config file name if different from default

ACTION_ZIZMOR: Directory containing ACTION files

Type: string Default: ".github/workflows"

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

ACTION_ZIZMOR: Disable errors

Type: boolean Default: false

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

ACTION_ZIZMOR: Maximum number of errors allowed

Type: number Default: 0

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

ACTION_ZIZMOR: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

ACTION_ZIZMOR: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

ACTION_ZIZMOR: Excluding Regex

Type: string or array of string

ACTION_ZIZMOR: Including Regex

Type: string or array of string

ACTION_ZIZMOR: Post-run commands

Type: array

ACTIONZIZMOR: Define bash commands to run after running ACTIONZIZMOR

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

ACTION_ZIZMOR: Pre-run commands

Type: array

ACTIONZIZMOR: Define bash commands to run before running ACTIONZIZMOR

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

ACTION_ZIZMOR: Custom config file path

Type: string

ACTION_ZIZMOR: Path where to find linter configuration file

ACTION_ZIZMOR: Timeout in seconds

Type: integer

ACTIONZIZMOR: Maximum duration in seconds of the ACTIONZIZMOR run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

ACTION_ZIZMOR: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Additional excluded directories

Type: array of string

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

No Additional Items

Each item of this array must be:


Example:

[
    "test"
]

ANSIBLE_ANSIBLE_LINT: Custom arguments

Type: array of string or string

ANSIBLEANSIBLELINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

ANSIBLE_ANSIBLE_LINT: CLI Executable

Type: array of string Default: [["ansible-lint"]]

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

No Additional Items

Each item of this array must be:

ANSIBLE_ANSIBLE_LINT: CLI lint mode

Type: enum (of string) Default: "project"

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

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

ANSIBLE_ANSIBLE_LINT: Custom remove arguments

Type: array of string or string

ANSIBLEANSIBLELINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

ANSIBLE_ANSIBLE_LINT: Custom config file name

Type: string Default: ".ansible-lint"

ANSIBLEANSIBLELINT: User custom config file name if different from default

ANSIBLE_ANSIBLE_LINT: Directory containing ANSIBLE files

Type: string Default: "ansible"

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

ANSIBLE_ANSIBLE_LINT: Disable errors

Type: boolean Default: false

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

ANSIBLE_ANSIBLE_LINT: Maximum number of errors allowed

Type: number Default: 0

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

ANSIBLE_ANSIBLE_LINT: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

ANSIBLE_ANSIBLE_LINT: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

ANSIBLE_ANSIBLE_LINT: Excluding Regex

Type: string or array of string

ANSIBLEANSIBLELINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with ANSIBLEANSIBLELINTCLILINT_MODE = project

ANSIBLE_ANSIBLE_LINT: Including Regex

Type: string or array of string

ANSIBLEANSIBLELINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with ANSIBLEANSIBLELINTCLILINT_MODE = project

ANSIBLE_ANSIBLE_LINT: Forward excluded directories in project lint mode

Type: boolean Default: true

ANSIBLEANSIBLELINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

ANSIBLE_ANSIBLE_LINT: Post-run commands

Type: array

ANSIBLEANSIBLELINT: Define bash commands to run after running ANSIBLEANSIBLELINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

ANSIBLE_ANSIBLE_LINT: Pre-run commands

Type: array

ANSIBLEANSIBLELINT: Define bash commands to run before running ANSIBLEANSIBLELINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

ANSIBLE_ANSIBLE_LINT: Custom config file path

Type: string

ANSIBLEANSIBLELINT: Path where to find linter configuration file

ANSIBLE_ANSIBLE_LINT: Timeout in seconds

Type: integer

ANSIBLEANSIBLELINT: Maximum duration in seconds of the ANSIBLEANSIBLELINT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

ANSIBLE_ANSIBLE_LINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

ANSIBLE_DIRECTORY: Directory containing ANSIBLE files

Type: string Default: "ansible"

Excluding regex filter for ANSIBLE descriptor

Type: string or array of string

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

Including regex filter for ANSIBLE descriptor

Type: string or array of string

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

Post commands for ANSIBLE descriptor

Type: array

ANSIBLE: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for ANSIBLE descriptor

Type: array

ANSIBLE: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Excluding regex filter for API descriptor

Type: string or array of string

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

Including regex filter for API descriptor

Type: string or array of string

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

Post commands for API descriptor

Type: array

API: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for API descriptor

Type: array

API: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Activate API reporter (observability: Grafana, Datadog, Elastic, New Relic)

Type: boolean Default: false

Sends MegaLinter results (payload v2: run KPIs, linters, top rules & files) to observability backends. Configure the target(s) with APIREPORTERPROVIDER and the provider variables

API reporter (grafana): logs endpoint basic auth password. Never hardcode it in a config variable, use secrets and context variables

Type: string

API reporter (grafana): logs endpoint basic auth username. Use secrets and context variables

Type: string

API reporter (grafana): logs endpoint bearer token. Never hardcode it in a config variable, use secrets and context variables

Type: string

API reporter (datadog): Datadog API key. Never hardcode it in a config variable, use secrets and context variables

Type: string

API reporter (datadog): Datadog bearer token (service account), used when no API key is defined. Never hardcode it in a config variable, use secrets and context variables

Type: string

API reporter (datadog): Datadog site (datadoghq.com, datadoghq.eu, us3.datadoghq.com...)

Type: string

API reporter: log the payloads sent to the providers

Type: boolean Default: false

API reporter: include per-rule and per-file breakdowns (parsed from SARIF output) in the payload

Type: boolean Default: true

API reporter (elastic): Elasticsearch API key. Never hardcode it in a config variable, use secrets and context variables

Type: string

API reporter (elastic): prefix of the megalinter-* indexes

Type: string

API reporter (elastic): Elasticsearch endpoint URL

Type: string

API reporter (grafana): metrics endpoint basic auth password. Never hardcode it in a config variable, use secrets and context variables

Type: string

API reporter (grafana): metrics endpoint basic auth username. Use secrets and context variables

Type: string

API reporter (grafana): metrics endpoint bearer token. Never hardcode it in a config variable, use secrets and context variables

Type: string

API reporter (grafana): metrics endpoint URL (e.g. Grafana Cloud Influx write URL)

Type: string

API reporter (newrelic): New Relic license key (ingest). Never hardcode it in a config variable, use secrets and context variables

Type: string

API reporter (newrelic): New Relic region (US or EU)

Type: string

API reporter: organization identifier added to all records

Type: string

API reporter (grafana): logs payload format (auto, loki or default)

Type: string

API reporter: comma-separated list of target providers

Type: string

Available providers: grafana (default, direct Loki/Prometheus push via APIREPORTERURL and APIREPORTERMETRICS_URL), datadog, elastic, newrelic. Example: grafana,datadog

API reporter (grafana): logs endpoint URL (e.g. Loki push URL ending with /loki/api/v1/push)

Type: string

API_SPECTRAL: Custom arguments

Type: array of string or string

API_SPECTRAL: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

API_SPECTRAL: CLI Executable

Type: array of string Default: [["spectral"]]

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

No Additional Items

Each item of this array must be:

API_SPECTRAL: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"

API_SPECTRAL: Custom remove arguments

Type: array of string or string

API_SPECTRAL: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

API_SPECTRAL: Custom config file name

Type: string Default: ".spectral.yaml"

API_SPECTRAL: User custom config file name if different from default

API_SPECTRAL: Disable errors

Type: boolean Default: false

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

API_SPECTRAL: Maximum number of errors allowed

Type: number Default: 0

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

API_SPECTRAL: Matching files extensions

Type: array of string Default: [".yml", ".yaml", ".json"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

API_SPECTRAL: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

API_SPECTRAL: Excluding Regex

Type: string or array of string

API_SPECTRAL: Including Regex

Type: string or array of string

API_SPECTRAL: Post-run commands

Type: array

APISPECTRAL: Define bash commands to run after running APISPECTRAL

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

API_SPECTRAL: Pre-run commands

Type: array

APISPECTRAL: Define bash commands to run before running APISPECTRAL

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

API_SPECTRAL: Custom config file path

Type: string

API_SPECTRAL: Path where to find linter configuration file

API_SPECTRAL: Timeout in seconds

Type: integer

APISPECTRAL: Maximum duration in seconds of the APISPECTRAL run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

API_SPECTRAL: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Apply linters formatting and auto-fixes

Type: array or string Default: "none"

'all' to apply formatting and auto-fixes of all linters, or a list of linter keys

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ACTION_ZIZMOR"
  • "ANSIBLE_ANSIBLE_LINT"
  • "API_SPECTRAL"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "CLOJURE_CLJSTYLE"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CLANG_FORMAT"
  • "CPP_CPPCHECK"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_CSHARPIER"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_ROSLYNATOR"
  • "CSS_BIOME"
  • "CSS_SCSSLINT"
  • "CSS_SCSS_LINT"
  • "CSS_STYLELINT"
  • "C_CLANG_FORMAT"
  • "C_CPPCHECK"
  • "C_CPPLINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_DOCKERFILELINT"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GIT_GIT_DIFF"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_BIOME"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_BIOME"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_BIOME"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "JSX_BIOME"
  • "JSX_ESLINT"
  • "KOTLIN_DETEKT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_HELM"
  • "KUBERNETES_KUBECONFORM"
  • "KUBERNETES_KUBESCAPE"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "LUA_SELENE"
  • "LUA_STYLUA"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_RUMDL"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPCSFIXER"
  • "PHP_PHPLINT"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_BANDIT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_MYPY"
  • "PYTHON_NBQA_MYPY"
  • "PYTHON_PYLINT"
  • "PYTHON_PYRIGHT"
  • "PYTHON_RUFF"
  • "PYTHON_RUFF_FORMAT"
  • "RAKU_RAKU"
  • "REPOSITORY_BETTERLEAKS"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_GRYPE"
  • "REPOSITORY_KICS"
  • "REPOSITORY_KINGFISHER"
  • "REPOSITORY_LS_LINT"
  • "REPOSITORY_OSV_SCANNER"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "REPOSITORY_TRIVY_SBOM"
  • "REPOSITORY_TRUFFLEHOG"
  • "ROBOTFRAMEWORK_ROBOCOP"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RST_RST_LINT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "R_LINTR"
  • "SALESFORCE_CODE_ANALYZER_APEX"
  • "SALESFORCE_CODE_ANALYZER_APEXGURU"
  • "SALESFORCE_CODE_ANALYZER_AURA"
  • "SALESFORCE_CODE_ANALYZER_FLOW"
  • "SALESFORCE_CODE_ANALYZER_LWC"
  • "SALESFORCE_LIGHTNING_FLOW_SCANNER"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_CODESPELL"
  • "SPELL_CSPELL"
  • "SPELL_LYCHEE"
  • "SPELL_MISSPELL"
  • "SPELL_PROSELINT"
  • "SPELL_VALE"
  • "SQL_SQLFLUFF"
  • "SQL_SQL_LINT"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TFLINT"
  • "TERRAFORM_TOFU_FMT"
  • "TERRAFORM_TOFU_VALIDATE"
  • "TSX_BIOME"
  • "TSX_ESLINT"
  • "TYPESCRIPT_BIOME"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Examples:

"all"
"none"
[
    "JAVASCRIPT_ES",
    "MARKDOWN_MARKDOWNLINT"
]

ARM_ARM_TTK: Custom arguments

Type: array of string or string

ARMARMTTK: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

ARM_ARM_TTK: CLI Executable

Type: array of string Default: [["arm-ttk"]]

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

No Additional Items

Each item of this array must be:

ARM_ARM_TTK: CLI lint mode

Type: enum (of string) Default: "file"

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

Must be one of:

  • "file"

ARM_ARM_TTK: Custom remove arguments

Type: array of string or string

ARMARMTTK: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

ARM_ARM_TTK: Custom config file name

Type: string Default: ".arm-ttk.psd1"

ARMARMTTK: User custom config file name if different from default

ARM_ARM_TTK: Disable errors

Type: boolean Default: false

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

ARM_ARM_TTK: Maximum number of errors allowed

Type: number Default: 0

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

ARM_ARM_TTK: Matching files extensions

Type: array of string Default: [".json"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

ARM_ARM_TTK: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

ARM_ARM_TTK: Excluding Regex

Type: string or array of string

ARM_ARM_TTK: Including Regex

Type: string or array of string

ARM_ARM_TTK: Post-run commands

Type: array

ARMARMTTK: Define bash commands to run after running ARMARMTTK

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

ARM_ARM_TTK: Pre-run commands

Type: array

ARMARMTTK: Define bash commands to run before running ARMARMTTK

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

ARM_ARM_TTK: Custom config file path

Type: string

ARMARMTTK: Path where to find linter configuration file

ARM_ARM_TTK: Timeout in seconds

Type: integer

ARMARMTTK: Maximum duration in seconds of the ARMARMTTK run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

ARM_ARM_TTK: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for ARM descriptor

Type: string or array of string

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

Including regex filter for ARM descriptor

Type: string or array of string

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

Post commands for ARM descriptor

Type: array

ARM: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for ARM descriptor

Type: array

ARM: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Activate Azure PR Comments reporter

Type: boolean Default: true

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

BASH_EXEC: Custom arguments

Type: array of string or string

BASH_EXEC: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

BASH_EXEC: CLI Executable

Type: array of string Default: [["bash-exec"]]

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

No Additional Items

Each item of this array must be:

BASH_EXEC: CLI lint mode

Type: enum (of string) Default: "file"

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

Must be one of:

  • "file"

BASH_EXEC: Custom remove arguments

Type: array of string or string

BASH_EXEC: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

BASH_EXEC: Disable errors

Type: boolean Default: false

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

BASH_EXEC: Maximum number of errors allowed

Type: number Default: 0

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

BASH_EXEC: Matching files extensions

Type: array of string Default: [".sh", ".bash", ".dash", ".ksh"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

BASH_EXEC: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

BASH_EXEC: Excluding Regex

Type: string or array of string

BASH_EXEC: Including Regex

Type: string or array of string

BASH_EXEC: Post-run commands

Type: array

BASHEXEC: Define bash commands to run after running BASHEXEC

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

BASH_EXEC: Pre-run commands

Type: array

BASHEXEC: Define bash commands to run before running BASHEXEC

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

BASH_EXEC: Timeout in seconds

Type: integer

BASHEXEC: Maximum duration in seconds of the BASHEXEC run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

BASH_EXEC: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for BASH descriptor

Type: string or array of string

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

Including regex filter for BASH descriptor

Type: string or array of string

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

Post commands for BASH descriptor

Type: array

BASH: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for BASH descriptor

Type: array

BASH: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

BASH_SHELLCHECK: Custom arguments

Type: array of string or string

BASH_SHELLCHECK: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

BASH_SHELLCHECK: CLI Executable

Type: array of string Default: [["shellcheck"]]

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

No Additional Items

Each item of this array must be:

BASH_SHELLCHECK: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"

BASH_SHELLCHECK: Custom remove arguments

Type: array of string or string

BASH_SHELLCHECK: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

BASH_SHELLCHECK: Custom config file name

Type: string Default: ".shellcheckrc"

BASH_SHELLCHECK: User custom config file name if different from default

BASH_SHELLCHECK: Disable errors

Type: boolean Default: false

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

BASH_SHELLCHECK: Maximum number of errors allowed

Type: number Default: 0

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

BASH_SHELLCHECK: Matching files extensions

Type: array of string Default: [".sh", ".bash", ".dash", ".ksh"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

BASH_SHELLCHECK: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

BASH_SHELLCHECK: Excluding Regex

Type: string or array of string

BASH_SHELLCHECK: Including Regex

Type: string or array of string

BASH_SHELLCHECK: Post-run commands

Type: array

BASHSHELLCHECK: Define bash commands to run after running BASHSHELLCHECK

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

BASH_SHELLCHECK: Pre-run commands

Type: array

BASHSHELLCHECK: Define bash commands to run before running BASHSHELLCHECK

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

BASH_SHELLCHECK: Custom config file path

Type: string

BASH_SHELLCHECK: Path where to find linter configuration file

BASH_SHELLCHECK: Timeout in seconds

Type: integer

BASHSHELLCHECK: Maximum duration in seconds of the BASHSHELLCHECK run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

BASH_SHELLCHECK: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

BASH_SHFMT: Custom arguments

Type: array of string or string

BASH_SHFMT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

BASH_SHFMT: CLI Executable

Type: array of string Default: [["shfmt"]]

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

No Additional Items

Each item of this array must be:

BASH_SHFMT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"

BASH_SHFMT: Custom remove arguments

Type: array of string or string

BASH_SHFMT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

BASH_SHFMT: Disable errors

Type: boolean Default: false

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

BASH_SHFMT: Maximum number of errors allowed

Type: number Default: 0

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

BASH_SHFMT: Matching files extensions

Type: array of string Default: [".sh", ".bash", ".dash", ".ksh"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

BASH_SHFMT: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

BASH_SHFMT: Excluding Regex

Type: string or array of string

BASH_SHFMT: Including Regex

Type: string or array of string

BASH_SHFMT: Post-run commands

Type: array

BASHSHFMT: Define bash commands to run after running BASHSHFMT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

BASH_SHFMT: Pre-run commands

Type: array

BASHSHFMT: Define bash commands to run before running BASHSHFMT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

BASH_SHFMT: Timeout in seconds

Type: integer

BASHSHFMT: Maximum duration in seconds of the BASHSHFMT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

BASH_SHFMT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

BICEP_BICEP_LINTER: Custom arguments

Type: array of string or string

BICEPBICEPLINTER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

BICEP_BICEP_LINTER: CLI Executable

Type: array of string Default: [["bicep"]]

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

No Additional Items

Each item of this array must be:

BICEP_BICEP_LINTER: CLI lint mode

Type: enum (of string) Default: "file"

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

Must be one of:

  • "file"

BICEP_BICEP_LINTER: Custom remove arguments

Type: array of string or string

BICEPBICEPLINTER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

BICEP_BICEP_LINTER: Disable errors

Type: boolean Default: false

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

BICEP_BICEP_LINTER: Maximum number of errors allowed

Type: number Default: 0

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

BICEP_BICEP_LINTER: Matching files extensions

Type: array of string Default: [".bicep"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

BICEP_BICEP_LINTER: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

BICEP_BICEP_LINTER: Excluding Regex

Type: string or array of string

BICEP_BICEP_LINTER: Including Regex

Type: string or array of string

BICEP_BICEP_LINTER: Post-run commands

Type: array

BICEPBICEPLINTER: Define bash commands to run after running BICEPBICEPLINTER

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

BICEP_BICEP_LINTER: Pre-run commands

Type: array

BICEPBICEPLINTER: Define bash commands to run before running BICEPBICEPLINTER

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

BICEP_BICEP_LINTER: Timeout in seconds

Type: integer

BICEPBICEPLINTER: Maximum duration in seconds of the BICEPBICEPLINTER run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

BICEP_BICEP_LINTER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for BICEP descriptor

Type: string or array of string

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

Including regex filter for BICEP descriptor

Type: string or array of string

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

Post commands for BICEP descriptor

Type: array

BICEP: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for BICEP descriptor

Type: array

BICEP: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Activate Bitbucket PR Comments reporter

Type: boolean Default: true

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

Overwrite Bitbucket Pull Request Comment

Type: boolean Default: true

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

Clear Report Folder

Type: boolean Default: false

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

CLOJURE_CLJSTYLE: Custom arguments

Type: array of string or string

CLOJURE_CLJSTYLE: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

CLOJURE_CLJSTYLE: CLI Executable

Type: array of string Default: [["cljstyle"]]

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

No Additional Items

Each item of this array must be:

CLOJURE_CLJSTYLE: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

CLOJURE_CLJSTYLE: Custom remove arguments

Type: array of string or string

CLOJURE_CLJSTYLE: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

CLOJURE_CLJSTYLE: Custom config file name

Type: string Default: ".cljstyle"

CLOJURE_CLJSTYLE: User custom config file name if different from default

CLOJURE_CLJSTYLE: Disable errors

Type: boolean Default: false

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

CLOJURE_CLJSTYLE: Maximum number of errors allowed

Type: number Default: 0

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

CLOJURE_CLJSTYLE: Matching files extensions

Type: array of string Default: [".clj", ".cljs", ".cljc", ".edn"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

CLOJURE_CLJSTYLE: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

CLOJURE_CLJSTYLE: Excluding Regex

Type: string or array of string

CLOJURECLJSTYLE: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with CLOJURECLJSTYLECLILINT_MODE = project

CLOJURE_CLJSTYLE: Including Regex

Type: string or array of string

CLOJURECLJSTYLE: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with CLOJURECLJSTYLECLILINT_MODE = project

CLOJURE_CLJSTYLE: Forward excluded directories in project lint mode

Type: boolean Default: true

CLOJURE_CLJSTYLE: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

CLOJURE_CLJSTYLE: Post-run commands

Type: array

CLOJURECLJSTYLE: Define bash commands to run after running CLOJURECLJSTYLE

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CLOJURE_CLJSTYLE: Pre-run commands

Type: array

CLOJURECLJSTYLE: Define bash commands to run before running CLOJURECLJSTYLE

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CLOJURE_CLJSTYLE: Custom config file path

Type: string

CLOJURE_CLJSTYLE: Path where to find linter configuration file

CLOJURE_CLJSTYLE: Timeout in seconds

Type: integer

CLOJURECLJSTYLE: Maximum duration in seconds of the CLOJURECLJSTYLE run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

CLOJURE_CLJSTYLE: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

CLOJURE_CLJ_KONDO: Custom arguments

Type: array of string or string

CLOJURECLJKONDO: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

CLOJURE_CLJ_KONDO: CLI Executable

Type: array of string Default: [["clj-kondo"]]

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

No Additional Items

Each item of this array must be:

CLOJURE_CLJ_KONDO: CLI lint mode

Type: enum (of string) Default: "file"

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

Must be one of:

  • "file"
  • "project"

CLOJURE_CLJ_KONDO: Custom remove arguments

Type: array of string or string

CLOJURECLJKONDO: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

CLOJURE_CLJ_KONDO: Custom config file name

Type: string Default: ".clj-kondo/config.edn"

CLOJURECLJKONDO: User custom config file name if different from default

CLOJURE_CLJ_KONDO: Disable errors

Type: boolean Default: false

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

CLOJURE_CLJ_KONDO: Maximum number of errors allowed

Type: number Default: 0

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

CLOJURE_CLJ_KONDO: Matching files extensions

Type: array of string Default: [".clj", ".cljs", ".cljc", ".edn"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

CLOJURE_CLJ_KONDO: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

CLOJURE_CLJ_KONDO: Excluding Regex

Type: string or array of string

CLOJURECLJKONDO: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with CLOJURECLJKONDOCLILINT_MODE = project

CLOJURE_CLJ_KONDO: Including Regex

Type: string or array of string

CLOJURECLJKONDO: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with CLOJURECLJKONDOCLILINT_MODE = project

CLOJURE_CLJ_KONDO: Forward excluded directories in project lint mode

Type: boolean Default: true

CLOJURECLJKONDO: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

CLOJURE_CLJ_KONDO: Post-run commands

Type: array

CLOJURECLJKONDO: Define bash commands to run after running CLOJURECLJKONDO

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CLOJURE_CLJ_KONDO: Pre-run commands

Type: array

CLOJURECLJKONDO: Define bash commands to run before running CLOJURECLJKONDO

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CLOJURE_CLJ_KONDO: Custom config file path

Type: string

CLOJURECLJKONDO: Path where to find linter configuration file

CLOJURE_CLJ_KONDO: Timeout in seconds

Type: integer

CLOJURECLJKONDO: Maximum duration in seconds of the CLOJURECLJKONDO run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

CLOJURE_CLJ_KONDO: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for CLOJURE descriptor

Type: string or array of string

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

Including regex filter for CLOJURE descriptor

Type: string or array of string

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

Post commands for CLOJURE descriptor

Type: array

CLOJURE: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for CLOJURE descriptor

Type: array

CLOJURE: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CLOUDFORMATION_CFN_LINT: Custom arguments

Type: array of string or string

CLOUDFORMATIONCFNLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

CLOUDFORMATION_CFN_LINT: CLI Executable

Type: array of string Default: [["cfn-lint"]]

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

No Additional Items

Each item of this array must be:

CLOUDFORMATION_CFN_LINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

CLOUDFORMATION_CFN_LINT: Custom remove arguments

Type: array of string or string

CLOUDFORMATIONCFNLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

CLOUDFORMATION_CFN_LINT: Custom config file name

Type: string Default: ".cfnlintrc.yml"

CLOUDFORMATIONCFNLINT: User custom config file name if different from default

CLOUDFORMATION_CFN_LINT: Disable errors

Type: boolean Default: false

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

CLOUDFORMATION_CFN_LINT: Maximum number of errors allowed

Type: number Default: 0

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

CLOUDFORMATION_CFN_LINT: Matching files extensions

Type: array of string Default: [".yml", ".yaml", ".json"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

CLOUDFORMATION_CFN_LINT: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

CLOUDFORMATION_CFN_LINT: Excluding Regex

Type: string or array of string

CLOUDFORMATIONCFNLINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with CLOUDFORMATIONCFNLINTCLILINT_MODE = project

CLOUDFORMATION_CFN_LINT: Including Regex

Type: string or array of string

CLOUDFORMATIONCFNLINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with CLOUDFORMATIONCFNLINTCLILINT_MODE = project

CLOUDFORMATION_CFN_LINT: Forward excluded directories in project lint mode

Type: boolean Default: true

CLOUDFORMATIONCFNLINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

CLOUDFORMATION_CFN_LINT: Post-run commands

Type: array

CLOUDFORMATIONCFNLINT: Define bash commands to run after running CLOUDFORMATIONCFNLINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CLOUDFORMATION_CFN_LINT: Pre-run commands

Type: array

CLOUDFORMATIONCFNLINT: Define bash commands to run before running CLOUDFORMATIONCFNLINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CLOUDFORMATION_CFN_LINT: Custom config file path

Type: string

CLOUDFORMATIONCFNLINT: Path where to find linter configuration file

CLOUDFORMATION_CFN_LINT: Timeout in seconds

Type: integer

CLOUDFORMATIONCFNLINT: Maximum duration in seconds of the CLOUDFORMATIONCFNLINT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

CLOUDFORMATION_CFN_LINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for CLOUDFORMATION descriptor

Type: string or array of string

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

Including regex filter for CLOUDFORMATION descriptor

Type: string or array of string

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

Post commands for CLOUDFORMATION descriptor

Type: array

CLOUDFORMATION: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for CLOUDFORMATION descriptor

Type: array

CLOUDFORMATION: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

COFFEE_COFFEELINT: Custom arguments

Type: array of string or string

COFFEE_COFFEELINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

COFFEE_COFFEELINT: CLI Executable

Type: array of string Default: [["coffeelint"]]

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

No Additional Items

Each item of this array must be:

COFFEE_COFFEELINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

COFFEE_COFFEELINT: Custom remove arguments

Type: array of string or string

COFFEE_COFFEELINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

COFFEE_COFFEELINT: Custom config file name

Type: string Default: ".coffee-lint.json"

COFFEE_COFFEELINT: User custom config file name if different from default

COFFEE_COFFEELINT: Disable errors

Type: boolean Default: false

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

COFFEE_COFFEELINT: Maximum number of errors allowed

Type: number Default: 0

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

COFFEE_COFFEELINT: Matching files extensions

Type: array of string Default: [".coffee"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

COFFEE_COFFEELINT: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

COFFEE_COFFEELINT: Excluding Regex

Type: string or array of string

COFFEECOFFEELINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with COFFEECOFFEELINTCLILINT_MODE = project

COFFEE_COFFEELINT: Including Regex

Type: string or array of string

COFFEECOFFEELINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with COFFEECOFFEELINTCLILINT_MODE = project

COFFEE_COFFEELINT: Forward excluded directories in project lint mode

Type: boolean Default: true

COFFEE_COFFEELINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

COFFEE_COFFEELINT: Post-run commands

Type: array

COFFEECOFFEELINT: Define bash commands to run after running COFFEECOFFEELINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

COFFEE_COFFEELINT: Pre-run commands

Type: array

COFFEECOFFEELINT: Define bash commands to run before running COFFEECOFFEELINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

COFFEE_COFFEELINT: Custom config file path

Type: string

COFFEE_COFFEELINT: Path where to find linter configuration file

COFFEE_COFFEELINT: Timeout in seconds

Type: integer

COFFEECOFFEELINT: Maximum duration in seconds of the COFFEECOFFEELINT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

COFFEE_COFFEELINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for COFFEE descriptor

Type: string or array of string

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

Including regex filter for COFFEE descriptor

Type: string or array of string

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

Post commands for COFFEE descriptor

Type: array

COFFEE: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for COFFEE descriptor

Type: array

COFFEE: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

List of configuration properties to append their values

Type: array of string

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

No Additional Items

Each item of this array must be:


Example:

[
    "ENABLE_LINTERS"
]

Activate local configuration reporter

Type: boolean Default: true

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

Output folder for IDE configuration files within report folder

Type: string Default: "IDE-config"

Activate console reporter

Type: boolean Default: true

Activate console logs sections

Type: boolean Default: true

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

Excluding regex filter for COPYPASTE descriptor

Type: string or array of string

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

Including regex filter for COPYPASTE descriptor

Type: string or array of string

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

COPYPASTE_JSCPD: Custom arguments

Type: array of string or string

COPYPASTE_JSCPD: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

COPYPASTE_JSCPD: CLI Executable

Type: array of string Default: [["jscpd"]]

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

No Additional Items

Each item of this array must be:

COPYPASTE_JSCPD: CLI lint mode

Type: enum (of string) Default: "project"

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

Must be one of:

  • "project"

COPYPASTE_JSCPD: Custom remove arguments

Type: array of string or string

COPYPASTE_JSCPD: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

COPYPASTE_JSCPD: Custom config file name

Type: string Default: ".jscpd.json"

COPYPASTE_JSCPD: User custom config file name if different from default

COPYPASTE_JSCPD: Disable errors

Type: boolean Default: false

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

COPYPASTE_JSCPD: Maximum number of errors allowed

Type: number Default: 0

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

COPYPASTE_JSCPD: Excluding Regex

Type: string or array of string

COPYPASTEJSCPD: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with COPYPASTEJSCPDCLILINT_MODE = project

COPYPASTE_JSCPD: Including Regex

Type: string or array of string

COPYPASTEJSCPD: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with COPYPASTEJSCPDCLILINT_MODE = project

COPYPASTE_JSCPD: Forward excluded directories in project lint mode

Type: boolean Default: true

COPYPASTE_JSCPD: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

COPYPASTE_JSCPD: Post-run commands

Type: array

COPYPASTEJSCPD: Define bash commands to run after running COPYPASTEJSCPD

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

COPYPASTE_JSCPD: Pre-run commands

Type: array

COPYPASTEJSCPD: Define bash commands to run before running COPYPASTEJSCPD

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

COPYPASTE_JSCPD: Custom config file path

Type: string

COPYPASTE_JSCPD: Path where to find linter configuration file

COPYPASTE_JSCPD: Timeout in seconds

Type: integer

COPYPASTEJSCPD: Maximum duration in seconds of the COPYPASTEJSCPD run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

COPYPASTE_JSCPD: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for COPYPASTE descriptor

Type: array

COPYPASTE: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for COPYPASTE descriptor

Type: array

COPYPASTE: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CPP_CLANG_FORMAT: Custom arguments

Type: array of string or string

CPPCLANGFORMAT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

CPP_CLANG_FORMAT: CLI Executable

Type: array of string Default: [["clang-format"]]

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

No Additional Items

Each item of this array must be:

CPP_CLANG_FORMAT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"

CPP_CLANG_FORMAT: Custom remove arguments

Type: array of string or string

CPPCLANGFORMAT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

CPP_CLANG_FORMAT: Custom config file name

Type: string Default: ".clang-format"

CPPCLANGFORMAT: User custom config file name if different from default

CPP_CLANG_FORMAT: Disable errors

Type: boolean Default: false

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

CPP_CLANG_FORMAT: Maximum number of errors allowed

Type: number Default: 0

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

CPP_CLANG_FORMAT: Matching files extensions

Type: array of string Default: [".cpp", ".h", ".cc", ".hpp", ".cxx", ".cu", ".hxx", ".c++", ".hh", ".h++", ".cuh"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

CPP_CLANG_FORMAT: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

CPP_CLANG_FORMAT: Excluding Regex

Type: string or array of string

CPP_CLANG_FORMAT: Including Regex

Type: string or array of string

CPP_CLANG_FORMAT: Post-run commands

Type: array

CPPCLANGFORMAT: Define bash commands to run after running CPPCLANGFORMAT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CPP_CLANG_FORMAT: Pre-run commands

Type: array

CPPCLANGFORMAT: Define bash commands to run before running CPPCLANGFORMAT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CPP_CLANG_FORMAT: Custom config file path

Type: string

CPPCLANGFORMAT: Path where to find linter configuration file

CPP_CLANG_FORMAT: Timeout in seconds

Type: integer

CPPCLANGFORMAT: Maximum duration in seconds of the CPPCLANGFORMAT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

CPP_CLANG_FORMAT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

CPP_CPPCHECK: Custom arguments

Type: array of string or string

CPP_CPPCHECK: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

CPP_CPPCHECK: CLI Executable

Type: array of string Default: [["cppcheck"]]

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

No Additional Items

Each item of this array must be:

CPP_CPPCHECK: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

CPP_CPPCHECK: Custom remove arguments

Type: array of string or string

CPP_CPPCHECK: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

CPP_CPPCHECK: Disable errors

Type: boolean Default: false

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

CPP_CPPCHECK: Maximum number of errors allowed

Type: number Default: 0

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

CPP_CPPCHECK: Matching files extensions

Type: array of string Default: [".cpp", ".h", ".cc", ".hpp", ".cxx", ".cu", ".hxx", ".c++", ".hh", ".h++", ".cuh"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

CPP_CPPCHECK: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

CPP_CPPCHECK: Excluding Regex

Type: string or array of string

CPPCPPCHECK: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with CPPCPPCHECKCLILINT_MODE = project

CPP_CPPCHECK: Including Regex

Type: string or array of string

CPPCPPCHECK: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with CPPCPPCHECKCLILINT_MODE = project

CPP_CPPCHECK: Forward excluded directories in project lint mode

Type: boolean Default: true

CPP_CPPCHECK: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

CPP_CPPCHECK: Post-run commands

Type: array

CPPCPPCHECK: Define bash commands to run after running CPPCPPCHECK

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CPP_CPPCHECK: Pre-run commands

Type: array

CPPCPPCHECK: Define bash commands to run before running CPPCPPCHECK

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CPP_CPPCHECK: Timeout in seconds

Type: integer

CPPCPPCHECK: Maximum duration in seconds of the CPPCPPCHECK run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

CPP_CPPCHECK: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

CPP_CPPLINT: Custom arguments

Type: array of string or string

CPP_CPPLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

CPP_CPPLINT: CLI Executable

Type: array of string Default: [["cpplint"]]

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

No Additional Items

Each item of this array must be:

CPP_CPPLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"

CPP_CPPLINT: Custom remove arguments

Type: array of string or string

CPP_CPPLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

CPP_CPPLINT: Disable errors

Type: boolean Default: false

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

CPP_CPPLINT: Maximum number of errors allowed

Type: number Default: 0

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

CPP_CPPLINT: Matching files extensions

Type: array of string Default: [".cpp", ".h", ".cc", ".hpp", ".cxx", ".cu", ".hxx", ".c++", ".hh", ".h++", ".cuh"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

CPP_CPPLINT: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

CPP_CPPLINT: Excluding Regex

Type: string or array of string

CPP_CPPLINT: Including Regex

Type: string or array of string

CPP_CPPLINT: Post-run commands

Type: array

CPPCPPLINT: Define bash commands to run after running CPPCPPLINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CPP_CPPLINT: Pre-run commands

Type: array

CPPCPPLINT: Define bash commands to run before running CPPCPPLINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CPP_CPPLINT: Timeout in seconds

Type: integer

CPPCPPLINT: Maximum duration in seconds of the CPPCPPLINT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

CPP_CPPLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for CPP descriptor

Type: string or array of string

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

Including regex filter for CPP descriptor

Type: string or array of string

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

Post commands for CPP descriptor

Type: array

CPP: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for CPP descriptor

Type: array

CPP: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSHARP_CSHARPIER: Custom arguments

Type: array of string or string

CSHARP_CSHARPIER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

CSHARP_CSHARPIER: CLI Executable

Type: array of string Default: [["csharpier"]]

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

No Additional Items

Each item of this array must be:

CSHARP_CSHARPIER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

CSHARP_CSHARPIER: Custom remove arguments

Type: array of string or string

CSHARP_CSHARPIER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

CSHARP_CSHARPIER: Custom config file name

Type: string Default: ".csharpierrc"

CSHARP_CSHARPIER: User custom config file name if different from default

CSHARP_CSHARPIER: Disable errors

Type: boolean Default: false

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

CSHARP_CSHARPIER: Maximum number of errors allowed

Type: number Default: 0

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

CSHARP_CSHARPIER: Matching files extensions

Type: array of string Default: [".config", ".cs", ".csproj", ".props", ".targets"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

CSHARP_CSHARPIER: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

CSHARP_CSHARPIER: Excluding Regex

Type: string or array of string

CSHARPCSHARPIER: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with CSHARPCSHARPIERCLILINT_MODE = project

CSHARP_CSHARPIER: Including Regex

Type: string or array of string

CSHARPCSHARPIER: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with CSHARPCSHARPIERCLILINT_MODE = project

CSHARP_CSHARPIER: Forward excluded directories in project lint mode

Type: boolean Default: true

CSHARP_CSHARPIER: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

CSHARP_CSHARPIER: Post-run commands

Type: array

CSHARPCSHARPIER: Define bash commands to run after running CSHARPCSHARPIER

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSHARP_CSHARPIER: Pre-run commands

Type: array

CSHARPCSHARPIER: Define bash commands to run before running CSHARPCSHARPIER

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSHARP_CSHARPIER: Custom config file path

Type: string

CSHARP_CSHARPIER: Path where to find linter configuration file

CSHARP_CSHARPIER: Timeout in seconds

Type: integer

CSHARPCSHARPIER: Maximum duration in seconds of the CSHARPCSHARPIER run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

CSHARP_CSHARPIER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

CSHARP_DOTNET_FORMAT: Custom arguments

Type: array of string or string

CSHARPDOTNETFORMAT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

CSHARP_DOTNET_FORMAT: CLI Executable

Type: array of string Default: [["dotnet"]]

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

No Additional Items

Each item of this array must be:

CSHARP_DOTNET_FORMAT: CLI lint mode

Type: enum (of string) Default: "project"

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

Must be one of:

  • "project"

CSHARP_DOTNET_FORMAT: Custom remove arguments

Type: array of string or string

CSHARPDOTNETFORMAT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

CSHARP_DOTNET_FORMAT: Disable errors

Type: boolean Default: false

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

CSHARP_DOTNET_FORMAT: Maximum number of errors allowed

Type: number Default: 0

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

CSHARP_DOTNET_FORMAT: Matching files extensions

Type: array of string Default: [".cs"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

CSHARP_DOTNET_FORMAT: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

CSHARP_DOTNET_FORMAT: Excluding Regex

Type: string or array of string

CSHARPDOTNETFORMAT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with CSHARPDOTNETFORMATCLILINT_MODE = project

CSHARP_DOTNET_FORMAT: Including Regex

Type: string or array of string

CSHARPDOTNETFORMAT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with CSHARPDOTNETFORMATCLILINT_MODE = project

CSHARP_DOTNET_FORMAT: Forward excluded directories in project lint mode

Type: boolean Default: true

CSHARPDOTNETFORMAT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

CSHARP_DOTNET_FORMAT: Post-run commands

Type: array

CSHARPDOTNETFORMAT: Define bash commands to run after running CSHARPDOTNETFORMAT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSHARP_DOTNET_FORMAT: Pre-run commands

Type: array

CSHARPDOTNETFORMAT: Define bash commands to run before running CSHARPDOTNETFORMAT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSHARP_DOTNET_FORMAT: Timeout in seconds

Type: integer

CSHARPDOTNETFORMAT: Maximum duration in seconds of the CSHARPDOTNETFORMAT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

CSHARP_DOTNET_FORMAT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for CSHARP descriptor

Type: string or array of string

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

Including regex filter for CSHARP descriptor

Type: string or array of string

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

Post commands for CSHARP descriptor

Type: array

CSHARP: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for CSHARP descriptor

Type: array

CSHARP: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSHARP_ROSLYNATOR: Custom arguments

Type: array of string or string

CSHARP_ROSLYNATOR: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

CSHARP_ROSLYNATOR: CLI Executable

Type: array of string Default: [["roslynator"]]

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

No Additional Items

Each item of this array must be:

CSHARP_ROSLYNATOR: CLI lint mode

Type: enum (of string) Default: "file"

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

Must be one of:

  • "file"

CSHARP_ROSLYNATOR: Custom remove arguments

Type: array of string or string

CSHARP_ROSLYNATOR: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

CSHARP_ROSLYNATOR: Disable errors

Type: boolean Default: false

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

CSHARP_ROSLYNATOR: Maximum number of errors allowed

Type: number Default: 0

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

CSHARP_ROSLYNATOR: Matching files extensions

Type: array of string Default: [".csproj"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

CSHARP_ROSLYNATOR: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

CSHARP_ROSLYNATOR: Excluding Regex

Type: string or array of string

CSHARP_ROSLYNATOR: Including Regex

Type: string or array of string

CSHARP_ROSLYNATOR: Post-run commands

Type: array

CSHARPROSLYNATOR: Define bash commands to run after running CSHARPROSLYNATOR

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSHARP_ROSLYNATOR: Pre-run commands

Type: array

CSHARPROSLYNATOR: Define bash commands to run before running CSHARPROSLYNATOR

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSHARP_ROSLYNATOR: Timeout in seconds

Type: integer

CSHARPROSLYNATOR: Maximum duration in seconds of the CSHARPROSLYNATOR run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

CSHARP_ROSLYNATOR: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

CSS_BIOME: Custom arguments

Type: array of string or string

CSS_BIOME: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

CSS_BIOME: CLI Executable

Type: array of string Default: [["biome"]]

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

No Additional Items

Each item of this array must be:

CSS_BIOME: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

CSS_BIOME: Custom remove arguments

Type: array of string or string

CSS_BIOME: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

CSS_BIOME: Custom config file name

Type: string Default: "biome.json"

CSS_BIOME: User custom config file name if different from default

CSS_BIOME: Disable errors

Type: boolean Default: false

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

CSS_BIOME: Maximum number of errors allowed

Type: number Default: 0

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

CSS_BIOME: Matching files extensions

Type: array of string Default: [".css"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

CSS_BIOME: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

CSS_BIOME: Excluding Regex

Type: string or array of string

CSSBIOME: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with CSSBIOMECLILINT_MODE = project

CSS_BIOME: Including Regex

Type: string or array of string

CSSBIOME: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with CSSBIOMECLILINT_MODE = project

CSS_BIOME: Forward excluded directories in project lint mode

Type: boolean Default: true

CSS_BIOME: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

CSS_BIOME: Post-run commands

Type: array

CSSBIOME: Define bash commands to run after running CSSBIOME

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSS_BIOME: Pre-run commands

Type: array

CSSBIOME: Define bash commands to run before running CSSBIOME

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSS_BIOME: Custom config file path

Type: string

CSS_BIOME: Path where to find linter configuration file

CSS_BIOME: Timeout in seconds

Type: integer

CSSBIOME: Maximum duration in seconds of the CSSBIOME run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

CSS_BIOME: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for CSS descriptor

Type: string or array of string

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

Including regex filter for CSS descriptor

Type: string or array of string

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

Post commands for CSS descriptor

Type: array

CSS: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for CSS descriptor

Type: array

CSS: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

(deprecated) CSS_SCSS_LINT: Custom arguments

Type: array of string or string

CSSSCSSLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) CSS_SCSS_LINT: CLI Executable

Type: array of string Default: [["scss-lint"]]
No Additional Items

Each item of this array must be:

(deprecated) CSS_SCSS_LINT: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "project"

(deprecated) CSS_SCSS_LINT: Custom remove arguments

Type: array of string or string

CSSSCSSLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) CSS_SCSS_LINT: Custom config file name

Type: string Default: ".scss-lint.yml"

CSSSCSSLINT: User custom config file name if different from default

(deprecated) CSS_SCSS_LINT: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

(deprecated) CSS_SCSS_LINT: Maximum number of errors allowed

Type: number Default: 0

(deprecated) CSS_SCSS_LINT: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

(deprecated) CSS_SCSS_LINT: Custom config file name

Type: string Default: ".scss-lint.yml"

CSSSCSSLINT: User custom config file name if different from default

(deprecated) CSS_SCSS_LINT: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

(deprecated) CSS_SCSS_LINT: Excluding Regex

Type: string

(deprecated) CSS_SCSS_LINT: Including Regex

Type: string

(deprecated) CSS_SCSS_LINT: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

(deprecated) CSS_SCSS_LINT: Define or override a list of bash commands to run before the linter

Type: array
No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

(deprecated) CSS_SCSS_LINT: Custom config file path

Type: string

CSSSCSSLINT: Path where to find linter configuration file

(deprecated) CSS_SCSS_LINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

CSS_STYLELINT: Custom arguments

Type: array of string or string

CSS_STYLELINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

CSS_STYLELINT: CLI Executable

Type: array of string Default: [["stylelint"]]

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

No Additional Items

Each item of this array must be:

CSS_STYLELINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

CSS_STYLELINT: Custom remove arguments

Type: array of string or string

CSS_STYLELINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

CSS_STYLELINT: Custom config file name

Type: string Default: ".stylelintrc.json"

CSS_STYLELINT: User custom config file name if different from default

CSS_STYLELINT: Disable errors

Type: boolean Default: false

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

CSS_STYLELINT: Maximum number of errors allowed

Type: number Default: 0

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

CSS_STYLELINT: Matching files extensions

Type: array of string Default: [".css", ".scss", ".saas"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

CSS_STYLELINT: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

CSS_STYLELINT: Excluding Regex

Type: string or array of string

CSSSTYLELINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with CSSSTYLELINTCLILINT_MODE = project

CSS_STYLELINT: Including Regex

Type: string or array of string

CSSSTYLELINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with CSSSTYLELINTCLILINT_MODE = project

CSS_STYLELINT: Forward excluded directories in project lint mode

Type: boolean Default: true

CSS_STYLELINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

CSS_STYLELINT: Post-run commands

Type: array

CSSSTYLELINT: Define bash commands to run after running CSSSTYLELINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSS_STYLELINT: Pre-run commands

Type: array

CSSSTYLELINT: Define bash commands to run before running CSSSTYLELINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

CSS_STYLELINT: Custom config file path

Type: string

CSS_STYLELINT: Path where to find linter configuration file

CSS_STYLELINT: Timeout in seconds

Type: integer

CSSSTYLELINT: Maximum duration in seconds of the CSSSTYLELINT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

CSS_STYLELINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

C_CLANG_FORMAT: Custom arguments

Type: array of string or string

CCLANGFORMAT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

C_CLANG_FORMAT: CLI Executable

Type: array of string Default: [["clang-format"]]

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

No Additional Items

Each item of this array must be:

C_CLANG_FORMAT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"

C_CLANG_FORMAT: Custom remove arguments

Type: array of string or string

CCLANGFORMAT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

C_CLANG_FORMAT: Custom config file name

Type: string Default: ".clang-format"

CCLANGFORMAT: User custom config file name if different from default

C_CLANG_FORMAT: Disable errors

Type: boolean Default: false

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

C_CLANG_FORMAT: Maximum number of errors allowed

Type: number Default: 0

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

C_CLANG_FORMAT: Matching files extensions

Type: array of string Default: [".c", ".h"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

C_CLANG_FORMAT: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

C_CLANG_FORMAT: Excluding Regex

Type: string or array of string

C_CLANG_FORMAT: Including Regex

Type: string or array of string

C_CLANG_FORMAT: Post-run commands

Type: array

CCLANGFORMAT: Define bash commands to run after running CCLANGFORMAT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

C_CLANG_FORMAT: Pre-run commands

Type: array

CCLANGFORMAT: Define bash commands to run before running CCLANGFORMAT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

C_CLANG_FORMAT: Custom config file path

Type: string

CCLANGFORMAT: Path where to find linter configuration file

C_CLANG_FORMAT: Timeout in seconds

Type: integer

CCLANGFORMAT: Maximum duration in seconds of the CCLANGFORMAT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

C_CLANG_FORMAT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

C_CPPCHECK: Custom arguments

Type: array of string or string

C_CPPCHECK: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

C_CPPCHECK: CLI Executable

Type: array of string Default: [["cppcheck"]]

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

No Additional Items

Each item of this array must be:

C_CPPCHECK: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

C_CPPCHECK: Custom remove arguments

Type: array of string or string

C_CPPCHECK: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

C_CPPCHECK: Disable errors

Type: boolean Default: false

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

C_CPPCHECK: Maximum number of errors allowed

Type: number Default: 0

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

C_CPPCHECK: Matching files extensions

Type: array of string Default: [".c", ".h"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

C_CPPCHECK: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

C_CPPCHECK: Excluding Regex

Type: string or array of string

CCPPCHECK: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with CCPPCHECKCLILINT_MODE = project

C_CPPCHECK: Including Regex

Type: string or array of string

CCPPCHECK: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with CCPPCHECKCLILINT_MODE = project

C_CPPCHECK: Forward excluded directories in project lint mode

Type: boolean Default: true

C_CPPCHECK: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

C_CPPCHECK: Post-run commands

Type: array

CCPPCHECK: Define bash commands to run after running CCPPCHECK

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

C_CPPCHECK: Pre-run commands

Type: array

CCPPCHECK: Define bash commands to run before running CCPPCHECK

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

C_CPPCHECK: Timeout in seconds

Type: integer

CCPPCHECK: Maximum duration in seconds of the CCPPCHECK run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

C_CPPCHECK: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

C_CPPLINT: Custom arguments

Type: array of string or string

C_CPPLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

C_CPPLINT: CLI Executable

Type: array of string Default: [["cpplint"]]

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

No Additional Items

Each item of this array must be:

C_CPPLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"

C_CPPLINT: Custom remove arguments

Type: array of string or string

C_CPPLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

C_CPPLINT: Disable errors

Type: boolean Default: false

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

C_CPPLINT: Maximum number of errors allowed

Type: number Default: 0

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

C_CPPLINT: Matching files extensions

Type: array of string Default: [".c", ".h"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

C_CPPLINT: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

C_CPPLINT: Excluding Regex

Type: string or array of string

C_CPPLINT: Including Regex

Type: string or array of string

C_CPPLINT: Post-run commands

Type: array

CCPPLINT: Define bash commands to run after running CCPPLINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

C_CPPLINT: Pre-run commands

Type: array

CCPPLINT: Define bash commands to run before running CCPPLINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

C_CPPLINT: Timeout in seconds

Type: integer

CCPPLINT: Maximum duration in seconds of the CCPPLINT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

C_CPPLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for C descriptor

Type: string or array of string

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

Including regex filter for C descriptor

Type: string or array of string

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

Post commands for C descriptor

Type: array

C: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for C descriptor

Type: array

C: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

DART_DARTANALYZER: Custom arguments

Type: array of string or string

DART_DARTANALYZER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

DART_DARTANALYZER: CLI Executable

Type: array of string Default: [["dart"]]

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

No Additional Items

Each item of this array must be:

DART_DARTANALYZER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

DART_DARTANALYZER: Custom remove arguments

Type: array of string or string

DART_DARTANALYZER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

DART_DARTANALYZER: Custom config file name

Type: string Default: "analysis_options.yaml"

DART_DARTANALYZER: User custom config file name if different from default

DART_DARTANALYZER: Disable errors

Type: boolean Default: false

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

DART_DARTANALYZER: Maximum number of errors allowed

Type: number Default: 0

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

DART_DARTANALYZER: Matching files extensions

Type: array of string Default: [".dart"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

DART_DARTANALYZER: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

DART_DARTANALYZER: Excluding Regex

Type: string or array of string

DARTDARTANALYZER: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with DARTDARTANALYZERCLILINT_MODE = project

DART_DARTANALYZER: Including Regex

Type: string or array of string

DARTDARTANALYZER: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with DARTDARTANALYZERCLILINT_MODE = project

DART_DARTANALYZER: Forward excluded directories in project lint mode

Type: boolean Default: true

DART_DARTANALYZER: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

DART_DARTANALYZER: Post-run commands

Type: array

DARTDARTANALYZER: Define bash commands to run after running DARTDARTANALYZER

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

DART_DARTANALYZER: Pre-run commands

Type: array

DARTDARTANALYZER: Define bash commands to run before running DARTDARTANALYZER

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

DART_DARTANALYZER: Custom config file path

Type: string

DART_DARTANALYZER: Path where to find linter configuration file

DART_DARTANALYZER: Timeout in seconds

Type: integer

DARTDARTANALYZER: Maximum duration in seconds of the DARTDARTANALYZER run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

DART_DARTANALYZER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for DART descriptor

Type: string or array of string

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

Including regex filter for DART descriptor

Type: string or array of string

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

Post commands for DART descriptor

Type: array

DART: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for DART descriptor

Type: array

DART: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Default git branch

Type: string Default: "HEAD"

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


Examples:

"master"
"main"

Default Workspace

Type: string Default: "/tmp/lint"

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

Disabled descriptor keys

Type: array

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

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "ACTION"
  • "ANSIBLE"
  • "API"
  • "ARM"
  • "BASH"
  • "BICEP"
  • "C"
  • "CLOJURE"
  • "CLOUDFORMATION"
  • "COFFEE"
  • "COPYPASTE"
  • "CPP"
  • "CREDENTIALS"
  • "CSHARP"
  • "CSS"
  • "DART"
  • "DOCKERFILE"
  • "EDITORCONFIG"
  • "ENV"
  • "GHERKIN"
  • "GIT"
  • "GO"
  • "GRAPHQL"
  • "GROOVY"
  • "HTML"
  • "JAVA"
  • "JAVASCRIPT"
  • "JSON"
  • "JSX"
  • "KOTLIN"
  • "KUBERNETES"
  • "LATEX"
  • "LUA"
  • "MAKEFILE"
  • "MARKDOWN"
  • "OPENAPI"
  • "PERL"
  • "PHP"
  • "POWERSHELL"
  • "PROTOBUF"
  • "PUPPET"
  • "PYTHON"
  • "R"
  • "RAKU"
  • "REPOSITORY"
  • "ROBOTFRAMEWORK"
  • "RST"
  • "RUBY"
  • "RUST"
  • "SALESFORCE"
  • "SCALA"
  • "SNAKEMAKE"
  • "SPELL"
  • "SQL"
  • "SWIFT"
  • "TEKTON"
  • "TERRAFORM"
  • "TSX"
  • "TYPESCRIPT"
  • "VBDOTNET"
  • "XML"
  • "YAML"

Example:

[
    "BASH",
    "HTML"
]

Disable errors

Type: boolean Default: false

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

Disabled errors linter keys

Type: array

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

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ACTION_ZIZMOR"
  • "ANSIBLE_ANSIBLE_LINT"
  • "API_SPECTRAL"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "CLOJURE_CLJSTYLE"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CLANG_FORMAT"
  • "CPP_CPPCHECK"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_CSHARPIER"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_ROSLYNATOR"
  • "CSS_BIOME"
  • "CSS_SCSSLINT"
  • "CSS_SCSS_LINT"
  • "CSS_STYLELINT"
  • "C_CLANG_FORMAT"
  • "C_CPPCHECK"
  • "C_CPPLINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_DOCKERFILELINT"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GIT_GIT_DIFF"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_BIOME"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_BIOME"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_BIOME"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "JSX_BIOME"
  • "JSX_ESLINT"
  • "KOTLIN_DETEKT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_HELM"
  • "KUBERNETES_KUBECONFORM"
  • "KUBERNETES_KUBESCAPE"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "LUA_SELENE"
  • "LUA_STYLUA"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_RUMDL"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPCSFIXER"
  • "PHP_PHPLINT"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_BANDIT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_MYPY"
  • "PYTHON_NBQA_MYPY"
  • "PYTHON_PYLINT"
  • "PYTHON_PYRIGHT"
  • "PYTHON_RUFF"
  • "PYTHON_RUFF_FORMAT"
  • "RAKU_RAKU"
  • "REPOSITORY_BETTERLEAKS"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_GRYPE"
  • "REPOSITORY_KICS"
  • "REPOSITORY_KINGFISHER"
  • "REPOSITORY_LS_LINT"
  • "REPOSITORY_OSV_SCANNER"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "REPOSITORY_TRIVY_SBOM"
  • "REPOSITORY_TRUFFLEHOG"
  • "ROBOTFRAMEWORK_ROBOCOP"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RST_RST_LINT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "R_LINTR"
  • "SALESFORCE_CODE_ANALYZER_APEX"
  • "SALESFORCE_CODE_ANALYZER_APEXGURU"
  • "SALESFORCE_CODE_ANALYZER_AURA"
  • "SALESFORCE_CODE_ANALYZER_FLOW"
  • "SALESFORCE_CODE_ANALYZER_LWC"
  • "SALESFORCE_LIGHTNING_FLOW_SCANNER"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_CODESPELL"
  • "SPELL_CSPELL"
  • "SPELL_LYCHEE"
  • "SPELL_MISSPELL"
  • "SPELL_PROSELINT"
  • "SPELL_VALE"
  • "SQL_SQLFLUFF"
  • "SQL_SQL_LINT"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TFLINT"
  • "TERRAFORM_TOFU_FMT"
  • "TERRAFORM_TOFU_VALIDATE"
  • "TSX_BIOME"
  • "TSX_ESLINT"
  • "TYPESCRIPT_BIOME"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "BASH_BASH_SHFMT",
    "JAVASCRIPT_STANDARD"
]

Disabled linter keys

Type: array

If DISABLE_LINTERS is set, the listed linters will be skipped

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ACTION_ZIZMOR"
  • "ANSIBLE_ANSIBLE_LINT"
  • "API_SPECTRAL"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "CLOJURE_CLJSTYLE"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CLANG_FORMAT"
  • "CPP_CPPCHECK"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_CSHARPIER"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_ROSLYNATOR"
  • "CSS_BIOME"
  • "CSS_SCSSLINT"
  • "CSS_SCSS_LINT"
  • "CSS_STYLELINT"
  • "C_CLANG_FORMAT"
  • "C_CPPCHECK"
  • "C_CPPLINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_DOCKERFILELINT"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GIT_GIT_DIFF"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_BIOME"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_BIOME"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_BIOME"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "JSX_BIOME"
  • "JSX_ESLINT"
  • "KOTLIN_DETEKT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_HELM"
  • "KUBERNETES_KUBECONFORM"
  • "KUBERNETES_KUBESCAPE"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "LUA_SELENE"
  • "LUA_STYLUA"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_RUMDL"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPCSFIXER"
  • "PHP_PHPLINT"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_BANDIT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_MYPY"
  • "PYTHON_NBQA_MYPY"
  • "PYTHON_PYLINT"
  • "PYTHON_PYRIGHT"
  • "PYTHON_RUFF"
  • "PYTHON_RUFF_FORMAT"
  • "RAKU_RAKU"
  • "REPOSITORY_BETTERLEAKS"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_GRYPE"
  • "REPOSITORY_KICS"
  • "REPOSITORY_KINGFISHER"
  • "REPOSITORY_LS_LINT"
  • "REPOSITORY_OSV_SCANNER"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "REPOSITORY_TRIVY_SBOM"
  • "REPOSITORY_TRUFFLEHOG"
  • "ROBOTFRAMEWORK_ROBOCOP"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RST_RST_LINT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "R_LINTR"
  • "SALESFORCE_CODE_ANALYZER_APEX"
  • "SALESFORCE_CODE_ANALYZER_APEXGURU"
  • "SALESFORCE_CODE_ANALYZER_AURA"
  • "SALESFORCE_CODE_ANALYZER_FLOW"
  • "SALESFORCE_CODE_ANALYZER_LWC"
  • "SALESFORCE_LIGHTNING_FLOW_SCANNER"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_CODESPELL"
  • "SPELL_CSPELL"
  • "SPELL_LYCHEE"
  • "SPELL_MISSPELL"
  • "SPELL_PROSELINT"
  • "SPELL_VALE"
  • "SQL_SQLFLUFF"
  • "SQL_SQL_LINT"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TFLINT"
  • "TERRAFORM_TOFU_FMT"
  • "TERRAFORM_TOFU_VALIDATE"
  • "TSX_BIOME"
  • "TSX_ESLINT"
  • "TYPESCRIPT_BIOME"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "BASH_BASH_SHFMT",
    "JAVASCRIPT_STANDARD"
]

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Custom arguments

Type: array of string or string

DOCKERFILE_DOCKERFILELINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Custom config file name

Type: string Default: ".dockerfilelintrc"

DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Linter does not make MegaLinter fail even if errors are found

Type: boolean Default: false

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Maximum number of errors allowed

Type: number Default: 0

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Custom config file name

Type: string Default: ".dockerfilelintrc"

DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Excluding Regex

Type: string

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Including Regex

Type: string

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Define or override a list of bash commands to run after the linter

Type: array
No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Define or override a list of bash commands to run before the linter

Type: array
No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

(deprecated) (removed) DOCKERFILE_DOCKERFILELINT: Custom config file path

Type: string

DOCKERFILE_DOCKERFILELINT: Path where to find linter configuration file

Excluding regex filter for DOCKERFILE descriptor

Type: string or array of string

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

Including regex filter for DOCKERFILE descriptor

Type: string or array of string

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

DOCKERFILE_HADOLINT: Custom arguments

Type: array of string or string

DOCKERFILE_HADOLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

DOCKERFILE_HADOLINT: CLI Executable

Type: array of string Default: [["hadolint"]]

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

No Additional Items

Each item of this array must be:

DOCKERFILE_HADOLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"

DOCKERFILE_HADOLINT: Custom remove arguments

Type: array of string or string

DOCKERFILE_HADOLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

DOCKERFILE_HADOLINT: Custom config file name

Type: string Default: ".hadolint.yaml"

DOCKERFILE_HADOLINT: User custom config file name if different from default

DOCKERFILE_HADOLINT: Disable errors

Type: boolean Default: false

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

DOCKERFILE_HADOLINT: Maximum number of errors allowed

Type: number Default: 0

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

DOCKERFILE_HADOLINT: Matching files extensions

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

DOCKERFILE_HADOLINT: Matching file name regexes

Type: array of string Default: ["Containerfile", "(.*\\.)?Dockerfile"]

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

DOCKERFILE_HADOLINT: Excluding Regex

Type: string or array of string

DOCKERFILE_HADOLINT: Including Regex

Type: string or array of string

DOCKERFILE_HADOLINT: Post-run commands

Type: array

DOCKERFILEHADOLINT: Define bash commands to run after running DOCKERFILEHADOLINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

DOCKERFILE_HADOLINT: Pre-run commands

Type: array

DOCKERFILEHADOLINT: Define bash commands to run before running DOCKERFILEHADOLINT

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

DOCKERFILE_HADOLINT: Custom config file path

Type: string

DOCKERFILE_HADOLINT: Path where to find linter configuration file

DOCKERFILE_HADOLINT: Timeout in seconds

Type: integer

DOCKERFILEHADOLINT: Maximum duration in seconds of the DOCKERFILEHADOLINT run. When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124). Overrides LINTERTIMEOUTSECONDS (default: 300). Set 0 to disable the timeout


Examples:

3600
0

DOCKERFILE_HADOLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for DOCKERFILE descriptor

Type: array

DOCKERFILE: List of bash commands to run after the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

Pre commands for DOCKERFILE descriptor

Type: array

DOCKERFILE: List of bash commands to run before the linters

No Additional Items

Each item of this array must be:

Command

Type: object

Command information

Bash command to run

Type: string

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

Type: boolean Default: true

If the command fails, continue MegaLinter process

Folder where to run the command

Type: enum (of string) Default: "root"

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)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
"workspace"

Output ENV variables

Type: array of 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.

No Additional Items

Each item of this array must be:

Replacement ENV variables

Type: array of object

Copy the value of existing ENV variables into other ENV variables, only for the scope of this command. Useful to provide a specific credential to a single command without altering the environment of the other linters. Source values are read from the MegaLinter configuration, so they are sent to the command even if they are secured env variables.

No Additional Items

Each item of this array must be:

ENV variable replacement

Type: object
No Additional Properties

Target ENV variable

Type: string

Name of the ENV variable that will receive the value of var_src when running the command


Example:

"GITHUB_TOKEN"

Source ENV variable

Type: string

Name of the ENV variable whose value will be copied into var_dest


Example:

"MY_GITHUB_COM_TOKEN"

Secured ENV variables

Type: boolean Default: true

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.

Execution order tag

Type: enum (of string) Default: "default"

Select 'Before Plugins' if you need the command to be run before the MegaLinter plugins are initialized (rarely needed)

Must be one of:

  • "default"
  • "before_plugins"

Examples:

"default"
"before_plugins"

Python Virtual Env

Type: string

(Optional) Name of the Python virtual environment to use to run the command. Example: flake8 if you want to install a flake8 plugin.


Example:

"flake8"

Example:

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

EDITORCONFIG_EDITORCONFIG_CHECKER: Custom arguments

Type: array of string or string

EDITORCONFIGEDITORCONFIGCHECKER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

EDITORCONFIG_EDITORCONFIG_CHECKER: CLI Executable

Type: array of string Default: [["editorconfig-checker"]]

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

No Additional Items

Each item of this array must be:

EDITORCONFIG_EDITORCONFIG_CHECKER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

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

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

EDITORCONFIG_EDITORCONFIG_CHECKER: Custom remove arguments

Type: array of string or string

EDITORCONFIGEDITORCONFIGCHECKER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

EDITORCONFIG_EDITORCONFIG_CHECKER: Custom config file name

Type: string Default: ".editorconfig-checker.json"

EDITORCONFIGEDITORCONFIGCHECKER: User custom config file name if different from default

EDITORCONFIG_EDITORCONFIG_CHECKER: Disable errors

Type: boolean Default: false

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

EDITORCONFIG_EDITORCONFIG_CHECKER: Maximum number of errors allowed

Type: number Default: 0

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

EDITORCONFIG_EDITORCONFIG_CHECKER: Matching files extensions

Type: array of string Default: ["*"]

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

No Additional Items

Each item of this array must be:


Examples:

".py"
".myext"

EDITORCONFIG_EDITORCONFIG_CHECKER: Matching file name regexes

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

EDITORCONFIG_EDITORCONFIG_CHECKER: Excluding Regex

Type: string or array of string

EDITORCONFIGEDITORCONFIGCHECKER: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with EDITORCONFIGEDITORCONFIGCHECKERCLILINT_MODE = project

EDITORCONFIG_EDITORCONFIG_CHECKER: Including Regex

Type: string or array of string

EDITORCONFIGEDITORCONFIGCHECKER: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with EDITORCONFIGEDITORCONFIGCHECKERCLILINT_MODE = project

EDITORCONFIG_EDITORCONFIG_CHECKER: Forward excluded directories in project lint mode

Type: boolean Default: true

EDITORCONFIGEDITORCONFIGCHECKER: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files