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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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) 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

(deprecated) 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

(deprecated) 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:

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) 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:

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) 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

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

Type: string

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

Type: string

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

Type: string

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

Type: string

(deprecated) 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

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

Type: string

(deprecated) API reporter: log the payloads sent to the providers

Type: boolean Default: false

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

Type: boolean Default: true

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

Type: string

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

Type: string

(deprecated) API reporter (elastic): Elasticsearch endpoint URL

Type: string

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

Type: string

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

Type: string

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

Type: string

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

Type: string

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

Type: string

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

Type: string

(deprecated) API reporter: organization identifier added to all records

Type: string

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

Type: string

(deprecated) 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

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

Type: string

(deprecated) 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:

(deprecated) 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:

(deprecated) 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"

(deprecated) 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:

(deprecated) API_SPECTRAL: Custom config file name

Type: string Default: ".spectral.yaml"

API_SPECTRAL: User custom config file name if different from default

(deprecated) API_SPECTRAL: Disable errors

Type: boolean Default: false

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

(deprecated) 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

(deprecated) 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"

(deprecated) 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"

(deprecated) API_SPECTRAL: Excluding Regex

Type: string or array of string

(deprecated) API_SPECTRAL: Including Regex

Type: string or array of string

(deprecated) 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:

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) 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:

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) API_SPECTRAL: Custom config file path

Type: string

API_SPECTRAL: Path where to find linter configuration file

(deprecated) 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_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_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "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_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"
  • "TSX_ESLINT"
  • "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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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_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_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "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_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"
  • "TSX_ESLINT"
  • "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_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_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "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_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"
  • "TSX_ESLINT"
  • "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:

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:

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:

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:

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:

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:

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

EDITORCONFIG_EDITORCONFIG_CHECKER: Post-run commands

Type: array

EDITORCONFIGEDITORCONFIGCHECKER: Define bash commands to run after running EDITORCONFIGEDITORCONFIGCHECKER

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:

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"
    }
]

EDITORCONFIG_EDITORCONFIG_CHECKER: Pre-run commands

Type: array

EDITORCONFIGEDITORCONFIGCHECKER: Define bash commands to run before running EDITORCONFIGEDITORCONFIGCHECKER

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:

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"
    }
]

EDITORCONFIG_EDITORCONFIG_CHECKER: Custom config file path

Type: string

EDITORCONFIGEDITORCONFIGCHECKER: Path where to find linter configuration file

EDITORCONFIG_EDITORCONFIG_CHECKER: Timeout in seconds

Type: integer

EDITORCONFIGEDITORCONFIGCHECKER: Maximum duration in seconds of the EDITORCONFIGEDITORCONFIGCHECKER 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

EDITORCONFIG_EDITORCONFIG_CHECKER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for EDITORCONFIG descriptor

Type: string or array of string

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

Including regex filter for EDITORCONFIG descriptor

Type: string or array of string

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

Post commands for EDITORCONFIG descriptor

Type: array

EDITORCONFIG: 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:

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 EDITORCONFIG descriptor

Type: array

EDITORCONFIG: 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:

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 Email reporter

Type: boolean Default: true

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

Email reporter: E-mail addresses

Type: string

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

Email reporter: Sender of emails

Type: string Default: "megalinter@gmail.com"

Send email reports even when success

Type: boolean Default: false

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

Email reporter: SMTP server host

Type: string Default: "smtp.gmail.com"

Email reporter: SMTP server password. Never hardcode it in a config variable, use secrets and context variables

Type: string

Email reporter: SMTP server port

Type: number Default: "465"

Email reporter: SMTP username

Type: string Default: "megalinter@gmail.com"

Enabled descriptor keys

Type: array

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

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",
    "JAVASCRIPT"
]

ENABLE_LINTERS / DISABLE_LINTERS priority

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

Defines which list wins when a linter is present in both ENABLELINTERS and DISABLELINTERS. ENABLE (default) keeps the linter active, DISABLE lets DISABLELINTERS override ENABLELINTERS (useful to trim an inherited ENABLE_LINTERS list via EXTENDS)

Must be one of:

  • "ENABLE"
  • "DISABLE"

Enabled errors linter keys

Type: array

If ENABLEERRORSLINTERS is set, only the listed linters will be considered as 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_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_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "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_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"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "REPOSITORY_TRIVY",
    "REPOSITORY_GITLEAKS"
]

Enabled linter keys

Type: array

If ENABLE_LINTERS is set, only listed linters will be processed

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_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_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "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_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"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "JAVASCRIPT_ES",
    "PYTHON_PYLINT"
]

ENV_DOTENV_LINTER: Custom arguments

Type: array of string or string

ENVDOTENVLINTER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

ENV_DOTENV_LINTER: CLI Executable

Type: array of string Default: [["dotenv-linter"]]

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

No Additional Items

Each item of this array must be:

ENV_DOTENV_LINTER: CLI lint mode

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

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

Must be one of:

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

ENV_DOTENV_LINTER: Custom remove arguments

Type: array of string or string

ENVDOTENVLINTER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

ENV_DOTENV_LINTER: Disable errors

Type: boolean Default: false

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

ENV_DOTENV_LINTER: Maximum number of errors allowed

Type: number Default: 0

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

ENV_DOTENV_LINTER: Matching files extensions

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

ENVDOTENVLINTER: 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"

ENV_DOTENV_LINTER: Matching file name regexes

Type: array of string Default: []

ENVDOTENVLINTER: 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"

ENV_DOTENV_LINTER: Excluding Regex

Type: string or array of string

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

ENV_DOTENV_LINTER: Including Regex

Type: string or array of string

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

ENV_DOTENV_LINTER: Forward excluded directories in project lint mode

Type: boolean Default: true

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

ENV_DOTENV_LINTER: Post-run commands

Type: array

ENVDOTENVLINTER: Define bash commands to run after running ENVDOTENVLINTER

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:

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"
    }
]

ENV_DOTENV_LINTER: Pre-run commands

Type: array

ENVDOTENVLINTER: Define bash commands to run before running ENVDOTENVLINTER

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:

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"
    }
]

ENV_DOTENV_LINTER: Timeout in seconds

Type: integer

ENVDOTENVLINTER: Maximum duration in seconds of the ENVDOTENVLINTER 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

ENV_DOTENV_LINTER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for ENV descriptor

Type: string or array of string

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

Including regex filter for ENV descriptor

Type: string or array of string

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

Post commands for ENV descriptor

Type: array

ENV: 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:

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 ENV descriptor

Type: array

ENV: 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:

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"
    }
]

Disable errors for BASH-EXEC

Type: boolean Default: false

If set to false, the bash-exec linter will report a warning if a shell script is not executable. If set to true, the bash-exec linter will report an error instead

Excluded directories

Type: array of string

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

No Additional Items

Each item of this array must be:


Example:

[
    ".github",
    "node_modules"
]

MegaLinter config files to extend from

Type: array of string or string

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

No Additional Items

Each item of this array must be:

Type: string

Fail if missing linter

Type: boolean Default: false

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

Fail if updated sources

Type: boolean Default: false

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

Activate File.io reporter

Type: boolean Default: false

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

Skip file.io if success

Type: boolean Default: false

Skip posting to file.io if linting is in success

Excluding regex filter

Type: string or array of string

Regular expression(s) defining which files will be excluded from linting. Can be a single regex string or a list of regexes combined with a logical OR


Examples:

"(\\.automation/test|docs/javascripts|docs/overrides|flavors|clj-kondo|TEMPLATES)"
"(src/test)"
[
    "(src/test)",
    "(docs/overrides)"
]

Including regex filter

Type: string or array of string

Regular expression(s) defining which files will be processed by linters. Can be a single regex string or a list of regexes combined with a logical OR


Examples:

"(src/)"
[
    "(src/)",
    "(lib/)"
]

Flavor suggestions

Type: boolean Default: true

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

Disable errors when linter is a formatter

Type: boolean Default: true

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

Forward excluded directories to project lint mode linters

Type: boolean Default: true

In project CLI lint mode, forward excluded directories (EXCLUDEDDIRECTORIES + ADDITIONALEXCLUDEDDIRECTORIES) to the linters through their native exclusion arguments or generated ignore/config files. Can be overridden per-linter with <LINTER_KEY>FORWARDEXCLUDEDDIRECTORIES

Excluding regex filter for GHERKIN descriptor

Type: string or array of string

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

Including regex filter for GHERKIN descriptor

Type: string or array of string

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

GHERKIN_GHERKIN_LINT: Custom arguments

Type: array of string or string

GHERKINGHERKINLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

GHERKIN_GHERKIN_LINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

GHERKIN_GHERKIN_LINT: CLI lint mode

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

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

Must be one of:

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

GHERKIN_GHERKIN_LINT: Custom remove arguments

Type: array of string or string

GHERKINGHERKINLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

GHERKIN_GHERKIN_LINT: Custom config file name

Type: string Default: ".gherkin-lintrc"

GHERKINGHERKINLINT: User custom config file name if different from default

GHERKIN_GHERKIN_LINT: Disable errors

Type: boolean Default: false

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

GHERKIN_GHERKIN_LINT: Maximum number of errors allowed

Type: number Default: 0

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

GHERKIN_GHERKIN_LINT: Matching files extensions

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

GHERKINGHERKINLINT: 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"

GHERKIN_GHERKIN_LINT: Matching file name regexes

Type: array of string Default: []

GHERKINGHERKINLINT: 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"

GHERKIN_GHERKIN_LINT: Excluding Regex

Type: string or array of string

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

GHERKIN_GHERKIN_LINT: Including Regex

Type: string or array of string

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

GHERKIN_GHERKIN_LINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

GHERKIN_GHERKIN_LINT: Post-run commands

Type: array

GHERKINGHERKINLINT: Define bash commands to run after running GHERKINGHERKINLINT

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:

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"
    }
]

GHERKIN_GHERKIN_LINT: Pre-run commands

Type: array

GHERKINGHERKINLINT: Define bash commands to run before running GHERKINGHERKINLINT

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:

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"
    }
]

GHERKIN_GHERKIN_LINT: Custom config file path

Type: string

GHERKINGHERKINLINT: Path where to find linter configuration file

GHERKIN_GHERKIN_LINT: Timeout in seconds

Type: integer

GHERKINGHERKINLINT: Maximum duration in seconds of the GHERKINGHERKINLINT 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

GHERKIN_GHERKIN_LINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for GHERKIN descriptor

Type: array

GHERKIN: 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:

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 GHERKIN descriptor

Type: array

GHERKIN: 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:

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"
    }
]

GitHub API base URL

Type: stringFormat: uri Default: "https://api.github.com"

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


Example:

"https://github.my-company.com/api/v3"

Activate GitHub PR Comments reporter

Type: boolean Default: true

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

GitHub server base URL

Type: stringFormat: uri Default: "https://github.com"

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


Example:

"https://github.my-company.com/"

Activate GitHub Status reporter

Type: boolean Default: true

Posts a status on the pull request for each processed linter

GitHub Workspace

Type: string Default: "/tmp/lint"

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

Gitlab SSL Certificate path

Type: string Default: true

Path to SSL certificate if necessary

Activate Gitlab MR Comments reporter

Type: boolean Default: true

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

Overwrite Gitlab Merge Request Comment

Type: boolean Default: true

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

Excluding regex filter for GO descriptor

Type: string or array of string

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

Including regex filter for GO descriptor

Type: string or array of string

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

GO_GOLANGCI_LINT: Custom arguments

Type: array of string or string

GOGOLANGCILINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

GO_GOLANGCI_LINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

GO_GOLANGCI_LINT: CLI lint mode

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

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

Must be one of:

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

GO_GOLANGCI_LINT: Custom remove arguments

Type: array of string or string

GOGOLANGCILINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

GO_GOLANGCI_LINT: Custom config file name

Type: string Default: ".golangci.yml"

GOGOLANGCILINT: User custom config file name if different from default

GO_GOLANGCI_LINT: Disable errors

Type: boolean Default: false

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

GO_GOLANGCI_LINT: Maximum number of errors allowed

Type: number Default: 0

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

GO_GOLANGCI_LINT: Matching files extensions

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

GOGOLANGCILINT: 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"

GO_GOLANGCI_LINT: Matching file name regexes

Type: array of string Default: []

GOGOLANGCILINT: 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"

GO_GOLANGCI_LINT: Excluding Regex

Type: string or array of string

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

GO_GOLANGCI_LINT: Including Regex

Type: string or array of string

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

GO_GOLANGCI_LINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

GO_GOLANGCI_LINT: Post-run commands

Type: array

GOGOLANGCILINT: Define bash commands to run after running GOGOLANGCILINT

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:

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"
    }
]

GO_GOLANGCI_LINT: Pre-run commands

Type: array

GOGOLANGCILINT: Define bash commands to run before running GOGOLANGCILINT

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:

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"
    }
]

GO_GOLANGCI_LINT: Custom config file path

Type: string

GOGOLANGCILINT: Path where to find linter configuration file

GO_GOLANGCI_LINT: Timeout in seconds

Type: integer

GOGOLANGCILINT: Maximum duration in seconds of the GOGOLANGCILINT 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

GO_GOLANGCI_LINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for GO descriptor

Type: array

GO: 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:

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 GO descriptor

Type: array

GO: 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:

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"
    }
]

GO_REVIVE: Custom arguments

Type: array of string or string

GO_REVIVE: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

GO_REVIVE: CLI Executable

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

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

No Additional Items

Each item of this array must be:

GO_REVIVE: CLI lint mode

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

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

Must be one of:

  • "file"
  • "list_of_files"

GO_REVIVE: Custom remove arguments

Type: array of string or string

GO_REVIVE: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

GO_REVIVE: Custom config file name

Type: string Default: "revive.toml"

GO_REVIVE: User custom config file name if different from default

GO_REVIVE: Disable errors

Type: boolean Default: false

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

GO_REVIVE: Maximum number of errors allowed

Type: number Default: 0

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

GO_REVIVE: Matching files extensions

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

GO_REVIVE: 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"

GO_REVIVE: Matching file name regexes

Type: array of string Default: []

GO_REVIVE: 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"

GO_REVIVE: Excluding Regex

Type: string or array of string

GO_REVIVE: Including Regex

Type: string or array of string

GO_REVIVE: Post-run commands

Type: array

GOREVIVE: Define bash commands to run after running GOREVIVE

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:

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"
    }
]

GO_REVIVE: Pre-run commands

Type: array

GOREVIVE: Define bash commands to run before running GOREVIVE

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:

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"
    }
]

GO_REVIVE: Custom config file path

Type: string

GO_REVIVE: Path where to find linter configuration file

GO_REVIVE: Timeout in seconds

Type: integer

GOREVIVE: Maximum duration in seconds of the GOREVIVE 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

GO_REVIVE: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for GRAPHQL descriptor

Type: string or array of string

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

Including regex filter for GRAPHQL descriptor

Type: string or array of string

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

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom arguments

Type: array of string or string

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

GRAPHQL_GRAPHQL_SCHEMA_LINTER: CLI Executable

Type: array of string Default: [["graphql-schema-linter"]]

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

No Additional Items

Each item of this array must be:

GRAPHQL_GRAPHQL_SCHEMA_LINTER: CLI lint mode

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

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

Must be one of:

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

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom remove arguments

Type: array of string or string

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom config file name

Type: string Default: ".graphql-schema-linterrc"

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom config file name if different from default

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Disable errors

Type: boolean Default: false

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

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Maximum number of errors allowed

Type: number Default: 0

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

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Matching files extensions

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

GRAPHQLGRAPHQLSCHEMA_LINTER: 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"

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Matching file name regexes

Type: array of string Default: []

GRAPHQLGRAPHQLSCHEMA_LINTER: 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"

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Excluding Regex

Type: string or array of string

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

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Including Regex

Type: string or array of string

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

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Forward excluded directories in project lint mode

Type: boolean Default: true

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

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Post-run commands

Type: array

GRAPHQLGRAPHQLSCHEMALINTER: Define bash commands to run after running GRAPHQLGRAPHQLSCHEMALINTER

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:

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"
    }
]

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Pre-run commands

Type: array

GRAPHQLGRAPHQLSCHEMALINTER: Define bash commands to run before running GRAPHQLGRAPHQLSCHEMALINTER

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:

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"
    }
]

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom config file path

Type: string

GRAPHQLGRAPHQLSCHEMA_LINTER: Path where to find linter configuration file

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Timeout in seconds

Type: integer

GRAPHQLGRAPHQLSCHEMALINTER: Maximum duration in seconds of the GRAPHQLGRAPHQLSCHEMALINTER 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

GRAPHQL_GRAPHQL_SCHEMA_LINTER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for GRAPHQL descriptor

Type: array

GRAPHQL: 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:

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 GRAPHQL descriptor

Type: array

GRAPHQL: 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:

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 GROOVY descriptor

Type: string or array of string

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

Including regex filter for GROOVY descriptor

Type: string or array of string

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

GROOVY_NPM_GROOVY_LINT: Custom arguments

Type: array of string or string

GROOVYNPMGROOVY_LINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

GROOVY_NPM_GROOVY_LINT: CLI Executable

Type: array of string Default: [["npm-groovy-lint"]]

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

No Additional Items

Each item of this array must be:

GROOVY_NPM_GROOVY_LINT: CLI lint mode

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

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

Must be one of:

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

GROOVY_NPM_GROOVY_LINT: Custom remove arguments

Type: array of string or string

GROOVYNPMGROOVY_LINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

GROOVY_NPM_GROOVY_LINT: Custom config file name

Type: string Default: ".groovylintrc.json"

GROOVYNPMGROOVY_LINT: User custom config file name if different from default

GROOVY_NPM_GROOVY_LINT: Disable errors

Type: boolean Default: false

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

GROOVY_NPM_GROOVY_LINT: Maximum number of errors allowed

Type: number Default: 0

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

GROOVY_NPM_GROOVY_LINT: Matching files extensions

Type: array of string Default: [".groovy", ".gvy", ".gradle", ".nf"]

GROOVYNPMGROOVY_LINT: 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"

GROOVY_NPM_GROOVY_LINT: Matching file name regexes

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

GROOVYNPMGROOVY_LINT: 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"

GROOVY_NPM_GROOVY_LINT: Excluding Regex

Type: string or array of string

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

GROOVY_NPM_GROOVY_LINT: Including Regex

Type: string or array of string

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

GROOVY_NPM_GROOVY_LINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

GROOVY_NPM_GROOVY_LINT: Post-run commands

Type: array

GROOVYNPMGROOVYLINT: Define bash commands to run after running GROOVYNPMGROOVYLINT

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:

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"
    }
]

GROOVY_NPM_GROOVY_LINT: Pre-run commands

Type: array

GROOVYNPMGROOVYLINT: Define bash commands to run before running GROOVYNPMGROOVYLINT

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:

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"
    }
]

GROOVY_NPM_GROOVY_LINT: Custom config file path

Type: string

GROOVYNPMGROOVY_LINT: Path where to find linter configuration file

GROOVY_NPM_GROOVY_LINT: Timeout in seconds

Type: integer

GROOVYNPMGROOVYLINT: Maximum duration in seconds of the GROOVYNPMGROOVYLINT 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

GROOVY_NPM_GROOVY_LINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for GROOVY descriptor

Type: array

GROOVY: 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:

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 GROOVY descriptor

Type: array

GROOVY: 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:

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"
    }
]

HTML_DJLINT: Custom arguments

Type: array of string or string

HTML_DJLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

HTML_DJLINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

HTML_DJLINT: CLI lint mode

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

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

Must be one of:

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

HTML_DJLINT: Custom remove arguments

Type: array of string or string

HTML_DJLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

HTML_DJLINT: Disable errors

Type: boolean Default: false

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

HTML_DJLINT: Maximum number of errors allowed

Type: number Default: 0

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

HTML_DJLINT: Matching files extensions

Type: array of string Default: [".html", ".htm"]

HTML_DJLINT: 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"

HTML_DJLINT: Matching file name regexes

Type: array of string Default: []

HTML_DJLINT: 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"

HTML_DJLINT: Excluding Regex

Type: string or array of string

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

HTML_DJLINT: Including Regex

Type: string or array of string

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

HTML_DJLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

HTML_DJLINT: Post-run commands

Type: array

HTMLDJLINT: Define bash commands to run after running HTMLDJLINT

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:

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"
    }
]

HTML_DJLINT: Pre-run commands

Type: array

HTMLDJLINT: Define bash commands to run before running HTMLDJLINT

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:

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"
    }
]

HTML_DJLINT: Timeout in seconds

Type: integer

HTMLDJLINT: Maximum duration in seconds of the HTMLDJLINT 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

HTML_DJLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for HTML descriptor

Type: string or array of string

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

Including regex filter for HTML descriptor

Type: string or array of string

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

HTML_HTMLHINT: Custom arguments

Type: array of string or string

HTML_HTMLHINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

HTML_HTMLHINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

HTML_HTMLHINT: CLI lint mode

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

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

Must be one of:

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

HTML_HTMLHINT: Custom remove arguments

Type: array of string or string

HTML_HTMLHINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

HTML_HTMLHINT: Custom config file name

Type: string Default: ".htmlhintrc"

HTML_HTMLHINT: User custom config file name if different from default

HTML_HTMLHINT: Disable errors

Type: boolean Default: false

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

HTML_HTMLHINT: Maximum number of errors allowed

Type: number Default: 0

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

HTML_HTMLHINT: Matching files extensions

Type: array of string Default: [".html", ".htm"]

HTML_HTMLHINT: 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"

HTML_HTMLHINT: Matching file name regexes

Type: array of string Default: []

HTML_HTMLHINT: 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"

HTML_HTMLHINT: Excluding Regex

Type: string or array of string

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

HTML_HTMLHINT: Including Regex

Type: string or array of string

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

HTML_HTMLHINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

HTML_HTMLHINT: Post-run commands

Type: array

HTMLHTMLHINT: Define bash commands to run after running HTMLHTMLHINT

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:

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"
    }
]

HTML_HTMLHINT: Pre-run commands

Type: array

HTMLHTMLHINT: Define bash commands to run before running HTMLHTMLHINT

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:

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"
    }
]

HTML_HTMLHINT: Custom config file path

Type: string

HTML_HTMLHINT: Path where to find linter configuration file

HTML_HTMLHINT: Timeout in seconds

Type: integer

HTMLHTMLHINT: Maximum duration in seconds of the HTMLHTMLHINT 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

HTML_HTMLHINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for HTML descriptor

Type: array

HTML: 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:

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 HTML descriptor

Type: array

HTML: 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:

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"
    }
]

Ignore @generated files

Type: boolean Default: false

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

Ignore .gitignored files

Type: boolean Default: false

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

Javascript default style

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

Style of javascript formatting to apply

Must be one of:

  • "standard"
  • "prettier"

Examples:

"standard"
"prettier"

JAVASCRIPT_ES: Custom arguments

Type: array of string or string

JAVASCRIPT_ES: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

JAVASCRIPT_ES: CLI Executable

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

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

No Additional Items

Each item of this array must be:

JAVASCRIPT_ES: CLI lint mode

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

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

Must be one of:

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

JAVASCRIPT_ES: Custom remove arguments

Type: array of string or string

JAVASCRIPT_ES: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

JAVASCRIPT_ES: Custom config file name

Type: string Default: "eslint.config.js"

JAVASCRIPT_ES: User custom config file name if different from default

JAVASCRIPT_ES: Disable errors

Type: boolean Default: false

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

JAVASCRIPT_ES: Maximum number of errors allowed

Type: number Default: 0

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

JAVASCRIPT_ES: Matching files extensions

Type: array of string Default: [".js", ".vue"]

JAVASCRIPT_ES: 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"

JAVASCRIPT_ES: Matching file name regexes

Type: array of string Default: []

JAVASCRIPT_ES: 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"

JAVASCRIPT_ES: Excluding Regex

Type: string or array of string

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

JAVASCRIPT_ES: Including Regex

Type: string or array of string

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

JAVASCRIPT_ES: Forward excluded directories in project lint mode

Type: boolean Default: true

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

JAVASCRIPT_ES: Post-run commands

Type: array

JAVASCRIPTES: Define bash commands to run after running JAVASCRIPTES

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:

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"
    }
]

JAVASCRIPT_ES: Pre-run commands

Type: array

JAVASCRIPTES: Define bash commands to run before running JAVASCRIPTES

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:

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"
    }
]

JAVASCRIPT_ES: Custom config file path

Type: string

JAVASCRIPT_ES: Path where to find linter configuration file

JAVASCRIPT_ES: Timeout in seconds

Type: integer

JAVASCRIPTES: Maximum duration in seconds of the JAVASCRIPTES 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

JAVASCRIPT_ES: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for JAVASCRIPT descriptor

Type: string or array of string

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

Including regex filter for JAVASCRIPT descriptor

Type: string or array of string

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

Post commands for JAVASCRIPT descriptor

Type: array

JAVASCRIPT: 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:

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"
    }
]

JAVASCRIPT_PRETTIER: Custom arguments

Type: array of string or string

JAVASCRIPT_PRETTIER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

JAVASCRIPT_PRETTIER: CLI Executable

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

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

No Additional Items

Each item of this array must be:

JAVASCRIPT_PRETTIER: CLI lint mode

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

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

Must be one of:

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

JAVASCRIPT_PRETTIER: Custom remove arguments

Type: array of string or string

JAVASCRIPT_PRETTIER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

JAVASCRIPT_PRETTIER: Custom config file name

Type: string Default: ".prettierrc.json"

JAVASCRIPT_PRETTIER: User custom config file name if different from default

JAVASCRIPT_PRETTIER: Disable errors

Type: boolean Default: false

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

JAVASCRIPT_PRETTIER: Maximum number of errors allowed

Type: number Default: 0

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

JAVASCRIPT_PRETTIER: Matching files extensions

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

JAVASCRIPT_PRETTIER: 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"

JAVASCRIPT_PRETTIER: Matching file name regexes

Type: array of string Default: []

JAVASCRIPT_PRETTIER: 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"

JAVASCRIPT_PRETTIER: Excluding Regex

Type: string or array of string

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

JAVASCRIPT_PRETTIER: Including Regex

Type: string or array of string

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

JAVASCRIPT_PRETTIER: Forward excluded directories in project lint mode

Type: boolean Default: true

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

JAVASCRIPT_PRETTIER: Post-run commands

Type: array

JAVASCRIPTPRETTIER: Define bash commands to run after running JAVASCRIPTPRETTIER

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:

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"
    }
]

JAVASCRIPT_PRETTIER: Pre-run commands

Type: array

JAVASCRIPTPRETTIER: Define bash commands to run before running JAVASCRIPTPRETTIER

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:

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"
    }
]

JAVASCRIPT_PRETTIER: Custom config file path

Type: string

JAVASCRIPT_PRETTIER: Path where to find linter configuration file

JAVASCRIPT_PRETTIER: Timeout in seconds

Type: integer

JAVASCRIPTPRETTIER: Maximum duration in seconds of the JAVASCRIPTPRETTIER 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

JAVASCRIPT_PRETTIER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Pre commands for JAVASCRIPT descriptor

Type: array

JAVASCRIPT: 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:

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"
    }
]

JAVASCRIPT_STANDARD: Custom arguments

Type: array of string or string

JAVASCRIPT_STANDARD: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

JAVASCRIPT_STANDARD: CLI Executable

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

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

No Additional Items

Each item of this array must be:

JAVASCRIPT_STANDARD: CLI lint mode

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

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

Must be one of:

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

JAVASCRIPT_STANDARD: Custom remove arguments

Type: array of string or string

JAVASCRIPT_STANDARD: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

JAVASCRIPT_STANDARD: Disable errors

Type: boolean Default: false

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

JAVASCRIPT_STANDARD: Maximum number of errors allowed

Type: number Default: 0

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

JAVASCRIPT_STANDARD: Matching files extensions

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

JAVASCRIPT_STANDARD: 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"

JAVASCRIPT_STANDARD: Matching file name regexes

Type: array of string Default: []

JAVASCRIPT_STANDARD: 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"

JAVASCRIPT_STANDARD: Excluding Regex

Type: string or array of string

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

JAVASCRIPT_STANDARD: Including Regex

Type: string or array of string

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

JAVASCRIPT_STANDARD: Forward excluded directories in project lint mode

Type: boolean Default: true

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

JAVASCRIPT_STANDARD: Post-run commands

Type: array

JAVASCRIPTSTANDARD: Define bash commands to run after running JAVASCRIPTSTANDARD

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:

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"
    }
]

JAVASCRIPT_STANDARD: Pre-run commands

Type: array

JAVASCRIPTSTANDARD: Define bash commands to run before running JAVASCRIPTSTANDARD

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:

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"
    }
]

JAVASCRIPT_STANDARD: Timeout in seconds

Type: integer

JAVASCRIPTSTANDARD: Maximum duration in seconds of the JAVASCRIPTSTANDARD 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

JAVASCRIPT_STANDARD: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

JAVA_CHECKSTYLE: Custom arguments

Type: array of string or string

JAVA_CHECKSTYLE: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

JAVA_CHECKSTYLE: CLI Executable

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

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

No Additional Items

Each item of this array must be:

JAVA_CHECKSTYLE: CLI lint mode

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

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

Must be one of:

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

JAVA_CHECKSTYLE: Custom remove arguments

Type: array of string or string

JAVA_CHECKSTYLE: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

JAVA_CHECKSTYLE: Custom config file name

Type: string Default: "sun_checks.xml"

JAVA_CHECKSTYLE: User custom config file name if different from default

JAVA_CHECKSTYLE: Disable errors

Type: boolean Default: false

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

JAVA_CHECKSTYLE: Maximum number of errors allowed

Type: number Default: 0

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

JAVA_CHECKSTYLE: Matching files extensions

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

JAVA_CHECKSTYLE: 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"

JAVA_CHECKSTYLE: Matching file name regexes

Type: array of string Default: []

JAVA_CHECKSTYLE: 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"

JAVA_CHECKSTYLE: Excluding Regex

Type: string or array of string

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

JAVA_CHECKSTYLE: Including Regex

Type: string or array of string

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

JAVA_CHECKSTYLE: Forward excluded directories in project lint mode

Type: boolean Default: true

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

JAVA_CHECKSTYLE: Post-run commands

Type: array

JAVACHECKSTYLE: Define bash commands to run after running JAVACHECKSTYLE

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:

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"
    }
]

JAVA_CHECKSTYLE: Pre-run commands

Type: array

JAVACHECKSTYLE: Define bash commands to run before running JAVACHECKSTYLE

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:

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"
    }
]

JAVA_CHECKSTYLE: Custom config file path

Type: string

JAVA_CHECKSTYLE: Path where to find linter configuration file

JAVA_CHECKSTYLE: Timeout in seconds

Type: integer

JAVACHECKSTYLE: Maximum duration in seconds of the JAVACHECKSTYLE 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

JAVA_CHECKSTYLE: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for JAVA descriptor

Type: string or array of string

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

Including regex filter for JAVA descriptor

Type: string or array of string

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

JAVA_PMD: Custom arguments

Type: array of string or string

JAVA_PMD: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

JAVA_PMD: CLI Executable

Type: array of string Default: [["/usr/bin/pmd/bin/pmd"]]

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

No Additional Items

Each item of this array must be:

JAVA_PMD: CLI lint mode

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

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

Must be one of:

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

JAVA_PMD: Custom remove arguments

Type: array of string or string

JAVA_PMD: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

JAVA_PMD: Custom config file name

Type: string Default: "java-pmd-ruleset.xml"

JAVA_PMD: User custom config file name if different from default

JAVA_PMD: Disable errors

Type: boolean Default: false

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

JAVA_PMD: Maximum number of errors allowed

Type: number Default: 0

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

JAVA_PMD: Matching files extensions

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

JAVA_PMD: 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"

JAVA_PMD: Matching file name regexes

Type: array of string Default: []

JAVA_PMD: 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"

JAVA_PMD: Excluding Regex

Type: string or array of string

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

JAVA_PMD: Including Regex

Type: string or array of string

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

JAVA_PMD: Forward excluded directories in project lint mode

Type: boolean Default: true

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

JAVA_PMD: Post-run commands

Type: array

JAVAPMD: Define bash commands to run after running JAVAPMD

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:

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"
    }
]

JAVA_PMD: Pre-run commands

Type: array

JAVAPMD: Define bash commands to run before running JAVAPMD

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:

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"
    }
]

JAVA_PMD: Custom config file path

Type: string

JAVA_PMD: Path where to find linter configuration file

JAVA_PMD: Timeout in seconds

Type: integer

JAVAPMD: Maximum duration in seconds of the JAVAPMD 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

JAVA_PMD: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for JAVA descriptor

Type: array

JAVA: 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:

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 JAVA descriptor

Type: array

JAVA: 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:

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"
    }
]

Job Summary additional markdown

Type: string

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

(deprecated) JSON_ESLINT_PLUGIN_JSONC: Custom arguments

Type: array of string or string

JSONESLINTPLUGIN_JSONC: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) JSON_ESLINT_PLUGIN_JSONC: CLI Executable

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

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

No Additional Items

Each item of this array must be:

(deprecated) JSON_ESLINT_PLUGIN_JSONC: CLI lint mode

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

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

Must be one of:

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

(deprecated) JSON_ESLINT_PLUGIN_JSONC: Custom remove arguments

Type: array of string or string

JSONESLINTPLUGIN_JSONC: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) JSON_ESLINT_PLUGIN_JSONC: Custom config file name

Type: string Default: ".eslintrc-json.json"

JSONESLINTPLUGIN_JSONC: User custom config file name if different from default

(deprecated) JSON_ESLINT_PLUGIN_JSONC: Disable errors

Type: boolean Default: false

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

(deprecated) JSON_ESLINT_PLUGIN_JSONC: Maximum number of errors allowed

Type: number Default: 0

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

(deprecated) JSON_ESLINT_PLUGIN_JSONC: Matching files extensions

Type: array of string Default: [".json", ".json5", ".jsonc"]

JSONESLINTPLUGIN_JSONC: 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"

(deprecated) JSON_ESLINT_PLUGIN_JSONC: Matching file name regexes

Type: array of string Default: []

JSONESLINTPLUGIN_JSONC: 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"

(deprecated) JSON_ESLINT_PLUGIN_JSONC: Excluding Regex

Type: string or array of string

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

(deprecated) JSON_ESLINT_PLUGIN_JSONC: Including Regex

Type: string or array of string

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

(deprecated) JSON_ESLINT_PLUGIN_JSONC: Post-run commands

Type: array

(deprecated) JSONESLINTPLUGINJSONC: Define bash commands to run after running JSONESLINTPLUGINJSONC

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:

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) JSON_ESLINT_PLUGIN_JSONC: Pre-run commands

Type: array

(deprecated) JSONESLINTPLUGINJSONC: Define bash commands to run before running JSONESLINTPLUGINJSONC

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:

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) JSON_ESLINT_PLUGIN_JSONC: Custom config file path

Type: string

JSONESLINTPLUGIN_JSONC: Path where to find linter configuration file

(deprecated) JSON_ESLINT_PLUGIN_JSONC: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for JSON descriptor

Type: string or array of string

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

Including regex filter for JSON descriptor

Type: string or array of string

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

JSON_JSONLINT: Custom arguments

Type: array of string or string

JSON_JSONLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

JSON_JSONLINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

JSON_JSONLINT: CLI lint mode

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

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

Must be one of:

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

JSON_JSONLINT: Custom remove arguments

Type: array of string or string

JSON_JSONLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

JSON_JSONLINT: Custom config file name

Type: string Default: ".jsonlintrc"

JSON_JSONLINT: User custom config file name if different from default

JSON_JSONLINT: Disable errors

Type: boolean Default: false

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

JSON_JSONLINT: Maximum number of errors allowed

Type: number Default: 0

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

JSON_JSONLINT: Matching files extensions

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

JSON_JSONLINT: 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"

JSON_JSONLINT: Matching file name regexes

Type: array of string Default: []

JSON_JSONLINT: 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"

JSON_JSONLINT: Excluding Regex

Type: string or array of string

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

JSON_JSONLINT: Including Regex

Type: string or array of string

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

JSON_JSONLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

JSON_JSONLINT: Post-run commands

Type: array

JSONJSONLINT: Define bash commands to run after running JSONJSONLINT

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:

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"
    }
]

JSON_JSONLINT: Pre-run commands

Type: array

JSONJSONLINT: Define bash commands to run before running JSONJSONLINT

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:

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"
    }
]

JSON_JSONLINT: Custom config file path

Type: string

JSON_JSONLINT: Path where to find linter configuration file

JSON_JSONLINT: Timeout in seconds

Type: integer

JSONJSONLINT: Maximum duration in seconds of the JSONJSONLINT 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

JSON_JSONLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

JSON_NPM_PACKAGE_JSON_LINT: Custom arguments

Type: array of string or string

JSONNPMPACKAGEJSONLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

JSON_NPM_PACKAGE_JSON_LINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

JSON_NPM_PACKAGE_JSON_LINT: CLI lint mode

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

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

Must be one of:

  • "project"

JSON_NPM_PACKAGE_JSON_LINT: Custom remove arguments

Type: array of string or string

JSONNPMPACKAGEJSONLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

JSON_NPM_PACKAGE_JSON_LINT: Custom config file name

Type: string Default: ".npmpackagejsonlintrc.json"

JSONNPMPACKAGEJSONLINT: User custom config file name if different from default

JSON_NPM_PACKAGE_JSON_LINT: Disable errors

Type: boolean Default: false

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

JSON_NPM_PACKAGE_JSON_LINT: Maximum number of errors allowed

Type: number Default: 0

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

JSON_NPM_PACKAGE_JSON_LINT: Matching files extensions

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

JSONNPMPACKAGEJSONLINT: 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"

JSON_NPM_PACKAGE_JSON_LINT: Matching file name regexes

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

JSONNPMPACKAGEJSONLINT: 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"

JSON_NPM_PACKAGE_JSON_LINT: Excluding Regex

Type: string or array of string

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

JSON_NPM_PACKAGE_JSON_LINT: Including Regex

Type: string or array of string

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

JSON_NPM_PACKAGE_JSON_LINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

JSON_NPM_PACKAGE_JSON_LINT: Post-run commands

Type: array

JSONNPMPACKAGEJSONLINT: Define bash commands to run after running JSONNPMPACKAGEJSONLINT

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:

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"
    }
]

JSON_NPM_PACKAGE_JSON_LINT: Pre-run commands

Type: array

JSONNPMPACKAGEJSONLINT: Define bash commands to run before running JSONNPMPACKAGEJSONLINT

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:

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"
    }
]

JSON_NPM_PACKAGE_JSON_LINT: Custom config file path

Type: string

JSONNPMPACKAGEJSONLINT: Path where to find linter configuration file

JSON_NPM_PACKAGE_JSON_LINT: Timeout in seconds

Type: integer

JSONNPMPACKAGEJSONLINT: Maximum duration in seconds of the JSONNPMPACKAGEJSONLINT 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

JSON_NPM_PACKAGE_JSON_LINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for JSON descriptor

Type: array

JSON: 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:

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"
    }
]

JSON_PRETTIER: Custom arguments

Type: array of string or string

JSON_PRETTIER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

JSON_PRETTIER: CLI Executable

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

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

No Additional Items

Each item of this array must be:

JSON_PRETTIER: CLI lint mode

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

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

Must be one of:

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

JSON_PRETTIER: Custom remove arguments

Type: array of string or string

JSON_PRETTIER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

JSON_PRETTIER: Custom config file name

Type: string Default: ".prettierrc.json"

JSON_PRETTIER: User custom config file name if different from default

JSON_PRETTIER: Disable errors

Type: boolean Default: false

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

JSON_PRETTIER: Maximum number of errors allowed

Type: number Default: 0

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

JSON_PRETTIER: Matching files extensions

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

JSON_PRETTIER: 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"

JSON_PRETTIER: Matching file name regexes

Type: array of string Default: []

JSON_PRETTIER: 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"

JSON_PRETTIER: Excluding Regex

Type: string or array of string

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

JSON_PRETTIER: Including Regex

Type: string or array of string

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

JSON_PRETTIER: Forward excluded directories in project lint mode

Type: boolean Default: true

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

JSON_PRETTIER: Post-run commands

Type: array

JSONPRETTIER: Define bash commands to run after running JSONPRETTIER

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:

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"
    }
]

JSON_PRETTIER: Pre-run commands

Type: array

JSONPRETTIER: Define bash commands to run before running JSONPRETTIER

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:

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"
    }
]

JSON_PRETTIER: Custom config file path

Type: string

JSON_PRETTIER: Path where to find linter configuration file

JSON_PRETTIER: Timeout in seconds

Type: integer

JSONPRETTIER: Maximum duration in seconds of the JSONPRETTIER 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

JSON_PRETTIER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Pre commands for JSON descriptor

Type: array

JSON: 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:

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"
    }
]

JSON reporter

Type: boolean Default: false

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

JSON reporter output detail

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

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

Must be one of:

  • "simple"
  • "detailed"

JSON_V8R: Custom arguments

Type: array of string or string

JSON_V8R: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

JSON_V8R: CLI Executable

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

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

No Additional Items

Each item of this array must be:

JSON_V8R: CLI lint mode

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

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

Must be one of:

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

JSON_V8R: Custom remove arguments

Type: array of string or string

JSON_V8R: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

JSON_V8R: Custom config file name

Type: string Default: ".v8rrc.yml"

JSON_V8R: User custom config file name if different from default

JSON_V8R: Disable errors

Type: boolean Default: false

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

JSON_V8R: Maximum number of errors allowed

Type: number Default: 0

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

JSON_V8R: Matching files extensions

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

JSON_V8R: 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"

JSON_V8R: Matching file name regexes

Type: array of string Default: []

JSON_V8R: 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"

JSON_V8R: Excluding Regex

Type: string or array of string

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

JSON_V8R: Including Regex

Type: string or array of string

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

JSON_V8R: Forward excluded directories in project lint mode

Type: boolean Default: true

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

JSON_V8R: Post-run commands

Type: array

JSONV8R: Define bash commands to run after running JSONV8R

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:

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"
    }
]

JSON_V8R: Pre-run commands

Type: array

JSONV8R: Define bash commands to run before running JSONV8R

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:

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"
    }
]

JSON_V8R: Custom config file path

Type: string

JSON_V8R: Path where to find linter configuration file

JSON_V8R: Timeout in seconds

Type: integer

JSONV8R: Maximum duration in seconds of the JSONV8R 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

JSON_V8R: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

JSX_ESLINT: Custom arguments

Type: array of string or string

JSX_ESLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

JSX_ESLINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

JSX_ESLINT: CLI lint mode

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

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

Must be one of:

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

JSX_ESLINT: Custom remove arguments

Type: array of string or string

JSX_ESLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

JSX_ESLINT: Custom config file name

Type: string Default: "eslint.config.cjs"

JSX_ESLINT: User custom config file name if different from default

JSX_ESLINT: Disable errors

Type: boolean Default: false

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

JSX_ESLINT: Maximum number of errors allowed

Type: number Default: 0

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

JSX_ESLINT: Matching files extensions

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

JSX_ESLINT: 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"

JSX_ESLINT: Matching file name regexes

Type: array of string Default: []

JSX_ESLINT: 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"

JSX_ESLINT: Excluding Regex

Type: string or array of string

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

JSX_ESLINT: Including Regex

Type: string or array of string

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

JSX_ESLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

JSX_ESLINT: Post-run commands

Type: array

JSXESLINT: Define bash commands to run after running JSXESLINT

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:

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"
    }
]

JSX_ESLINT: Pre-run commands

Type: array

JSXESLINT: Define bash commands to run before running JSXESLINT

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:

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"
    }
]

JSX_ESLINT: Custom config file path

Type: string

JSX_ESLINT: Path where to find linter configuration file

JSX_ESLINT: Timeout in seconds

Type: integer

JSXESLINT: Maximum duration in seconds of the JSXESLINT 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

JSX_ESLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for JSX descriptor

Type: string or array of string

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

Including regex filter for JSX descriptor

Type: string or array of string

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

Post commands for JSX descriptor

Type: array

JSX: 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:

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 JSX descriptor

Type: array

JSX: 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:

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"
    }
]

KOTLIN_DETEKT: Custom arguments

Type: array of string or string

KOTLIN_DETEKT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

KOTLIN_DETEKT: CLI Executable

Type: array of string Default: [["detekt-cli"]]

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

No Additional Items

Each item of this array must be:

KOTLIN_DETEKT: CLI lint mode

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

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

Must be one of:

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

KOTLIN_DETEKT: Custom remove arguments

Type: array of string or string

KOTLIN_DETEKT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

KOTLIN_DETEKT: Custom config file name

Type: string Default: "detekt-config.yml"

KOTLIN_DETEKT: User custom config file name if different from default

KOTLIN_DETEKT: Disable errors

Type: boolean Default: false

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

KOTLIN_DETEKT: Maximum number of errors allowed

Type: number Default: 0

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

KOTLIN_DETEKT: Matching files extensions

Type: array of string Default: [".kt", ".kts"]

KOTLIN_DETEKT: 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"

KOTLIN_DETEKT: Matching file name regexes

Type: array of string Default: []

KOTLIN_DETEKT: 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"

KOTLIN_DETEKT: Excluding Regex

Type: string or array of string

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

KOTLIN_DETEKT: Including Regex

Type: string or array of string

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

KOTLIN_DETEKT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

KOTLIN_DETEKT: Post-run commands

Type: array

KOTLINDETEKT: Define bash commands to run after running KOTLINDETEKT

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:

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"
    }
]

KOTLIN_DETEKT: Pre-run commands

Type: array

KOTLINDETEKT: Define bash commands to run before running KOTLINDETEKT

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:

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"
    }
]

KOTLIN_DETEKT: Custom config file path

Type: string

KOTLIN_DETEKT: Path where to find linter configuration file

KOTLIN_DETEKT: Timeout in seconds

Type: integer

KOTLINDETEKT: Maximum duration in seconds of the KOTLINDETEKT 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

KOTLIN_DETEKT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for KOTLIN descriptor

Type: string or array of string

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

Including regex filter for KOTLIN descriptor

Type: string or array of string

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

KOTLIN_KTLINT: Custom arguments

Type: array of string or string

KOTLIN_KTLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

KOTLIN_KTLINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

KOTLIN_KTLINT: CLI lint mode

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

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

Must be one of:

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

KOTLIN_KTLINT: Custom remove arguments

Type: array of string or string

KOTLIN_KTLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

KOTLIN_KTLINT: Disable errors

Type: boolean Default: false

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

KOTLIN_KTLINT: Maximum number of errors allowed

Type: number Default: 0

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

KOTLIN_KTLINT: Matching files extensions

Type: array of string Default: [".kt", ".kts"]

KOTLIN_KTLINT: 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"

KOTLIN_KTLINT: Matching file name regexes

Type: array of string Default: []

KOTLIN_KTLINT: 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"

KOTLIN_KTLINT: Excluding Regex

Type: string or array of string

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

KOTLIN_KTLINT: Including Regex

Type: string or array of string

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

KOTLIN_KTLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

KOTLIN_KTLINT: Post-run commands

Type: array

KOTLINKTLINT: Define bash commands to run after running KOTLINKTLINT

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:

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"
    }
]

KOTLIN_KTLINT: Pre-run commands

Type: array

KOTLINKTLINT: Define bash commands to run before running KOTLINKTLINT

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:

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"
    }
]

KOTLIN_KTLINT: Timeout in seconds

Type: integer

KOTLINKTLINT: Maximum duration in seconds of the KOTLINKTLINT 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

KOTLIN_KTLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for KOTLIN descriptor

Type: array

KOTLIN: 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:

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 KOTLIN descriptor

Type: array

KOTLIN: 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:

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"
    }
]

Directory containing KUBERNETES files

Type: string

Excluding regex filter for KUBERNETES descriptor

Type: string or array of string

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

Including regex filter for KUBERNETES descriptor

Type: string or array of string

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

KUBERNETES_HELM: Custom arguments

Type: array of string or string

KUBERNETES_HELM: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

KUBERNETES_HELM: CLI Executable

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

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

No Additional Items

Each item of this array must be:

KUBERNETES_HELM: CLI lint mode

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

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

Must be one of:

  • "project"

KUBERNETES_HELM: Custom remove arguments

Type: array of string or string

KUBERNETES_HELM: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

KUBERNETES_HELM: Directory containing KUBERNETES files

Type: string Default: ""

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

KUBERNETES_HELM: Disable errors

Type: boolean Default: false

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

KUBERNETES_HELM: Maximum number of errors allowed

Type: number Default: 0

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

KUBERNETES_HELM: Matching files extensions

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

KUBERNETES_HELM: 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"

KUBERNETES_HELM: Matching file name regexes

Type: array of string Default: []

KUBERNETES_HELM: 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"

KUBERNETES_HELM: Excluding Regex

Type: string or array of string

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

KUBERNETES_HELM: Including Regex

Type: string or array of string

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

KUBERNETES_HELM: Forward excluded directories in project lint mode

Type: boolean Default: true

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

KUBERNETES_HELM: Post-run commands

Type: array

KUBERNETESHELM: Define bash commands to run after running KUBERNETESHELM

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:

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"
    }
]

KUBERNETES_HELM: Pre-run commands

Type: array

KUBERNETESHELM: Define bash commands to run before running KUBERNETESHELM

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:

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"
    }
]

KUBERNETES_HELM: Timeout in seconds

Type: integer

KUBERNETESHELM: Maximum duration in seconds of the KUBERNETESHELM 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

KUBERNETES_HELM: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

KUBERNETES_KUBECONFORM: Custom arguments

Type: array of string or string

KUBERNETES_KUBECONFORM: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

KUBERNETES_KUBECONFORM: CLI Executable

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

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

No Additional Items

Each item of this array must be:

KUBERNETES_KUBECONFORM: CLI lint mode

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

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

Must be one of:

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

KUBERNETES_KUBECONFORM: Custom remove arguments

Type: array of string or string

KUBERNETES_KUBECONFORM: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

KUBERNETES_KUBECONFORM: Directory containing KUBERNETES files

Type: string Default: "kubernetes"

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

KUBERNETES_KUBECONFORM: Disable errors

Type: boolean Default: false

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

KUBERNETES_KUBECONFORM: Maximum number of errors allowed

Type: number Default: 0

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

KUBERNETES_KUBECONFORM: Matching files extensions

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

KUBERNETES_KUBECONFORM: 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"

KUBERNETES_KUBECONFORM: Matching file name regexes

Type: array of string Default: []

KUBERNETES_KUBECONFORM: 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"

KUBERNETES_KUBECONFORM: Excluding Regex

Type: string or array of string

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

KUBERNETES_KUBECONFORM: Including Regex

Type: string or array of string

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

KUBERNETES_KUBECONFORM: Forward excluded directories in project lint mode

Type: boolean Default: true

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

KUBERNETES_KUBECONFORM: Post-run commands

Type: array

KUBERNETESKUBECONFORM: Define bash commands to run after running KUBERNETESKUBECONFORM

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:

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"
    }
]

KUBERNETES_KUBECONFORM: Pre-run commands

Type: array

KUBERNETESKUBECONFORM: Define bash commands to run before running KUBERNETESKUBECONFORM

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:

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"
    }
]

KUBERNETES_KUBECONFORM: Timeout in seconds

Type: integer

KUBERNETESKUBECONFORM: Maximum duration in seconds of the KUBERNETESKUBECONFORM 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

KUBERNETES_KUBECONFORM: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

KUBERNETES_KUBESCAPE: Custom arguments

Type: array of string or string

KUBERNETES_KUBESCAPE: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

KUBERNETES_KUBESCAPE: CLI Executable

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

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

No Additional Items

Each item of this array must be:

KUBERNETES_KUBESCAPE: CLI lint mode

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

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

Must be one of:

  • "project"

KUBERNETES_KUBESCAPE: Custom remove arguments

Type: array of string or string

KUBERNETES_KUBESCAPE: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

KUBERNETES_KUBESCAPE: Directory containing KUBERNETES files

Type: string Default: ""

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

KUBERNETES_KUBESCAPE: Disable errors

Type: boolean Default: false

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

KUBERNETES_KUBESCAPE: Maximum number of errors allowed

Type: number Default: 0

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

KUBERNETES_KUBESCAPE: Matching files extensions

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

KUBERNETES_KUBESCAPE: 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"

KUBERNETES_KUBESCAPE: Matching file name regexes

Type: array of string Default: []

KUBERNETES_KUBESCAPE: 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"

KUBERNETES_KUBESCAPE: Excluding Regex

Type: string or array of string

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

KUBERNETES_KUBESCAPE: Including Regex

Type: string or array of string

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

KUBERNETES_KUBESCAPE: Forward excluded directories in project lint mode

Type: boolean Default: true

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

KUBERNETES_KUBESCAPE: Post-run commands

Type: array

KUBERNETESKUBESCAPE: Define bash commands to run after running KUBERNETESKUBESCAPE

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:

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"
    }
]

KUBERNETES_KUBESCAPE: Pre-run commands

Type: array

KUBERNETESKUBESCAPE: Define bash commands to run before running KUBERNETESKUBESCAPE

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:

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"
    }
]

KUBERNETES_KUBESCAPE: Timeout in seconds

Type: integer

KUBERNETESKUBESCAPE: Maximum duration in seconds of the KUBERNETESKUBESCAPE 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

KUBERNETES_KUBESCAPE: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

(deprecated) (removed) KUBERNETES_KUBEVAL: Custom arguments

Type: array of string or string

KUBERNETES_KUBEVAL: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) (removed) KUBERNETES_KUBEVAL: CLI Executable

Type: array of string Default: [["kubeval"]]
No Additional Items

Each item of this array must be:

(deprecated) (removed) KUBERNETES_KUBEVAL: Override default cli lint mode

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

Must be one of:

  • "file"
  • "project"

(deprecated) (removed) KUBERNETES_KUBEVAL: Directory containing KUBERNETES files

Type: string Default: "kubernetes"

(deprecated) (removed) KUBERNETES_KUBEVAL: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

(deprecated) (removed) KUBERNETES_KUBEVAL: Maximum number of errors allowed

Type: number Default: 0

(deprecated) (removed) KUBERNETES_KUBEVAL: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

(deprecated) (removed) KUBERNETES_KUBEVAL: 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) KUBERNETES_KUBEVAL: Excluding Regex

Type: string

(deprecated) (removed) KUBERNETES_KUBEVAL: Including Regex

Type: string

(deprecated) (removed) KUBERNETES_KUBEVAL: 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:

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) KUBERNETES_KUBEVAL: 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:

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"
    }
]

Post commands for KUBERNETES descriptor

Type: array

KUBERNETES: 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:

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 KUBERNETES descriptor

Type: array

KUBERNETES: 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:

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"
    }
]

LATEX_CHKTEX: Custom arguments

Type: array of string or string

LATEX_CHKTEX: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

LATEX_CHKTEX: CLI Executable

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

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

No Additional Items

Each item of this array must be:

LATEX_CHKTEX: CLI lint mode

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

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

Must be one of:

  • "file"

LATEX_CHKTEX: Custom remove arguments

Type: array of string or string

LATEX_CHKTEX: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

LATEX_CHKTEX: Custom config file name

Type: string Default: ".chktexrc"

LATEX_CHKTEX: User custom config file name if different from default

LATEX_CHKTEX: Disable errors

Type: boolean Default: false

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

LATEX_CHKTEX: Maximum number of errors allowed

Type: number Default: 0

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

LATEX_CHKTEX: Matching files extensions

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

LATEX_CHKTEX: 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"

LATEX_CHKTEX: Matching file name regexes

Type: array of string Default: []

LATEX_CHKTEX: 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"

LATEX_CHKTEX: Excluding Regex

Type: string or array of string

LATEX_CHKTEX: Including Regex

Type: string or array of string

LATEX_CHKTEX: Post-run commands

Type: array

LATEXCHKTEX: Define bash commands to run after running LATEXCHKTEX

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:

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"
    }
]

LATEX_CHKTEX: Pre-run commands

Type: array

LATEXCHKTEX: Define bash commands to run before running LATEXCHKTEX

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:

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"
    }
]

LATEX_CHKTEX: Custom config file path

Type: string

LATEX_CHKTEX: Path where to find linter configuration file

LATEX_CHKTEX: Timeout in seconds

Type: integer

LATEXCHKTEX: Maximum duration in seconds of the LATEXCHKTEX 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

LATEX_CHKTEX: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for LATEX descriptor

Type: string or array of string

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

Including regex filter for LATEX descriptor

Type: string or array of string

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

Post commands for LATEX descriptor

Type: array

LATEX: 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:

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 LATEX descriptor

Type: array

LATEX: 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:

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"
    }
]

Linter rules path

Type: string Default: ".github/linters"

Directory for all linter configuration rules. Can be a local folder or a remote URL. Not necessary if your linters configuration files are at the root of your repository


Examples:

"myrulesfolder"
"https://raw.githubusercontent.com/some_org/some_repo/mega-linter-rules"

Linter timeout in seconds

Type: integer Default: 300

Maximum duration in seconds of each linter run (default: 300). When elapsed, the linter process and its child processes are killed and reported as an error (exit code 124), and the other linters keep running. Can be overridden for a single linter with <LINTER_KEY>TIMEOUTSECONDS. Set 0 to disable the timeout


Examples:

3600
0

LLM Advisor Disabled linter keys

Type: array

If LLMADVISORDISABLE_LINTERS is set, LLM advisor will NOT process these ones

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_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_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "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_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"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "JAVASCRIPT_ES",
    "PYTHON_PYLINT"
]

LLM Advisor enabled

Type: boolean Default: false

Enable AI-powered fix suggestions using Large Language Models


Examples:

true
false

LLM Advisor Enabled linter keys

Type: array

If LLMADVISORENABLE_LINTERS is set, LLM advisor will only process these ones

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_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_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "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_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"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "JAVASCRIPT_ES",
    "PYTHON_PYLINT"
]

LLM Advisor trigger level

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

When to trigger AI suggestions: ERROR (only for blocking linters with return_code != 0) or WARNING (for both blocking and non-blocking linters)

Must be one of:

  • "ERROR"
  • "WARNING"

Examples:

"ERROR"
"WARNING"

LLM Advisor trigger level

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

Display LLM Advisor suggestions before or after linter output

Must be one of:

  • "after_linter_output"
  • "before_linter_output"

Examples:

"after_linter_output"
"before_linter_output"

LLM maximum tokens

Type: string Default: "1000"

Maximum number of tokens for LLM response


Examples:

"500"
"1000"
"2000"

LLM model name

Type: string

Name of the LLM model to use (provider-specific)


Examples:

"gpt-3.5-turbo"
"gpt-4"
"claude-3-haiku-20240307"
"gemini-pro"

LLM provider

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

LLM provider to use for AI suggestions

Must be one of:

  • "openai"
  • "anthropic"
  • "google"
  • "huggingface"
  • "mistral"
  • "deepseek"
  • "grok"
  • "ollama"

Examples:

"openai"
"anthropic"
"google"
"ollama"

LLM temperature

Type: string Default: "0.1"

Temperature for LLM generation (0.0 = deterministic, 1.0 = creative)


Examples:

"0.0"
"0.1"
"0.5"
"1.0"

Log file name

Type: string Default: "mega-linter.log"

The file name for outputting logs. All output is sent to the log file regardless of LOG_LEVEL

Log level

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

How much output the script will generate to the console. One of INFO, DEBUG, WARNING or ERROR.

Must be one of:

  • "INFO"
  • "DEBUG"
  • "WARNING"
  • "ERROR"

Excluding regex filter for LUA descriptor

Type: string or array of string

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

Including regex filter for LUA descriptor

Type: string or array of string

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

LUA_LUACHECK: Custom arguments

Type: array of string or string

LUA_LUACHECK: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

LUA_LUACHECK: CLI Executable

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

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

No Additional Items

Each item of this array must be:

LUA_LUACHECK: CLI lint mode

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

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

Must be one of:

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

LUA_LUACHECK: Custom remove arguments

Type: array of string or string

LUA_LUACHECK: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

LUA_LUACHECK: Custom config file name

Type: string Default: ".luacheckrc"

LUA_LUACHECK: User custom config file name if different from default

LUA_LUACHECK: Disable errors

Type: boolean Default: false

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

LUA_LUACHECK: Maximum number of errors allowed

Type: number Default: 0

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

LUA_LUACHECK: Matching files extensions

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

LUA_LUACHECK: 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"

LUA_LUACHECK: Matching file name regexes

Type: array of string Default: []

LUA_LUACHECK: 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"

LUA_LUACHECK: Excluding Regex

Type: string or array of string

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

LUA_LUACHECK: Including Regex

Type: string or array of string

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

LUA_LUACHECK: Forward excluded directories in project lint mode

Type: boolean Default: true

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

LUA_LUACHECK: Post-run commands

Type: array

LUALUACHECK: Define bash commands to run after running LUALUACHECK

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:

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"
    }
]

LUA_LUACHECK: Pre-run commands

Type: array

LUALUACHECK: Define bash commands to run before running LUALUACHECK

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:

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"
    }
]

LUA_LUACHECK: Custom config file path

Type: string

LUA_LUACHECK: Path where to find linter configuration file

LUA_LUACHECK: Timeout in seconds

Type: integer

LUALUACHECK: Maximum duration in seconds of the LUALUACHECK 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

LUA_LUACHECK: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for LUA descriptor

Type: array

LUA: 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:

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 LUA descriptor

Type: array

LUA: 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:

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) LUA_SELENE: Custom arguments

Type: array of string or string

LUA_SELENE: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) LUA_SELENE: CLI Executable

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

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

No Additional Items

Each item of this array must be:

(deprecated) LUA_SELENE: CLI lint mode

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

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

Must be one of:

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

(deprecated) LUA_SELENE: Custom remove arguments

Type: array of string or string

LUA_SELENE: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) LUA_SELENE: Custom config file name

Type: string Default: "selene.toml"

LUA_SELENE: User custom config file name if different from default

(deprecated) LUA_SELENE: Disable errors

Type: boolean Default: false

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

(deprecated) LUA_SELENE: Maximum number of errors allowed

Type: number Default: 0

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

(deprecated) LUA_SELENE: Matching files extensions

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

LUA_SELENE: 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"

(deprecated) LUA_SELENE: Matching file name regexes

Type: array of string Default: []

LUA_SELENE: 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"

(deprecated) LUA_SELENE: Excluding Regex

Type: string or array of string

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

(deprecated) LUA_SELENE: Including Regex

Type: string or array of string

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

(deprecated) LUA_SELENE: Post-run commands

Type: array

LUASELENE: Define bash commands to run after running LUASELENE

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:

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) LUA_SELENE: Pre-run commands

Type: array

LUASELENE: Define bash commands to run before running LUASELENE

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:

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) LUA_SELENE: Custom config file path

Type: string

LUA_SELENE: Path where to find linter configuration file

(deprecated) LUA_SELENE: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

LUA_STYLUA: Custom arguments

Type: array of string or string

LUA_STYLUA: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

LUA_STYLUA: CLI Executable

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

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

No Additional Items

Each item of this array must be:

LUA_STYLUA: CLI lint mode

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

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

Must be one of:

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

LUA_STYLUA: Custom remove arguments

Type: array of string or string

LUA_STYLUA: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

LUA_STYLUA: Custom config file name

Type: string Default: "stylua.toml"

LUA_STYLUA: User custom config file name if different from default

LUA_STYLUA: Disable errors

Type: boolean Default: false

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

LUA_STYLUA: Maximum number of errors allowed

Type: number Default: 0

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

LUA_STYLUA: Matching files extensions

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

LUA_STYLUA: 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"

LUA_STYLUA: Matching file name regexes

Type: array of string Default: []

LUA_STYLUA: 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"

LUA_STYLUA: Excluding Regex

Type: string or array of string

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

LUA_STYLUA: Including Regex

Type: string or array of string

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

LUA_STYLUA: Forward excluded directories in project lint mode

Type: boolean Default: true

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

LUA_STYLUA: Post-run commands

Type: array

LUASTYLUA: Define bash commands to run after running LUASTYLUA

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:

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"
    }
]

LUA_STYLUA: Pre-run commands

Type: array

LUASTYLUA: Define bash commands to run before running LUASTYLUA

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:

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"
    }
]

LUA_STYLUA: Custom config file path

Type: string

LUA_STYLUA: Path where to find linter configuration file

LUA_STYLUA: Timeout in seconds

Type: integer

LUASTYLUA: Maximum duration in seconds of the LUASTYLUA 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

LUA_STYLUA: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

(deprecated) MAKEFILE_CHECKMAKE: Custom arguments

Type: array of string or string

MAKEFILE_CHECKMAKE: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) MAKEFILE_CHECKMAKE: CLI Executable

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

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

No Additional Items

Each item of this array must be:

(deprecated) MAKEFILE_CHECKMAKE: CLI lint mode

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

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

Must be one of:

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

(deprecated) MAKEFILE_CHECKMAKE: Custom remove arguments

Type: array of string or string

MAKEFILE_CHECKMAKE: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) MAKEFILE_CHECKMAKE: Custom config file name

Type: string Default: ".checkmake.ini"

MAKEFILE_CHECKMAKE: User custom config file name if different from default

(deprecated) MAKEFILE_CHECKMAKE: Disable errors

Type: boolean Default: false

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

(deprecated) MAKEFILE_CHECKMAKE: Maximum number of errors allowed

Type: number Default: 0

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

(deprecated) MAKEFILE_CHECKMAKE: Matching files extensions

Type: array of string Default: []

MAKEFILE_CHECKMAKE: 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"

(deprecated) MAKEFILE_CHECKMAKE: Matching file name regexes

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

MAKEFILE_CHECKMAKE: 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"

(deprecated) MAKEFILE_CHECKMAKE: Excluding Regex

Type: string or array of string

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

(deprecated) MAKEFILE_CHECKMAKE: Including Regex

Type: string or array of string

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

(deprecated) MAKEFILE_CHECKMAKE: Post-run commands

Type: array

MAKEFILECHECKMAKE: Define bash commands to run after running MAKEFILECHECKMAKE

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:

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) MAKEFILE_CHECKMAKE: Pre-run commands

Type: array

MAKEFILECHECKMAKE: Define bash commands to run before running MAKEFILECHECKMAKE

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:

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) MAKEFILE_CHECKMAKE: Custom config file path

Type: string

MAKEFILE_CHECKMAKE: Path where to find linter configuration file

(deprecated) MAKEFILE_CHECKMAKE: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

(deprecated) Excluding regex filter for MAKEFILE descriptor

Type: string or array of string

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

(deprecated) Including regex filter for MAKEFILE descriptor

Type: string or array of string

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

(deprecated) Post commands for MAKEFILE descriptor

Type: array

MAKEFILE: 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:

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) Pre commands for MAKEFILE descriptor

Type: array

MAKEFILE: 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:

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"
    }
]

Markdown default formatting style

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

Style of markdown formatting to apply

Must be one of:

  • "markdownlint"
  • "rumdl"

Excluding regex filter for MARKDOWN descriptor

Type: string or array of string

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

Including regex filter for MARKDOWN descriptor

Type: string or array of string

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

MARKDOWN_MARKDOWNLINT: Custom arguments

Type: array of string or string

MARKDOWN_MARKDOWNLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

MARKDOWN_MARKDOWNLINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

MARKDOWN_MARKDOWNLINT: CLI lint mode

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

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

Must be one of:

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

MARKDOWN_MARKDOWNLINT: Custom remove arguments

Type: array of string or string

MARKDOWN_MARKDOWNLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

MARKDOWN_MARKDOWNLINT: Custom config file name

Type: string Default: ".markdownlint.json"

MARKDOWN_MARKDOWNLINT: User custom config file name if different from default

MARKDOWN_MARKDOWNLINT: Disable errors

Type: boolean Default: false

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

MARKDOWN_MARKDOWNLINT: Maximum number of errors allowed

Type: number Default: 0

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

MARKDOWN_MARKDOWNLINT: Matching files extensions

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

MARKDOWN_MARKDOWNLINT: 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"

MARKDOWN_MARKDOWNLINT: Matching file name regexes

Type: array of string Default: []

MARKDOWN_MARKDOWNLINT: 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"

MARKDOWN_MARKDOWNLINT: Excluding Regex

Type: string or array of string

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

MARKDOWN_MARKDOWNLINT: Including Regex

Type: string or array of string

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

MARKDOWN_MARKDOWNLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

MARKDOWN_MARKDOWNLINT: Post-run commands

Type: array

MARKDOWNMARKDOWNLINT: Define bash commands to run after running MARKDOWNMARKDOWNLINT

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:

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"
    }
]

MARKDOWN_MARKDOWNLINT: Pre-run commands

Type: array

MARKDOWNMARKDOWNLINT: Define bash commands to run before running MARKDOWNMARKDOWNLINT

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:

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"
    }
]

MARKDOWN_MARKDOWNLINT: Custom config file path

Type: string

MARKDOWN_MARKDOWNLINT: Path where to find linter configuration file

MARKDOWN_MARKDOWNLINT: Timeout in seconds

Type: integer

MARKDOWNMARKDOWNLINT: Maximum duration in seconds of the MARKDOWNMARKDOWNLINT 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

MARKDOWN_MARKDOWNLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

(deprecated) MARKDOWN_MARKDOWN_LINK_CHECK: 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:

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"
    }
]

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Custom arguments

Type: array of string or string

MARKDOWNMARKDOWNTABLE_FORMATTER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

MARKDOWN_MARKDOWN_TABLE_FORMATTER: CLI Executable

Type: array of string Default: [["markdown-table-formatter"]]

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

No Additional Items

Each item of this array must be:

MARKDOWN_MARKDOWN_TABLE_FORMATTER: CLI lint mode

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

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

Must be one of:

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

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Custom remove arguments

Type: array of string or string

MARKDOWNMARKDOWNTABLE_FORMATTER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Disable errors

Type: boolean Default: false

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

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Maximum number of errors allowed

Type: number Default: 0

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

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Matching files extensions

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

MARKDOWNMARKDOWNTABLE_FORMATTER: 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"

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Matching file name regexes

Type: array of string Default: []

MARKDOWNMARKDOWNTABLE_FORMATTER: 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"

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Excluding Regex

Type: string or array of string

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

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Including Regex

Type: string or array of string

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

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Forward excluded directories in project lint mode

Type: boolean Default: true

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

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Post-run commands

Type: array

MARKDOWNMARKDOWNTABLEFORMATTER: Define bash commands to run after running MARKDOWNMARKDOWNTABLEFORMATTER

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:

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"
    }
]

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Pre-run commands

Type: array

MARKDOWNMARKDOWNTABLEFORMATTER: Define bash commands to run before running MARKDOWNMARKDOWNTABLEFORMATTER

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:

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"
    }
]

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Timeout in seconds

Type: integer

MARKDOWNMARKDOWNTABLEFORMATTER: Maximum duration in seconds of the MARKDOWNMARKDOWNTABLEFORMATTER 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

MARKDOWN_MARKDOWN_TABLE_FORMATTER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Custom arguments

Type: array of string

MARKDOWNMARKDOWNTABLE_PRETTIFY: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Linter does not make MegaLinter fail even if errors are found

Type: boolean Default: false

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:


Examples:

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

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Excluding Regex

Type: string

MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Including Regex

Type: string

Post commands for MARKDOWN descriptor

Type: array

MARKDOWN: 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:

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 MARKDOWN descriptor

Type: array

MARKDOWN: 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:

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) MARKDOWN_REMARK_LINT: Custom arguments

Type: array of string or string

MARKDOWNREMARKLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) MARKDOWN_REMARK_LINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

(deprecated) MARKDOWN_REMARK_LINT: CLI lint mode

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

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

Must be one of:

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

(deprecated) MARKDOWN_REMARK_LINT: Custom remove arguments

Type: array of string or string

MARKDOWNREMARKLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) MARKDOWN_REMARK_LINT: Custom config file name

Type: string Default: ".remarkrc"

MARKDOWNREMARKLINT: User custom config file name if different from default

(deprecated) MARKDOWN_REMARK_LINT: Disable errors

Type: boolean Default: false

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

(deprecated) MARKDOWN_REMARK_LINT: Maximum number of errors allowed

Type: number Default: 0

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

(deprecated) MARKDOWN_REMARK_LINT: Matching files extensions

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

MARKDOWNREMARKLINT: 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"

(deprecated) MARKDOWN_REMARK_LINT: Matching file name regexes

Type: array of string Default: []

MARKDOWNREMARKLINT: 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"

(deprecated) MARKDOWN_REMARK_LINT: Excluding Regex

Type: string or array of string

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

(deprecated) MARKDOWN_REMARK_LINT: Including Regex

Type: string or array of string

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

(deprecated) MARKDOWN_REMARK_LINT: Post-run commands

Type: array

MARKDOWNREMARKLINT: Define bash commands to run after running MARKDOWNREMARKLINT

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:

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) MARKDOWN_REMARK_LINT: Pre-run commands

Type: array

MARKDOWNREMARKLINT: Define bash commands to run before running MARKDOWNREMARKLINT

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:

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) MARKDOWN_REMARK_LINT: Custom config file path

Type: string

MARKDOWNREMARKLINT: Path where to find linter configuration file

(deprecated) MARKDOWN_REMARK_LINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

MARKDOWN_RUMDL: Custom arguments

Type: array of string or string

MARKDOWN_RUMDL: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

MARKDOWN_RUMDL: CLI Executable

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

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

No Additional Items

Each item of this array must be:

MARKDOWN_RUMDL: CLI lint mode

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

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

Must be one of:

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

MARKDOWN_RUMDL: Custom remove arguments

Type: array of string or string

MARKDOWN_RUMDL: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

MARKDOWN_RUMDL: Custom config file name

Type: string Default: ".rumdl.toml"

MARKDOWN_RUMDL: User custom config file name if different from default

MARKDOWN_RUMDL: Disable errors

Type: boolean Default: false

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

MARKDOWN_RUMDL: Maximum number of errors allowed

Type: number Default: 0

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

MARKDOWN_RUMDL: Matching files extensions

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

MARKDOWN_RUMDL: 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"

MARKDOWN_RUMDL: Matching file name regexes

Type: array of string Default: []

MARKDOWN_RUMDL: 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"

MARKDOWN_RUMDL: Excluding Regex

Type: string or array of string

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

MARKDOWN_RUMDL: Including Regex

Type: string or array of string

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

MARKDOWN_RUMDL: Forward excluded directories in project lint mode

Type: boolean Default: true

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

MARKDOWN_RUMDL: Post-run commands

Type: array

MARKDOWNRUMDL: Define bash commands to run after running MARKDOWNRUMDL

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:

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"
    }
]

MARKDOWN_RUMDL: Pre-run commands

Type: array

MARKDOWNRUMDL: Define bash commands to run before running MARKDOWNRUMDL

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:

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"
    }
]

MARKDOWN_RUMDL: Custom config file path

Type: string

MARKDOWN_RUMDL: Path where to find linter configuration file

MARKDOWN_RUMDL: Timeout in seconds

Type: integer

MARKDOWNRUMDL: Maximum duration in seconds of the MARKDOWNRUMDL 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

MARKDOWN_RUMDL: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Activate SUMMARY reporter

Type: boolean Default: false

Generate SUMMARY reports that can be used to display issues directly in PR comment

SUMMARY report file name

Type: string Default: "megalinter-summary.log"

Override SUMMARY output file name

MegaLinter flavor

Type: string Default: "all"

MegaLinter flavor (specialized Docker image variant) to use to lint this repository. Used by mega-linter-runner and coding agents to select the Docker image. Examples: all, python, javascript, security, or a custom flavor name.


Examples:

"all"
"python"
"javascript"
"security"

MegaLinter version

Type: string Default: "latest"

MegaLinter version tag to use (e.g. latest, beta, v10, v10.0.0). Used by mega-linter-runner and coding agents to select the Docker image version.


Examples:

"latest"
"beta"
"v10"

(DEPRECATED) Activate GitHub Status reporter

Type: boolean Default: true

(DEPRECATED, use GITHUBSTATUSREPORTER) Posts a status on the pull request for each processed linter

OLLAMA: Base URL

Type: string Default: "http://localhost:11434"

Base URL to connect to Ollama server

Output detail (DEPRECATED, use reporters variables instead)

Type: enum (of string)

(DEPRECATED) Output detail for text reporter: only error files (simple) or all files (detailed)

Must be one of:

  • "simple"
  • "detailed"

Output format (DEPRECATED, use reporters variables instead)

Type: enum (of string)

(DEPRECATED) Output format: text or tap

Must be one of:

  • "text"
  • "tap"

Parallel processing

Type: boolean Default: true

Process linters in parallel to improve overall MegaLinter performance. If true, linters of same language or formats are grouped in the same parallel process to avoid lock issues if fixing the same files

Parallel process number

Type: number

All available cores are used by default. If there are too many, you need to decrease the number of used cores in order to enhance performances


Example:

4

Excluding regex filter for PERL descriptor

Type: string or array of string

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

Including regex filter for PERL descriptor

Type: string or array of string

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

PERL_PERLCRITIC: Custom arguments

Type: array of string or string

PERL_PERLCRITIC: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PERL_PERLCRITIC: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PERL_PERLCRITIC: CLI lint mode

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

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

Must be one of:

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

PERL_PERLCRITIC: Custom remove arguments

Type: array of string or string

PERL_PERLCRITIC: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PERL_PERLCRITIC: Disable errors

Type: boolean Default: false

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

PERL_PERLCRITIC: Maximum number of errors allowed

Type: number Default: 0

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

PERL_PERLCRITIC: Matching files extensions

Type: array of string Default: [".pl", ".pm", ".t", ""]

PERL_PERLCRITIC: 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"

PERL_PERLCRITIC: Matching file name regexes

Type: array of string Default: []

PERL_PERLCRITIC: 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"

PERL_PERLCRITIC: Excluding Regex

Type: string or array of string

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

PERL_PERLCRITIC: Including Regex

Type: string or array of string

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

PERL_PERLCRITIC: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PERL_PERLCRITIC: Post-run commands

Type: array

PERLPERLCRITIC: Define bash commands to run after running PERLPERLCRITIC

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:

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"
    }
]

PERL_PERLCRITIC: Pre-run commands

Type: array

PERLPERLCRITIC: Define bash commands to run before running PERLPERLCRITIC

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:

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"
    }
]

PERL_PERLCRITIC: Timeout in seconds

Type: integer

PERLPERLCRITIC: Maximum duration in seconds of the PERLPERLCRITIC 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

PERL_PERLCRITIC: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for PERL descriptor

Type: array

PERL: 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:

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 PERL descriptor

Type: array

PERL: 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:

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) (removed) PHP_BUILTIN: Custom arguments

Type: array of string or string

PHP_BUILTIN: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) (removed) PHP_BUILTIN: Override default CLI executable for linting request

Type: string

(deprecated) (removed) PHP_BUILTIN: Override default cli lint mode

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

Must be one of:

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

(deprecated) (removed) PHP_BUILTIN: Linter does not make MegaLinter fail even if errors are found

Type: boolean Default: false

(deprecated) (removed) PHP_BUILTIN: Maximum number of errors allowed

Type: number Default: 0

(deprecated) (removed) PHP_BUILTIN: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

(deprecated) (removed) PHP_BUILTIN: 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) PHP_BUILTIN: Excluding Regex

Type: string

(deprecated) (removed) PHP_BUILTIN: Including Regex

Type: string

(deprecated) (removed) PHP_BUILTIN: 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:

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) PHP_BUILTIN: 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:

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"
    }
]

Excluding regex filter for PHP descriptor

Type: string or array of string

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

Including regex filter for PHP descriptor

Type: string or array of string

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

PHP_PHPCSFIXER: Custom arguments

Type: array of string or string

PHP_PHPCSFIXER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PHP_PHPCSFIXER: CLI Executable

Type: array of string Default: [["php-cs-fixer"]]

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

No Additional Items

Each item of this array must be:

PHP_PHPCSFIXER: CLI lint mode

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

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

Must be one of:

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

PHP_PHPCSFIXER: Custom remove arguments

Type: array of string or string

PHP_PHPCSFIXER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PHP_PHPCSFIXER: Custom config file name

Type: string Default: ".php-cs-fixer.dist.php"

PHP_PHPCSFIXER: User custom config file name if different from default

PHP_PHPCSFIXER: Disable errors

Type: boolean Default: false

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

PHP_PHPCSFIXER: Maximum number of errors allowed

Type: number Default: 0

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

PHP_PHPCSFIXER: Matching files extensions

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

PHP_PHPCSFIXER: 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"

PHP_PHPCSFIXER: Matching file name regexes

Type: array of string Default: []

PHP_PHPCSFIXER: 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"

PHP_PHPCSFIXER: Excluding Regex

Type: string or array of string

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

PHP_PHPCSFIXER: Including Regex

Type: string or array of string

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

PHP_PHPCSFIXER: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PHP_PHPCSFIXER: Post-run commands

Type: array

PHPPHPCSFIXER: Define bash commands to run after running PHPPHPCSFIXER

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:

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"
    }
]

PHP_PHPCSFIXER: Pre-run commands

Type: array

PHPPHPCSFIXER: Define bash commands to run before running PHPPHPCSFIXER

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:

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"
    }
]

PHP_PHPCSFIXER: Custom config file path

Type: string

PHP_PHPCSFIXER: Path where to find linter configuration file

PHP_PHPCSFIXER: Timeout in seconds

Type: integer

PHPPHPCSFIXER: Maximum duration in seconds of the PHPPHPCSFIXER 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

PHP_PHPCSFIXER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

PHP_PHPCS: Custom arguments

Type: array of string or string

PHP_PHPCS: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PHP_PHPCS: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PHP_PHPCS: CLI lint mode

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

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

Must be one of:

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

PHP_PHPCS: Custom remove arguments

Type: array of string or string

PHP_PHPCS: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PHP_PHPCS: Custom config file name

Type: string Default: "phpcs.xml"

PHP_PHPCS: User custom config file name if different from default

PHP_PHPCS: Disable errors

Type: boolean Default: false

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

PHP_PHPCS: Maximum number of errors allowed

Type: number Default: 0

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

PHP_PHPCS: Matching files extensions

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

PHP_PHPCS: 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"

PHP_PHPCS: Matching file name regexes

Type: array of string Default: []

PHP_PHPCS: 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"

PHP_PHPCS: Excluding Regex

Type: string or array of string

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

PHP_PHPCS: Including Regex

Type: string or array of string

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

PHP_PHPCS: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PHP_PHPCS: Post-run commands

Type: array

PHPPHPCS: Define bash commands to run after running PHPPHPCS

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:

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"
    }
]

PHP_PHPCS: Pre-run commands

Type: array

PHPPHPCS: Define bash commands to run before running PHPPHPCS

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:

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"
    }
]

PHP_PHPCS: Custom config file path

Type: string

PHP_PHPCS: Path where to find linter configuration file

PHP_PHPCS: Timeout in seconds

Type: integer

PHPPHPCS: Maximum duration in seconds of the PHPPHPCS 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

PHP_PHPCS: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

PHP_PHPLINT: Custom arguments

Type: array of string or string

PHP_PHPLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PHP_PHPLINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PHP_PHPLINT: CLI lint mode

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

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

Must be one of:

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

PHP_PHPLINT: Custom remove arguments

Type: array of string or string

PHP_PHPLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PHP_PHPLINT: Custom config file name

Type: string Default: ".phplint.yml"

PHP_PHPLINT: User custom config file name if different from default

PHP_PHPLINT: Disable errors

Type: boolean Default: false

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

PHP_PHPLINT: Maximum number of errors allowed

Type: number Default: 0

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

PHP_PHPLINT: Matching files extensions

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

PHP_PHPLINT: 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"

PHP_PHPLINT: Matching file name regexes

Type: array of string Default: []

PHP_PHPLINT: 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"

PHP_PHPLINT: Excluding Regex

Type: string or array of string

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

PHP_PHPLINT: Including Regex

Type: string or array of string

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

PHP_PHPLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PHP_PHPLINT: Post-run commands

Type: array

PHPPHPLINT: Define bash commands to run after running PHPPHPLINT

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:

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"
    }
]

PHP_PHPLINT: Pre-run commands

Type: array

PHPPHPLINT: Define bash commands to run before running PHPPHPLINT

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:

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"
    }
]

PHP_PHPLINT: Custom config file path

Type: string

PHP_PHPLINT: Path where to find linter configuration file

PHP_PHPLINT: Timeout in seconds

Type: integer

PHPPHPLINT: Maximum duration in seconds of the PHPPHPLINT 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

PHP_PHPLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

PHP_PHPSTAN: Custom arguments

Type: array of string or string

PHP_PHPSTAN: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PHP_PHPSTAN: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PHP_PHPSTAN: CLI lint mode

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

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

Must be one of:

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

PHP_PHPSTAN: Custom remove arguments

Type: array of string or string

PHP_PHPSTAN: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PHP_PHPSTAN: Custom config file name

Type: string Default: "phpstan.neon.dist"

PHP_PHPSTAN: User custom config file name if different from default

PHP_PHPSTAN: Disable errors

Type: boolean Default: false

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

PHP_PHPSTAN: Maximum number of errors allowed

Type: number Default: 0

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

PHP_PHPSTAN: Matching files extensions

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

PHP_PHPSTAN: 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"

PHP_PHPSTAN: Matching file name regexes

Type: array of string Default: []

PHP_PHPSTAN: 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"

PHP_PHPSTAN: Excluding Regex

Type: string or array of string

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

PHP_PHPSTAN: Including Regex

Type: string or array of string

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

PHP_PHPSTAN: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PHP_PHPSTAN: Post-run commands

Type: array

PHPPHPSTAN: Define bash commands to run after running PHPPHPSTAN

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:

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"
    }
]

PHP_PHPSTAN: Pre-run commands

Type: array

PHPPHPSTAN: Define bash commands to run before running PHPPHPSTAN

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:

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"
    }
]

PHP_PHPSTAN: Custom config file path

Type: string

PHP_PHPSTAN: Path where to find linter configuration file

PHP_PHPSTAN: Timeout in seconds

Type: integer

PHPPHPSTAN: Maximum duration in seconds of the PHPPHPSTAN 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

PHP_PHPSTAN: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for PHP descriptor

Type: array

PHP: 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:

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 PHP descriptor

Type: array

PHP: 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:

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"
    }
]

PHP_PSALM: Custom arguments

Type: array of string or string

PHP_PSALM: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PHP_PSALM: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PHP_PSALM: CLI lint mode

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

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

Must be one of:

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

PHP_PSALM: Custom remove arguments

Type: array of string or string

PHP_PSALM: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PHP_PSALM: Custom config file name

Type: string Default: "psalm.xml"

PHP_PSALM: User custom config file name if different from default

PHP_PSALM: Disable errors

Type: boolean Default: false

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

PHP_PSALM: Maximum number of errors allowed

Type: number Default: 0

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

PHP_PSALM: Matching files extensions

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

PHP_PSALM: 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"

PHP_PSALM: Matching file name regexes

Type: array of string Default: []

PHP_PSALM: 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"

PHP_PSALM: Excluding Regex

Type: string or array of string

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

PHP_PSALM: Including Regex

Type: string or array of string

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

PHP_PSALM: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PHP_PSALM: Post-run commands

Type: array

PHPPSALM: Define bash commands to run after running PHPPSALM

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:

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"
    }
]

PHP_PSALM: Pre-run commands

Type: array

PHPPSALM: Define bash commands to run before running PHPPSALM

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:

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"
    }
]

PHP_PSALM: Custom config file path

Type: string

PHP_PSALM: Path where to find linter configuration file

PHP_PSALM: Timeout in seconds

Type: integer

PHPPSALM: Maximum duration in seconds of the PHPPSALM 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

PHP_PSALM: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

List of plugins loaded at runtime

Type: array of string

List of MegaLinter plugins. URL must follow format https:///mega-linter-plugin-/**.mega-linter-descriptor.yml

No Additional Items

Each item of this array must be:

Type: string

Example:

[
    "https://raw.githubusercontent.com/cookiejar/megalinter-plugin-cookiejar/master/cookietemplate.mega-linter-descriptor.yml"
]

Post run commands

Type: array Default: []

Custom bash commands to run after 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:

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) Activate GitHub PR Comments reporter

Type: boolean Default: true

(DEPRECATED, use GITHUBCOMMENTREPORTER) Posts MegaLinter results summary in the comments of the related pull request (if existing)

(DEPRECATED) Activate Gitlab MR Comments reporter

Type: boolean Default: true

(DEPRECATED, use GITHUBCOMMENTREPORTER) Posts MegaLinter results summary in the comments of the related merge request (if existing)

Excluding regex filter for POWERSHELL descriptor

Type: string or array of string

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

Including regex filter for POWERSHELL descriptor

Type: string or array of string

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

Post commands for POWERSHELL descriptor

Type: array

POWERSHELL: 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:

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"
    }
]

POWERSHELL_POWERSHELL: Custom arguments

Type: array of string or string

POWERSHELL_POWERSHELL: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

POWERSHELL_POWERSHELL: CLI Executable

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

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

No Additional Items

Each item of this array must be:

POWERSHELL_POWERSHELL: CLI lint mode

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

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

Must be one of:

  • "file"
  • "project"

POWERSHELL_POWERSHELL: Custom remove arguments

Type: array of string or string

POWERSHELL_POWERSHELL: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

POWERSHELL_POWERSHELL: Custom config file name

Type: string Default: ".powershell-psscriptanalyzer.psd1"

POWERSHELL_POWERSHELL: User custom config file name if different from default

POWERSHELL_POWERSHELL: Disable errors

Type: boolean Default: false

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

POWERSHELL_POWERSHELL: Maximum number of errors allowed

Type: number Default: 0

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

POWERSHELL_POWERSHELL: Matching files extensions

Type: array of string Default: [".ps1", ".psm1", ".psd1", ".ps1xml", ".pssc", ".psrc", ".cdxml"]

POWERSHELL_POWERSHELL: 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"

POWERSHELL_POWERSHELL: Matching file name regexes

Type: array of string Default: []

POWERSHELL_POWERSHELL: 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"

POWERSHELL_POWERSHELL: Excluding Regex

Type: string or array of string

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

POWERSHELL_POWERSHELL: Including Regex

Type: string or array of string

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

POWERSHELL_POWERSHELL_FORMATTER: Custom arguments

Type: array of string or string

POWERSHELLPOWERSHELLFORMATTER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

POWERSHELL_POWERSHELL_FORMATTER: CLI Executable

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

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

No Additional Items

Each item of this array must be:

POWERSHELL_POWERSHELL_FORMATTER: CLI lint mode

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

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

Must be one of:

  • "file"

POWERSHELL_POWERSHELL_FORMATTER: Custom remove arguments

Type: array of string or string

POWERSHELLPOWERSHELLFORMATTER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

POWERSHELL_POWERSHELL_FORMATTER: Custom config file name

Type: string Default: ".powershell-formatter.psd1"

POWERSHELLPOWERSHELLFORMATTER: User custom config file name if different from default

POWERSHELL_POWERSHELL_FORMATTER: Disable errors

Type: boolean Default: false

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

POWERSHELL_POWERSHELL_FORMATTER: Maximum number of errors allowed

Type: number Default: 0

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

POWERSHELL_POWERSHELL_FORMATTER: Matching files extensions

Type: array of string Default: [".ps1", ".psm1", ".psd1", ".ps1xml", ".pssc", ".psrc", ".cdxml"]

POWERSHELLPOWERSHELLFORMATTER: 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"

POWERSHELL_POWERSHELL_FORMATTER: Matching file name regexes

Type: array of string Default: []

POWERSHELLPOWERSHELLFORMATTER: 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"

POWERSHELL_POWERSHELL_FORMATTER: Excluding Regex

Type: string or array of string

POWERSHELL_POWERSHELL_FORMATTER: Including Regex

Type: string or array of string

POWERSHELL_POWERSHELL_FORMATTER: Output encoding type

Type: string Default: "utf8"

POWERSHELLPOWERSHELLFORMATTER: -Encoding to be used when writing content to the file

POWERSHELL_POWERSHELL_FORMATTER: Post-run commands

Type: array

POWERSHELLPOWERSHELLFORMATTER: Define bash commands to run after running POWERSHELLPOWERSHELLFORMATTER

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:

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"
    }
]

POWERSHELL_POWERSHELL_FORMATTER: Pre-run commands

Type: array

POWERSHELLPOWERSHELLFORMATTER: Define bash commands to run before running POWERSHELLPOWERSHELLFORMATTER

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:

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"
    }
]

POWERSHELL_POWERSHELL_FORMATTER: Custom config file path

Type: string

POWERSHELLPOWERSHELLFORMATTER: Path where to find linter configuration file

POWERSHELL_POWERSHELL_FORMATTER: Timeout in seconds

Type: integer

POWERSHELLPOWERSHELLFORMATTER: Maximum duration in seconds of the POWERSHELLPOWERSHELLFORMATTER 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

POWERSHELL_POWERSHELL_FORMATTER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

POWERSHELL_POWERSHELL: Forward excluded directories in project lint mode

Type: boolean Default: true

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

POWERSHELL_POWERSHELL: Post-run commands

Type: array

POWERSHELLPOWERSHELL: Define bash commands to run after running POWERSHELLPOWERSHELL

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:

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"
    }
]

POWERSHELL_POWERSHELL: Pre-run commands

Type: array

POWERSHELLPOWERSHELL: Define bash commands to run before running POWERSHELLPOWERSHELL

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:

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"
    }
]

POWERSHELL_POWERSHELL: Custom config file path

Type: string

POWERSHELL_POWERSHELL: Path where to find linter configuration file

POWERSHELL_POWERSHELL: Timeout in seconds

Type: integer

POWERSHELLPOWERSHELL: Maximum duration in seconds of the POWERSHELLPOWERSHELL 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

POWERSHELL_POWERSHELL: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Pre commands for POWERSHELL descriptor

Type: array

POWERSHELL: 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:

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"
    }
]

Pre-run commands

Type: array Default: []

Custom bash commands to run before 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:

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 install java-caller",
        "continue_if_failed": false,
        "cwd": "root"
    },
    {
        "command": "echo \"pre-run command has been called\"",
        "cwd": "workspace"
    }
]

Excluding regex filter for PROTOBUF descriptor

Type: string or array of string

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

Including regex filter for PROTOBUF descriptor

Type: string or array of string

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

Post commands for PROTOBUF descriptor

Type: array

PROTOBUF: 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:

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 PROTOBUF descriptor

Type: array

PROTOBUF: 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:

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"
    }
]

PROTOBUF_PROTOLINT: Custom arguments

Type: array of string or string

PROTOBUF_PROTOLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PROTOBUF_PROTOLINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PROTOBUF_PROTOLINT: CLI lint mode

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

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

Must be one of:

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

PROTOBUF_PROTOLINT: Custom remove arguments

Type: array of string or string

PROTOBUF_PROTOLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PROTOBUF_PROTOLINT: Custom config file name

Type: string Default: ".protolintrc.yml"

PROTOBUF_PROTOLINT: User custom config file name if different from default

PROTOBUF_PROTOLINT: Disable errors

Type: boolean Default: false

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

PROTOBUF_PROTOLINT: Maximum number of errors allowed

Type: number Default: 0

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

PROTOBUF_PROTOLINT: Matching files extensions

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

PROTOBUF_PROTOLINT: 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"

PROTOBUF_PROTOLINT: Matching file name regexes

Type: array of string Default: []

PROTOBUF_PROTOLINT: 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"

PROTOBUF_PROTOLINT: Excluding Regex

Type: string or array of string

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

PROTOBUF_PROTOLINT: Including Regex

Type: string or array of string

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

PROTOBUF_PROTOLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PROTOBUF_PROTOLINT: Post-run commands

Type: array

PROTOBUFPROTOLINT: Define bash commands to run after running PROTOBUFPROTOLINT

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:

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"
    }
]

PROTOBUF_PROTOLINT: Pre-run commands

Type: array

PROTOBUFPROTOLINT: Define bash commands to run before running PROTOBUFPROTOLINT

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:

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"
    }
]

PROTOBUF_PROTOLINT: Custom config file path

Type: string

PROTOBUF_PROTOLINT: Path where to find linter configuration file

PROTOBUF_PROTOLINT: Timeout in seconds

Type: integer

PROTOBUFPROTOLINT: Maximum duration in seconds of the PROTOBUFPROTOLINT 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

PROTOBUF_PROTOLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

(deprecated) Excluding regex filter for PUPPET descriptor

Type: string or array of string

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

(deprecated) Including regex filter for PUPPET descriptor

Type: string or array of string

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

(deprecated) Post commands for PUPPET descriptor

Type: array

PUPPET: 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:

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) Pre commands for PUPPET descriptor

Type: array

PUPPET: 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:

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) PUPPET_PUPPET_LINT: Custom arguments

Type: array of string or string

PUPPETPUPPETLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) PUPPET_PUPPET_LINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

(deprecated) PUPPET_PUPPET_LINT: CLI lint mode

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

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

Must be one of:

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

(deprecated) PUPPET_PUPPET_LINT: Custom remove arguments

Type: array of string or string

PUPPETPUPPETLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) PUPPET_PUPPET_LINT: Custom config file name

Type: string Default: ".puppet-lint.rc"

PUPPETPUPPETLINT: User custom config file name if different from default

(deprecated) PUPPET_PUPPET_LINT: Disable errors

Type: boolean Default: false

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

(deprecated) PUPPET_PUPPET_LINT: Maximum number of errors allowed

Type: number Default: 0

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

(deprecated) PUPPET_PUPPET_LINT: Matching files extensions

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

PUPPETPUPPETLINT: 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"

(deprecated) PUPPET_PUPPET_LINT: Matching file name regexes

Type: array of string Default: []

PUPPETPUPPETLINT: 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"

(deprecated) PUPPET_PUPPET_LINT: Excluding Regex

Type: string or array of string

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

(deprecated) PUPPET_PUPPET_LINT: Including Regex

Type: string or array of string

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

(deprecated) PUPPET_PUPPET_LINT: Post-run commands

Type: array

PUPPETPUPPETLINT: Define bash commands to run after running PUPPETPUPPETLINT

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:

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) PUPPET_PUPPET_LINT: Pre-run commands

Type: array

PUPPETPUPPETLINT: Define bash commands to run before running PUPPETPUPPETLINT

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:

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) PUPPET_PUPPET_LINT: Custom config file path

Type: string

PUPPETPUPPETLINT: Path where to find linter configuration file

(deprecated) PUPPET_PUPPET_LINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

PYTHON_BANDIT: Custom arguments

Type: array of string or string

PYTHON_BANDIT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PYTHON_BANDIT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PYTHON_BANDIT: CLI lint mode

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

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

Must be one of:

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

PYTHON_BANDIT: Custom remove arguments

Type: array of string or string

PYTHON_BANDIT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PYTHON_BANDIT: Custom config file name

Type: string Default: ".bandit.yml"

PYTHON_BANDIT: User custom config file name if different from default

PYTHON_BANDIT: Disable errors

Type: boolean Default: false

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

PYTHON_BANDIT: Maximum number of errors allowed

Type: number Default: 0

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

PYTHON_BANDIT: Matching files extensions

Type: array of string Default: [".py", ".pyi", ".ipynb"]

PYTHON_BANDIT: 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"

PYTHON_BANDIT: Matching file name regexes

Type: array of string Default: []

PYTHON_BANDIT: 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"

PYTHON_BANDIT: Excluding Regex

Type: string or array of string

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

PYTHON_BANDIT: Including Regex

Type: string or array of string

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

PYTHON_BANDIT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PYTHON_BANDIT: Post-run commands

Type: array

PYTHONBANDIT: Define bash commands to run after running PYTHONBANDIT

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:

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"
    }
]

PYTHON_BANDIT: Pre-run commands

Type: array

PYTHONBANDIT: Define bash commands to run before running PYTHONBANDIT

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:

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"
    }
]

PYTHON_BANDIT: Custom config file path

Type: string

PYTHON_BANDIT: Path where to find linter configuration file

PYTHON_BANDIT: Timeout in seconds

Type: integer

PYTHONBANDIT: Maximum duration in seconds of the PYTHONBANDIT 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

PYTHON_BANDIT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

PYTHON_BLACK: Custom arguments

Type: array of string or string

PYTHON_BLACK: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PYTHON_BLACK: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PYTHON_BLACK: CLI lint mode

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

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

Must be one of:

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

PYTHON_BLACK: Custom remove arguments

Type: array of string or string

PYTHON_BLACK: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PYTHON_BLACK: Custom config file name

Type: string Default: "pyproject.toml"

PYTHON_BLACK: User custom config file name if different from default

PYTHON_BLACK: Disable errors

Type: boolean Default: false

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

PYTHON_BLACK: Maximum number of errors allowed

Type: number Default: 0

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

PYTHON_BLACK: Matching files extensions

Type: array of string Default: [".py", ".pyi", ".ipynb"]

PYTHON_BLACK: 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"

PYTHON_BLACK: Matching file name regexes

Type: array of string Default: []

PYTHON_BLACK: 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"

PYTHON_BLACK: Excluding Regex

Type: string or array of string

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

PYTHON_BLACK: Including Regex

Type: string or array of string

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

PYTHON_BLACK: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PYTHON_BLACK: Post-run commands

Type: array

PYTHONBLACK: Define bash commands to run after running PYTHONBLACK

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:

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"
    }
]

PYTHON_BLACK: Pre-run commands

Type: array

PYTHONBLACK: Define bash commands to run before running PYTHONBLACK

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:

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"
    }
]

PYTHON_BLACK: Custom config file path

Type: string

PYTHON_BLACK: Path where to find linter configuration file

PYTHON_BLACK: Timeout in seconds

Type: integer

PYTHONBLACK: Maximum duration in seconds of the PYTHONBLACK 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

PYTHON_BLACK: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Python default style

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

Style of python formatting to apply

Must be one of:

  • "black"
  • "ruff"

Examples:

"black"
"ruff"

Excluding regex filter for PYTHON descriptor

Type: string or array of string

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

Including regex filter for PYTHON descriptor

Type: string or array of string

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

PYTHON_FLAKE8: Custom arguments

Type: array of string or string

PYTHON_FLAKE8: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PYTHON_FLAKE8: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PYTHON_FLAKE8: CLI lint mode

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

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

Must be one of:

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

PYTHON_FLAKE8: Custom remove arguments

Type: array of string or string

PYTHON_FLAKE8: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PYTHON_FLAKE8: Custom config file name

Type: string Default: ".flake8"

PYTHON_FLAKE8: User custom config file name if different from default

PYTHON_FLAKE8: Disable errors

Type: boolean Default: false

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

PYTHON_FLAKE8: Maximum number of errors allowed

Type: number Default: 0

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

PYTHON_FLAKE8: Matching files extensions

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

PYTHON_FLAKE8: 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"

PYTHON_FLAKE8: Matching file name regexes

Type: array of string Default: []

PYTHON_FLAKE8: 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"

PYTHON_FLAKE8: Excluding Regex

Type: string or array of string

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

PYTHON_FLAKE8: Including Regex

Type: string or array of string

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

PYTHON_FLAKE8: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PYTHON_FLAKE8: Post-run commands

Type: array

PYTHONFLAKE8: Define bash commands to run after running PYTHONFLAKE8

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:

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"
    }
]

PYTHON_FLAKE8: Pre-run commands

Type: array

PYTHONFLAKE8: Define bash commands to run before running PYTHONFLAKE8

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:

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"
    }
]

PYTHON_FLAKE8: Custom config file path

Type: string

PYTHON_FLAKE8: Path where to find linter configuration file

PYTHON_FLAKE8: Timeout in seconds

Type: integer

PYTHONFLAKE8: Maximum duration in seconds of the PYTHONFLAKE8 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

PYTHON_FLAKE8: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

PYTHON_ISORT: Custom arguments

Type: array of string or string

PYTHON_ISORT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PYTHON_ISORT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PYTHON_ISORT: CLI lint mode

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

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

Must be one of:

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

PYTHON_ISORT: Custom remove arguments

Type: array of string or string

PYTHON_ISORT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PYTHON_ISORT: Custom config file name

Type: string Default: ".isort.cfg"

PYTHON_ISORT: User custom config file name if different from default

PYTHON_ISORT: Disable errors

Type: boolean Default: false

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

PYTHON_ISORT: Maximum number of errors allowed

Type: number Default: 0

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

PYTHON_ISORT: Matching files extensions

Type: array of string Default: [".py", ".pyi", ".pyx", ".pxd"]

PYTHON_ISORT: 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"

PYTHON_ISORT: Matching file name regexes

Type: array of string Default: []

PYTHON_ISORT: 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"

PYTHON_ISORT: Excluding Regex

Type: string or array of string

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

PYTHON_ISORT: Including Regex

Type: string or array of string

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

PYTHON_ISORT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PYTHON_ISORT: Post-run commands

Type: array

PYTHONISORT: Define bash commands to run after running PYTHONISORT

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:

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"
    }
]

PYTHON_ISORT: Pre-run commands

Type: array

PYTHONISORT: Define bash commands to run before running PYTHONISORT

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:

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"
    }
]

PYTHON_ISORT: Custom config file path

Type: string

PYTHON_ISORT: Path where to find linter configuration file

PYTHON_ISORT: Timeout in seconds

Type: integer

PYTHONISORT: Maximum duration in seconds of the PYTHONISORT 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

PYTHON_ISORT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

PYTHON_MYPY: Custom arguments

Type: array of string or string

PYTHON_MYPY: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PYTHON_MYPY: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PYTHON_MYPY: CLI lint mode

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

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

Must be one of:

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

PYTHON_MYPY: Custom remove arguments

Type: array of string or string

PYTHON_MYPY: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PYTHON_MYPY: Custom config file name

Type: string Default: ".mypy.ini"

PYTHON_MYPY: User custom config file name if different from default

PYTHON_MYPY: Disable errors

Type: boolean Default: false

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

PYTHON_MYPY: Maximum number of errors allowed

Type: number Default: 0

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

PYTHON_MYPY: Matching files extensions

Type: array of string Default: [".py", ".pyi"]

PYTHON_MYPY: 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"

PYTHON_MYPY: Matching file name regexes

Type: array of string Default: []

PYTHON_MYPY: 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"

PYTHON_MYPY: Excluding Regex

Type: string or array of string

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

PYTHON_MYPY: Including Regex

Type: string or array of string

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

PYTHON_MYPY: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PYTHON_MYPY: Post-run commands

Type: array

PYTHONMYPY: Define bash commands to run after running PYTHONMYPY

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:

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"
    }
]

PYTHON_MYPY: Pre-run commands

Type: array

PYTHONMYPY: Define bash commands to run before running PYTHONMYPY

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:

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"
    }
]

PYTHON_MYPY: Custom config file path

Type: string

PYTHON_MYPY: Path where to find linter configuration file

PYTHON_MYPY: Timeout in seconds

Type: integer

PYTHONMYPY: Maximum duration in seconds of the PYTHONMYPY 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

PYTHON_MYPY: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

PYTHON_NBQA_MYPY: Custom arguments

Type: array of string or string

PYTHONNBQAMYPY: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PYTHON_NBQA_MYPY: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PYTHON_NBQA_MYPY: CLI lint mode

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

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

Must be one of:

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

PYTHON_NBQA_MYPY: Custom remove arguments

Type: array of string or string

PYTHONNBQAMYPY: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PYTHON_NBQA_MYPY: Custom config file name

Type: string Default: ".mypy.ini"

PYTHONNBQAMYPY: User custom config file name if different from default

PYTHON_NBQA_MYPY: Disable errors

Type: boolean Default: false

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

PYTHON_NBQA_MYPY: Maximum number of errors allowed

Type: number Default: 0

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

PYTHON_NBQA_MYPY: Matching files extensions

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

PYTHONNBQAMYPY: 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"

PYTHON_NBQA_MYPY: Matching file name regexes

Type: array of string Default: []

PYTHONNBQAMYPY: 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"

PYTHON_NBQA_MYPY: Excluding Regex

Type: string or array of string

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

PYTHON_NBQA_MYPY: Including Regex

Type: string or array of string

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

PYTHON_NBQA_MYPY: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PYTHON_NBQA_MYPY: Post-run commands

Type: array

PYTHONNBQAMYPY: Define bash commands to run after running PYTHONNBQAMYPY

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:

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"
    }
]

PYTHON_NBQA_MYPY: Pre-run commands

Type: array

PYTHONNBQAMYPY: Define bash commands to run before running PYTHONNBQAMYPY

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:

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"
    }
]

PYTHON_NBQA_MYPY: Custom config file path

Type: string

PYTHONNBQAMYPY: Path where to find linter configuration file

PYTHON_NBQA_MYPY: Timeout in seconds

Type: integer

PYTHONNBQAMYPY: Maximum duration in seconds of the PYTHONNBQAMYPY 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

PYTHON_NBQA_MYPY: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Post commands for PYTHON descriptor

Type: array

PYTHON: 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:

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 PYTHON descriptor

Type: array

PYTHON: 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:

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"
    }
]

PYTHON_PYLINT: Custom arguments

Type: array of string or string

PYTHON_PYLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PYTHON_PYLINT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PYTHON_PYLINT: CLI lint mode

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

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

Must be one of:

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

PYTHON_PYLINT: Custom remove arguments

Type: array of string or string

PYTHON_PYLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PYTHON_PYLINT: Custom config file name

Type: string Default: ".pylintrc"

PYTHON_PYLINT: User custom config file name if different from default

PYTHON_PYLINT: Disable errors

Type: boolean Default: false

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

PYTHON_PYLINT: Maximum number of errors allowed

Type: number Default: 0

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

PYTHON_PYLINT: Matching files extensions

Type: array of string Default: [".py", ".pyi"]

PYTHON_PYLINT: 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"

PYTHON_PYLINT: Matching file name regexes

Type: array of string Default: []

PYTHON_PYLINT: 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"

PYTHON_PYLINT: Excluding Regex

Type: string or array of string

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

PYTHON_PYLINT: Including Regex

Type: string or array of string

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

PYTHON_PYLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PYTHON_PYLINT: Post-run commands

Type: array

PYTHONPYLINT: Define bash commands to run after running PYTHONPYLINT

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:

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"
    }
]

PYTHON_PYLINT: Pre-run commands

Type: array

PYTHONPYLINT: Define bash commands to run before running PYTHONPYLINT

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:

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"
    }
]

PYTHON_PYLINT: Custom config file path

Type: string

PYTHON_PYLINT: Path where to find linter configuration file

PYTHON_PYLINT: Timeout in seconds

Type: integer

PYTHONPYLINT: Maximum duration in seconds of the PYTHONPYLINT 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

PYTHON_PYLINT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

PYTHON_PYRIGHT: Custom arguments

Type: array of string or string

PYTHON_PYRIGHT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PYTHON_PYRIGHT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PYTHON_PYRIGHT: CLI lint mode

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

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

Must be one of:

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

PYTHON_PYRIGHT: Custom remove arguments

Type: array of string or string

PYTHON_PYRIGHT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PYTHON_PYRIGHT: Custom config file name

Type: string Default: "pyrightconfig.json"

PYTHON_PYRIGHT: User custom config file name if different from default

PYTHON_PYRIGHT: Disable errors

Type: boolean Default: false

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

PYTHON_PYRIGHT: Maximum number of errors allowed

Type: number Default: 0

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

PYTHON_PYRIGHT: Matching files extensions

Type: array of string Default: [".py", ".pyi"]

PYTHON_PYRIGHT: 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"

PYTHON_PYRIGHT: Matching file name regexes

Type: array of string Default: []

PYTHON_PYRIGHT: 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"

PYTHON_PYRIGHT: Excluding Regex

Type: string or array of string

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

PYTHON_PYRIGHT: Including Regex

Type: string or array of string

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

PYTHON_PYRIGHT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PYTHON_PYRIGHT: Post-run commands

Type: array

PYTHONPYRIGHT: Define bash commands to run after running PYTHONPYRIGHT

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:

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"
    }
]

PYTHON_PYRIGHT: Pre-run commands

Type: array

PYTHONPYRIGHT: Define bash commands to run before running PYTHONPYRIGHT

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:

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"
    }
]

PYTHON_PYRIGHT: Custom config file path

Type: string

PYTHON_PYRIGHT: Path where to find linter configuration file

PYTHON_PYRIGHT: Timeout in seconds

Type: integer

PYTHONPYRIGHT: Maximum duration in seconds of the PYTHONPYRIGHT 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

PYTHON_PYRIGHT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

PYTHON_RUFF: Custom arguments

Type: array of string or string

PYTHON_RUFF: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PYTHON_RUFF: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PYTHON_RUFF: CLI lint mode

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

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

Must be one of:

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

PYTHON_RUFF: Custom remove arguments

Type: array of string or string

PYTHON_RUFF: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PYTHON_RUFF: Custom config file name

Type: string Default: ".ruff.toml"

PYTHON_RUFF: User custom config file name if different from default

PYTHON_RUFF: Disable errors

Type: boolean Default: false

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

PYTHON_RUFF: Maximum number of errors allowed

Type: number Default: 0

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

PYTHON_RUFF: Matching files extensions

Type: array of string Default: [".py", ".pyi", ".ipynb"]

PYTHON_RUFF: 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"

PYTHON_RUFF: Matching file name regexes

Type: array of string Default: []

PYTHON_RUFF: 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"

PYTHON_RUFF: Excluding Regex

Type: string or array of string

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

PYTHON_RUFF: Including Regex

Type: string or array of string

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

PYTHON_RUFF_FORMAT: Custom arguments

Type: array of string or string

PYTHONRUFFFORMAT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

PYTHON_RUFF_FORMAT: CLI Executable

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

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

No Additional Items

Each item of this array must be:

PYTHON_RUFF_FORMAT: CLI lint mode

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

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

Must be one of:

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

PYTHON_RUFF_FORMAT: Custom remove arguments

Type: array of string or string

PYTHONRUFFFORMAT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

PYTHON_RUFF_FORMAT: Custom config file name

Type: string Default: ".ruff.toml"

PYTHONRUFFFORMAT: User custom config file name if different from default

PYTHON_RUFF_FORMAT: Disable errors

Type: boolean Default: false

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

PYTHON_RUFF_FORMAT: Maximum number of errors allowed

Type: number Default: 0

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

PYTHON_RUFF_FORMAT: Matching files extensions

Type: array of string Default: [".py", ".pyi", ".ipynb"]

PYTHONRUFFFORMAT: 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"

PYTHON_RUFF_FORMAT: Matching file name regexes

Type: array of string Default: []

PYTHONRUFFFORMAT: 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"

PYTHON_RUFF_FORMAT: Excluding Regex

Type: string or array of string

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

PYTHON_RUFF_FORMAT: Including Regex

Type: string or array of string

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

PYTHON_RUFF_FORMAT: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PYTHON_RUFF_FORMAT: Post-run commands

Type: array

PYTHONRUFFFORMAT: Define bash commands to run after running PYTHONRUFFFORMAT

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:

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"
    }
]

PYTHON_RUFF_FORMAT: Pre-run commands

Type: array

PYTHONRUFFFORMAT: Define bash commands to run before running PYTHONRUFFFORMAT

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:

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"
    }
]

PYTHON_RUFF_FORMAT: Custom config file path

Type: string

PYTHONRUFFFORMAT: Path where to find linter configuration file

PYTHON_RUFF_FORMAT: Timeout in seconds

Type: integer

PYTHONRUFFFORMAT: Maximum duration in seconds of the PYTHONRUFFFORMAT 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

PYTHON_RUFF_FORMAT: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

PYTHON_RUFF: Forward excluded directories in project lint mode

Type: boolean Default: true

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

PYTHON_RUFF: Post-run commands

Type: array

PYTHONRUFF: Define bash commands to run after running PYTHONRUFF

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:

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"
    }
]

PYTHON_RUFF: Pre-run commands

Type: array

PYTHONRUFF: Define bash commands to run before running PYTHONRUFF

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:

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"
    }
]

PYTHON_RUFF: Custom config file path

Type: string

PYTHON_RUFF: Path where to find linter configuration file

PYTHON_RUFF: Timeout in seconds

Type: integer

PYTHONRUFF: Maximum duration in seconds of the PYTHONRUFF 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

PYTHON_RUFF: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for RAKU descriptor

Type: string or array of string

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

Including regex filter for RAKU descriptor

Type: string or array of string

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

Post commands for RAKU descriptor

Type: array

RAKU: 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:

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 RAKU descriptor

Type: array

RAKU: 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:

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"
    }
]

RAKU_RAKU: Custom arguments

Type: array of string or string

RAKU_RAKU: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

RAKU_RAKU: CLI Executable

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

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

No Additional Items

Each item of this array must be:

RAKU_RAKU: CLI lint mode

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

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

Must be one of:

  • "file"

RAKU_RAKU: Custom remove arguments

Type: array of string or string

RAKU_RAKU: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

RAKU_RAKU: Custom config file name

Type: string Default: "META6.json"

RAKU_RAKU: User custom config file name if different from default

RAKU_RAKU: Disable errors

Type: boolean Default: false

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

RAKU_RAKU: Maximum number of errors allowed

Type: number Default: 0

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

RAKU_RAKU: Matching files extensions

Type: array of string Default: [".raku", ".rakumod", ".rakutest", ".pm6", ".pl6", ".p6"]

RAKU_RAKU: 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"

RAKU_RAKU: Matching file name regexes

Type: array of string Default: []

RAKU_RAKU: 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"

RAKU_RAKU: Excluding Regex

Type: string or array of string

RAKU_RAKU: Including Regex

Type: string or array of string

RAKU_RAKU: Post-run commands

Type: array

RAKURAKU: Define bash commands to run after running RAKURAKU

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:

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"
    }
]

RAKU_RAKU: Pre-run commands

Type: array

RAKURAKU: Define bash commands to run before running RAKURAKU

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:

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"
    }
]

RAKU_RAKU: Custom config file path

Type: string

RAKU_RAKU: Path where to find linter configuration file

RAKU_RAKU: Timeout in seconds

Type: integer

RAKURAKU: Maximum duration in seconds of the RAKURAKU 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

RAKU_RAKU: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Reporters Markdown Summary type

Type: enum (of string) Default: "table-sections"

Display summary in PR/MR comments as sections, table or both

Must be one of:

  • "sections"
  • "table"
  • "sections-table"
  • "table-sections"

Reporters Markdown type

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

Define simple if you do not to have external images in PR/MR comments

Must be one of:

  • "simple"
  • "advanced"

Reports Output folder

Type: string Default: "megalinter-reports"

The location where the output reporting will be generated to

REPOSITORY_BETTERLEAKS: Custom arguments

Type: array of string or string

REPOSITORY_BETTERLEAKS: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_BETTERLEAKS: CLI Executable

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

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

No Additional Items

Each item of this array must be:

REPOSITORY_BETTERLEAKS: CLI lint mode

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

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

Must be one of:

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

REPOSITORY_BETTERLEAKS: Custom remove arguments

Type: array of string or string

REPOSITORY_BETTERLEAKS: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_BETTERLEAKS: Custom config file name

Type: string Default: ".betterleaks.toml"

REPOSITORY_BETTERLEAKS: User custom config file name if different from default

REPOSITORY_BETTERLEAKS: Disable errors

Type: boolean Default: false

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

REPOSITORY_BETTERLEAKS: Maximum number of errors allowed

Type: number Default: 0

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

REPOSITORY_BETTERLEAKS: Excluding Regex

Type: string or array of string

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

REPOSITORY_BETTERLEAKS: Including Regex

Type: string or array of string

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

REPOSITORY_BETTERLEAKS: Forward excluded directories in project lint mode

Type: boolean Default: true

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

REPOSITORY_BETTERLEAKS: Post-run commands

Type: array

REPOSITORYBETTERLEAKS: Define bash commands to run after running REPOSITORYBETTERLEAKS

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:

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"
    }
]

REPOSITORY_BETTERLEAKS: Pre-run commands

Type: array

REPOSITORYBETTERLEAKS: Define bash commands to run before running REPOSITORYBETTERLEAKS

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:

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"
    }
]

REPOSITORY_BETTERLEAKS: Custom config file path

Type: string

REPOSITORY_BETTERLEAKS: Path where to find linter configuration file

REPOSITORY_BETTERLEAKS: Timeout in seconds

Type: integer

REPOSITORYBETTERLEAKS: Maximum duration in seconds of the REPOSITORYBETTERLEAKS 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

REPOSITORY_BETTERLEAKS: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

REPOSITORY_CHECKOV: Custom arguments

Type: array of string or string

REPOSITORY_CHECKOV: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_CHECKOV: CLI Executable

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

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

No Additional Items

Each item of this array must be:

REPOSITORY_CHECKOV: CLI lint mode

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

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

Must be one of:

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

REPOSITORY_CHECKOV: Custom remove arguments

Type: array of string or string

REPOSITORY_CHECKOV: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_CHECKOV: Custom config file name

Type: string Default: ".checkov.yml"

REPOSITORY_CHECKOV: User custom config file name if different from default

REPOSITORY_CHECKOV: Disable errors

Type: boolean Default: false

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

REPOSITORY_CHECKOV: Maximum number of errors allowed

Type: number Default: 0

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

REPOSITORY_CHECKOV: Excluding Regex

Type: string or array of string

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

REPOSITORY_CHECKOV: Including Regex

Type: string or array of string

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

REPOSITORY_CHECKOV: Forward excluded directories in project lint mode

Type: boolean Default: true

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

REPOSITORY_CHECKOV: Post-run commands

Type: array

REPOSITORYCHECKOV: Define bash commands to run after running REPOSITORYCHECKOV

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:

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"
    }
]

REPOSITORY_CHECKOV: Pre-run commands

Type: array

REPOSITORYCHECKOV: Define bash commands to run before running REPOSITORYCHECKOV

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:

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"
    }
]

REPOSITORY_CHECKOV: Custom config file path

Type: string

REPOSITORY_CHECKOV: Path where to find linter configuration file

REPOSITORY_CHECKOV: Timeout in seconds

Type: integer

REPOSITORYCHECKOV: Maximum duration in seconds of the REPOSITORYCHECKOV 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

REPOSITORY_CHECKOV: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

REPOSITORY_DEVSKIM: Custom arguments

Type: array of string or string

REPOSITORY_DEVSKIM: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_DEVSKIM: CLI Executable

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

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

No Additional Items

Each item of this array must be:

REPOSITORY_DEVSKIM: CLI lint mode

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

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

Must be one of:

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

REPOSITORY_DEVSKIM: Custom remove arguments

Type: array of string or string

REPOSITORY_DEVSKIM: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_DEVSKIM: Custom config file name

Type: string Default: ".devskim.json"

REPOSITORY_DEVSKIM: User custom config file name if different from default

REPOSITORY_DEVSKIM: Disable errors

Type: boolean Default: false

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

REPOSITORY_DEVSKIM: Maximum number of errors allowed

Type: number Default: 0

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

REPOSITORY_DEVSKIM: Excluding Regex

Type: string or array of string

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

REPOSITORY_DEVSKIM: Including Regex

Type: string or array of string

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

REPOSITORY_DEVSKIM: Forward excluded directories in project lint mode

Type: boolean Default: true

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

REPOSITORY_DEVSKIM: Post-run commands

Type: array

REPOSITORYDEVSKIM: Define bash commands to run after running REPOSITORYDEVSKIM

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:

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"
    }
]

REPOSITORY_DEVSKIM: Pre-run commands

Type: array

REPOSITORYDEVSKIM: Define bash commands to run before running REPOSITORYDEVSKIM

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:

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"
    }
]

REPOSITORY_DEVSKIM: Custom config file path

Type: string

REPOSITORY_DEVSKIM: Path where to find linter configuration file

REPOSITORY_DEVSKIM: Timeout in seconds

Type: integer

REPOSITORYDEVSKIM: Maximum duration in seconds of the REPOSITORYDEVSKIM 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

REPOSITORY_DEVSKIM: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

REPOSITORY_DUSTILOCK: Custom arguments

Type: array of string or string

REPOSITORY_DUSTILOCK: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_DUSTILOCK: CLI Executable

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

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

No Additional Items

Each item of this array must be:

REPOSITORY_DUSTILOCK: CLI lint mode

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

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

Must be one of:

  • "project"

REPOSITORY_DUSTILOCK: Custom remove arguments

Type: array of string or string

REPOSITORY_DUSTILOCK: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_DUSTILOCK: Disable errors

Type: boolean Default: false

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

REPOSITORY_DUSTILOCK: Maximum number of errors allowed

Type: number Default: 0

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

REPOSITORY_DUSTILOCK: Excluding Regex

Type: string or array of string

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

REPOSITORY_DUSTILOCK: Including Regex

Type: string or array of string

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

REPOSITORY_DUSTILOCK: Forward excluded directories in project lint mode

Type: boolean Default: true

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

REPOSITORY_DUSTILOCK: Post-run commands

Type: array

REPOSITORYDUSTILOCK: Define bash commands to run after running REPOSITORYDUSTILOCK

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:

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"
    }
]

REPOSITORY_DUSTILOCK: Pre-run commands

Type: array

REPOSITORYDUSTILOCK: Define bash commands to run before running REPOSITORYDUSTILOCK

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:

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"
    }
]

REPOSITORY_DUSTILOCK: Timeout in seconds

Type: integer

REPOSITORYDUSTILOCK: Maximum duration in seconds of the REPOSITORYDUSTILOCK 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

REPOSITORY_DUSTILOCK: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

Excluding regex filter for REPOSITORY descriptor

Type: string or array of string

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

Including regex filter for REPOSITORY descriptor

Type: string or array of string

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

(deprecated) REPOSITORY_GITLEAKS: Custom arguments

Type: array of string or string

REPOSITORY_GITLEAKS: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) REPOSITORY_GITLEAKS: CLI Executable

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

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

No Additional Items

Each item of this array must be:

(deprecated) REPOSITORY_GITLEAKS: CLI lint mode

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

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

Must be one of:

  • "file"
  • "project"

(deprecated) REPOSITORY_GITLEAKS: Custom remove arguments

Type: array of string or string

REPOSITORY_GITLEAKS: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) REPOSITORY_GITLEAKS: Custom config file name

Type: string Default: ".gitleaks.toml"

REPOSITORY_GITLEAKS: User custom config file name if different from default

(deprecated) REPOSITORY_GITLEAKS: Disable errors

Type: boolean Default: false

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

(deprecated) REPOSITORY_GITLEAKS: Maximum number of errors allowed

Type: number Default: 0

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

(deprecated) REPOSITORY_GITLEAKS: Excluding Regex

Type: string or array of string

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

(deprecated) REPOSITORY_GITLEAKS: Including Regex

Type: string or array of string

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

(deprecated) REPOSITORY_GITLEAKS: Post-run commands

Type: array

(deprecated) REPOSITORYGITLEAKS: Define bash commands to run after running REPOSITORYGITLEAKS

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:

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) REPOSITORY_GITLEAKS: Pre-run commands

Type: array

(deprecated) REPOSITORYGITLEAKS: Define bash commands to run before running REPOSITORYGITLEAKS

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:

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) REPOSITORY_GITLEAKS: Scan only commits in the current Pull Request/Merge Request

Type: boolean Default: false

(deprecated) REPOSITORY_GITLEAKS: Source commit SHA of the Pull Request/Merge Request

Type: string Default: ""

(deprecated) REPOSITORY_GITLEAKS: Target commit SHA of the Pull Request/Merge Request

Type: string Default: ""

(deprecated) REPOSITORY_GITLEAKS: Custom config file path

Type: string

REPOSITORY_GITLEAKS: Path where to find linter configuration file

(deprecated) REPOSITORY_GITLEAKS: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

REPOSITORY_GIT_DIFF: Custom arguments

Type: array of string or string

REPOSITORYGITDIFF: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_GIT_DIFF: CLI Executable

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

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

No Additional Items

Each item of this array must be:

REPOSITORY_GIT_DIFF: CLI lint mode

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

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

Must be one of:

  • "project"

REPOSITORY_GIT_DIFF: Custom remove arguments

Type: array of string or string

REPOSITORYGITDIFF: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_GIT_DIFF: Disable errors

Type: boolean Default: false

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

REPOSITORY_GIT_DIFF: Maximum number of errors allowed

Type: number Default: 0

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

REPOSITORY_GIT_DIFF: Excluding Regex

Type: string or array of string

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

REPOSITORY_GIT_DIFF: Including Regex

Type: string or array of string

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

REPOSITORY_GIT_DIFF: Forward excluded directories in project lint mode

Type: boolean Default: true

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

REPOSITORY_GIT_DIFF: Post-run commands

Type: array

REPOSITORYGITDIFF: Define bash commands to run after running REPOSITORYGITDIFF

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:

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"
    }
]

REPOSITORY_GIT_DIFF: Pre-run commands

Type: array

REPOSITORYGITDIFF: Define bash commands to run before running REPOSITORYGITDIFF

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:

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"
    }
]

REPOSITORY_GIT_DIFF: Timeout in seconds

Type: integer

REPOSITORYGITDIFF: Maximum duration in seconds of the REPOSITORYGITDIFF 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

REPOSITORY_GIT_DIFF: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

(deprecated) (removed) REPOSITORY_GOODCHECK: Custom arguments

Type: array of string or string

REPOSITORY_GOODCHECK: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) (removed) REPOSITORY_GOODCHECK: CLI Executable

Type: array of string Default: [["goodcheck"]]
No Additional Items

Each item of this array must be:

(deprecated) (removed) REPOSITORY_GOODCHECK: Custom config file name

Type: string Default: "goodcheck.yml"

REPOSITORY_GOODCHECK: User custom config file name if different from default

(deprecated) (removed) REPOSITORY_GOODCHECK: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

(deprecated) (removed) REPOSITORY_GOODCHECK: Maximum number of errors allowed

Type: number Default: 0

(deprecated) (removed) REPOSITORY_GOODCHECK: 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:

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) REPOSITORY_GOODCHECK: 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:

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) REPOSITORY_GOODCHECK: Custom config file path

Type: string

REPOSITORY_GOODCHECK: Path where to find linter configuration file

REPOSITORY_GRYPE: Custom arguments

Type: array of string or string

REPOSITORY_GRYPE: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_GRYPE: CLI Executable

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

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

No Additional Items

Each item of this array must be:

REPOSITORY_GRYPE: CLI lint mode

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

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

Must be one of:

  • "file"
  • "project"

REPOSITORY_GRYPE: Custom remove arguments

Type: array of string or string

REPOSITORY_GRYPE: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_GRYPE: Custom config file name

Type: string Default: ".grype.yaml"

REPOSITORY_GRYPE: User custom config file name if different from default

REPOSITORY_GRYPE: Disable errors

Type: boolean Default: false

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

REPOSITORY_GRYPE: Maximum number of errors allowed

Type: number Default: 0

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

REPOSITORY_GRYPE: Excluding Regex

Type: string or array of string

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

REPOSITORY_GRYPE: Including Regex

Type: string or array of string

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

REPOSITORY_GRYPE: Forward excluded directories in project lint mode

Type: boolean Default: true

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

REPOSITORY_GRYPE: Post-run commands

Type: array

REPOSITORYGRYPE: Define bash commands to run after running REPOSITORYGRYPE

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:

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"
    }
]

REPOSITORY_GRYPE: Pre-run commands

Type: array

REPOSITORYGRYPE: Define bash commands to run before running REPOSITORYGRYPE

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:

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"
    }
]

REPOSITORY_GRYPE: Custom config file path

Type: string

REPOSITORY_GRYPE: Path where to find linter configuration file

REPOSITORY_GRYPE: Timeout in seconds

Type: integer

REPOSITORYGRYPE: Maximum duration in seconds of the REPOSITORYGRYPE 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

REPOSITORY_GRYPE: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

(deprecated) REPOSITORY_KICS: Custom arguments

Type: array of string or string

REPOSITORY_KICS: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) REPOSITORY_KICS: CLI Executable

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

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

No Additional Items

Each item of this array must be:

(deprecated) REPOSITORY_KICS: CLI lint mode

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

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

Must be one of:

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

(deprecated) REPOSITORY_KICS: Custom remove arguments

Type: array of string or string

REPOSITORY_KICS: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) REPOSITORY_KICS: Custom config file name

Type: string Default: "kics.config"

REPOSITORY_KICS: User custom config file name if different from default

(deprecated) REPOSITORY_KICS: Disable errors

Type: boolean Default: false

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

(deprecated) REPOSITORY_KICS: Maximum number of errors allowed

Type: number Default: 0

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

(deprecated) REPOSITORY_KICS: Excluding Regex

Type: string or array of string

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

(deprecated) REPOSITORY_KICS: Including Regex

Type: string or array of string

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

(deprecated) REPOSITORY_KICS: Post-run commands

Type: array

REPOSITORYKICS: Define bash commands to run after running REPOSITORYKICS

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:

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) REPOSITORY_KICS: Pre-run commands

Type: array

REPOSITORYKICS: Define bash commands to run before running REPOSITORYKICS

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:

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) REPOSITORY_KICS: Custom config file path

Type: string

REPOSITORY_KICS: Path where to find linter configuration file

(deprecated) REPOSITORY_KICS: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

REPOSITORY_KINGFISHER: Custom arguments

Type: array of string or string

REPOSITORY_KINGFISHER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_KINGFISHER: CLI Executable

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

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

No Additional Items

Each item of this array must be:

REPOSITORY_KINGFISHER: CLI lint mode

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

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

Must be one of:

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

REPOSITORY_KINGFISHER: Custom remove arguments

Type: array of string or string

REPOSITORY_KINGFISHER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_KINGFISHER: Disable errors

Type: boolean Default: false

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

REPOSITORY_KINGFISHER: Maximum number of errors allowed

Type: number Default: 0

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

REPOSITORY_KINGFISHER: Excluding Regex

Type: string or array of string

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

REPOSITORY_KINGFISHER: Including Regex

Type: string or array of string

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

REPOSITORY_KINGFISHER: Forward excluded directories in project lint mode

Type: boolean Default: true

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

REPOSITORY_KINGFISHER: Post-run commands

Type: array

REPOSITORYKINGFISHER: Define bash commands to run after running REPOSITORYKINGFISHER

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:

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"
    }
]

REPOSITORY_KINGFISHER: Pre-run commands

Type: array

REPOSITORYKINGFISHER: Define bash commands to run before running REPOSITORYKINGFISHER

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:

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"
    }
]

REPOSITORY_KINGFISHER: Timeout in seconds

Type: integer

REPOSITORYKINGFISHER: Maximum duration in seconds of the REPOSITORYKINGFISHER 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

REPOSITORY_KINGFISHER: Unsecured env variables

Type: array of string Default: []

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

No Additional Items

Each item of this array must be:

REPOSITORY_LS_LINT: Custom arguments

Type: array of string or string

REPOSITORYLSLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_LS_LINT: CLI Executable

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

REPOSITORYLSLINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

REPOSITORY_LS_LINT: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORYLSLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

REPOSITORY_LS_LINT: Custom remove arguments

Type: array of string or string

REPOSITORYLSLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_LS_LINT: Custom config file name

Type: string Default: ".ls-lint.yml"

REPOSITORYLSLINT: User custom config file name if different from default

REPOSITORY_LS_LINT: Disable errors

Type: boolean Default: false

REPOSITORYLSLINT: If true, REPOSITORYLSLINT doesn't make MegaLinter fail even if errors are found

REPOSITORY_LS_LINT: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYLSLINT: If the number of errors found is less than this value, REPOSITORYLSLINT doesn't make MegaLinter fail

REPOSITORY_LS_LINT: Excluding Regex

Type: string or array of string

REPOSITORYLSLINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with REPOSITORYLSLINTCLILINT_MODE = project

REPOSITORY_LS_LINT: Including Regex

Type: string or array of string

REPOSITORYLSLINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with REPOSITORYLSLINTCLILINT_MODE = project

REPOSITORY_LS_LINT: Forward excluded directories in project lint mode

Type: boolean Default: true

REPOSITORYLSLINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

REPOSITORY_LS_LINT: Post-run commands

Type: array

REPOSITORYLSLINT: Define bash commands to run after running REPOSITORYLSLINT

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:

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"
    }
]

REPOSITORY_LS_LINT: Pre-run commands

Type: array

REPOSITORYLSLINT: Define bash commands to run before running REPOSITORYLSLINT

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:

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"
    }
]

REPOSITORY_LS_LINT: Custom config file path

Type: string

REPOSITORYLSLINT: Path where to find linter configuration file

REPOSITORY_LS_LINT: Timeout in seconds

Type: integer

REPOSITORYLSLINT: Maximum duration in seconds of the REPOSITORYLSLINT 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

REPOSITORY_LS_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORYLSLINT and its pre/post commands

No Additional Items

Each item of this array must be:

REPOSITORY_OSV_SCANNER: Custom arguments

Type: array of string or string

REPOSITORYOSVSCANNER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_OSV_SCANNER: CLI Executable

Type: array of string Default: [["osv-scanner"]]

REPOSITORYOSVSCANNER: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

REPOSITORY_OSV_SCANNER: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORYOSVSCANNER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

REPOSITORY_OSV_SCANNER: Custom remove arguments

Type: array of string or string

REPOSITORYOSVSCANNER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_OSV_SCANNER: Custom config file name

Type: string Default: "osv-scanner.toml"

REPOSITORYOSVSCANNER: User custom config file name if different from default

REPOSITORY_OSV_SCANNER: Disable errors

Type: boolean Default: false

REPOSITORYOSVSCANNER: If true, REPOSITORYOSVSCANNER doesn't make MegaLinter fail even if errors are found

REPOSITORY_OSV_SCANNER: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYOSVSCANNER: If the number of errors found is less than this value, REPOSITORYOSVSCANNER doesn't make MegaLinter fail

REPOSITORY_OSV_SCANNER: Excluding Regex

Type: string or array of string

REPOSITORYOSVSCANNER: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with REPOSITORYOSVSCANNERCLILINT_MODE = project

REPOSITORY_OSV_SCANNER: Including Regex

Type: string or array of string

REPOSITORYOSVSCANNER: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with REPOSITORYOSVSCANNERCLILINT_MODE = project

REPOSITORY_OSV_SCANNER: Forward excluded directories in project lint mode

Type: boolean Default: true

REPOSITORYOSVSCANNER: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

REPOSITORY_OSV_SCANNER: Post-run commands

Type: array

REPOSITORYOSVSCANNER: Define bash commands to run after running REPOSITORYOSVSCANNER

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:

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"
    }
]

REPOSITORY_OSV_SCANNER: Pre-run commands

Type: array

REPOSITORYOSVSCANNER: Define bash commands to run before running REPOSITORYOSVSCANNER

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:

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"
    }
]

REPOSITORY_OSV_SCANNER: Custom config file path

Type: string

REPOSITORYOSVSCANNER: Path where to find linter configuration file

REPOSITORY_OSV_SCANNER: Timeout in seconds

Type: integer

REPOSITORYOSVSCANNER: Maximum duration in seconds of the REPOSITORYOSVSCANNER 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

REPOSITORY_OSV_SCANNER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORYOSVSCANNER and its pre/post commands

No Additional Items

Each item of this array must be:

Post commands for REPOSITORY descriptor

Type: array

REPOSITORY: 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:

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 REPOSITORY descriptor

Type: array

REPOSITORY: 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:

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"
    }
]

REPOSITORY_SECRETLINT: Custom arguments

Type: array of string or string

REPOSITORY_SECRETLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_SECRETLINT: CLI Executable

Type: array of string Default: [["secretlint"]]

REPOSITORY_SECRETLINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

REPOSITORY_SECRETLINT: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_SECRETLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

REPOSITORY_SECRETLINT: Custom remove arguments

Type: array of string or string

REPOSITORY_SECRETLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_SECRETLINT: Custom config file name

Type: string Default: ".secretlintrc.json"

REPOSITORY_SECRETLINT: User custom config file name if different from default

REPOSITORY_SECRETLINT: Disable errors

Type: boolean Default: false

REPOSITORYSECRETLINT: If true, REPOSITORYSECRETLINT doesn't make MegaLinter fail even if errors are found

REPOSITORY_SECRETLINT: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYSECRETLINT: If the number of errors found is less than this value, REPOSITORYSECRETLINT doesn't make MegaLinter fail

REPOSITORY_SECRETLINT: Excluding Regex

Type: string or array of string

REPOSITORYSECRETLINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with REPOSITORYSECRETLINTCLILINT_MODE = project

REPOSITORY_SECRETLINT: Including Regex

Type: string or array of string

REPOSITORYSECRETLINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with REPOSITORYSECRETLINTCLILINT_MODE = project

REPOSITORY_SECRETLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

REPOSITORY_SECRETLINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

REPOSITORY_SECRETLINT: Post-run commands

Type: array

REPOSITORYSECRETLINT: Define bash commands to run after running REPOSITORYSECRETLINT

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:

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"
    }
]

REPOSITORY_SECRETLINT: Pre-run commands

Type: array

REPOSITORYSECRETLINT: Define bash commands to run before running REPOSITORYSECRETLINT

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:

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"
    }
]

REPOSITORY_SECRETLINT: Custom config file path

Type: string

REPOSITORY_SECRETLINT: Path where to find linter configuration file

REPOSITORY_SECRETLINT: Timeout in seconds

Type: integer

REPOSITORYSECRETLINT: Maximum duration in seconds of the REPOSITORYSECRETLINT 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

REPOSITORY_SECRETLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_SECRETLINT and its pre/post commands

No Additional Items

Each item of this array must be:

REPOSITORY_SEMGREP: Custom arguments

Type: array of string or string

REPOSITORY_SEMGREP: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_SEMGREP: CLI Executable

Type: array of string Default: [["semgrep"]]

REPOSITORY_SEMGREP: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

REPOSITORY_SEMGREP: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_SEMGREP: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

REPOSITORY_SEMGREP: Custom remove arguments

Type: array of string or string

REPOSITORY_SEMGREP: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_SEMGREP: Disable errors

Type: boolean Default: false

REPOSITORYSEMGREP: If true, REPOSITORYSEMGREP doesn't make MegaLinter fail even if errors are found

REPOSITORY_SEMGREP: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYSEMGREP: If the number of errors found is less than this value, REPOSITORYSEMGREP doesn't make MegaLinter fail

REPOSITORY_SEMGREP: Excluding Regex

Type: string or array of string

REPOSITORYSEMGREP: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with REPOSITORYSEMGREPCLILINT_MODE = project

REPOSITORY_SEMGREP: Including Regex

Type: string or array of string

REPOSITORYSEMGREP: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with REPOSITORYSEMGREPCLILINT_MODE = project

REPOSITORY_SEMGREP: Forward excluded directories in project lint mode

Type: boolean Default: true

REPOSITORY_SEMGREP: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

REPOSITORY_SEMGREP: Post-run commands

Type: array

REPOSITORYSEMGREP: Define bash commands to run after running REPOSITORYSEMGREP

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:

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"
    }
]

REPOSITORY_SEMGREP: Pre-run commands

Type: array

REPOSITORYSEMGREP: Define bash commands to run before running REPOSITORYSEMGREP

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:

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"
    }
]

REPOSITORY_SEMGREP: Custom arguments

Type: array of string or string

REPOSITORY_SEMGREP: Specify custom ruleset(s) for semgrep

No Additional Items

Each item of this array must be:

REPOSITORY_SEMGREP: Timeout in seconds

Type: integer

REPOSITORYSEMGREP: Maximum duration in seconds of the REPOSITORYSEMGREP 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

REPOSITORY_SEMGREP: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_SEMGREP and its pre/post commands

No Additional Items

Each item of this array must be:

REPOSITORY_SYFT: Custom arguments

Type: array of string or string

REPOSITORY_SYFT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_SYFT: CLI Executable

Type: array of string Default: [["syft"]]

REPOSITORY_SYFT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

REPOSITORY_SYFT: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_SYFT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

REPOSITORY_SYFT: Custom remove arguments

Type: array of string or string

REPOSITORY_SYFT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_SYFT: Custom config file name

Type: string Default: ".syft.yaml"

REPOSITORY_SYFT: User custom config file name if different from default

REPOSITORY_SYFT: Disable errors

Type: boolean Default: false

REPOSITORYSYFT: If true, REPOSITORYSYFT doesn't make MegaLinter fail even if errors are found

REPOSITORY_SYFT: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYSYFT: If the number of errors found is less than this value, REPOSITORYSYFT doesn't make MegaLinter fail

REPOSITORY_SYFT: Excluding Regex

Type: string or array of string

REPOSITORYSYFT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with REPOSITORYSYFTCLILINT_MODE = project

REPOSITORY_SYFT: Including Regex

Type: string or array of string

REPOSITORYSYFT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with REPOSITORYSYFTCLILINT_MODE = project

REPOSITORY_SYFT: Forward excluded directories in project lint mode

Type: boolean Default: true

REPOSITORY_SYFT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

REPOSITORY_SYFT: Post-run commands

Type: array

REPOSITORYSYFT: Define bash commands to run after running REPOSITORYSYFT

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:

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"
    }
]

REPOSITORY_SYFT: Pre-run commands

Type: array

REPOSITORYSYFT: Define bash commands to run before running REPOSITORYSYFT

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:

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"
    }
]

REPOSITORY_SYFT: Custom config file path

Type: string

REPOSITORY_SYFT: Path where to find linter configuration file

REPOSITORY_SYFT: Timeout in seconds

Type: integer

REPOSITORYSYFT: Maximum duration in seconds of the REPOSITORYSYFT 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

REPOSITORY_SYFT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_SYFT and its pre/post commands

No Additional Items

Each item of this array must be:

REPOSITORY_TRIVY: Custom arguments

Type: array of string or string

REPOSITORY_TRIVY: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_TRIVY: CLI Executable

Type: array of string Default: [["trivy"]]

REPOSITORY_TRIVY: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

REPOSITORY_TRIVY: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_TRIVY: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

REPOSITORY_TRIVY: Custom remove arguments

Type: array of string or string

REPOSITORY_TRIVY: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_TRIVY: Custom config file name

Type: string Default: "trivy.yaml"

REPOSITORY_TRIVY: User custom config file name if different from default

REPOSITORY_TRIVY: Disable errors

Type: boolean Default: false

REPOSITORYTRIVY: If true, REPOSITORYTRIVY doesn't make MegaLinter fail even if errors are found

REPOSITORY_TRIVY: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYTRIVY: If the number of errors found is less than this value, REPOSITORYTRIVY doesn't make MegaLinter fail

REPOSITORY_TRIVY: Excluding Regex

Type: string or array of string

REPOSITORYTRIVY: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with REPOSITORYTRIVYCLILINT_MODE = project

REPOSITORY_TRIVY: Including Regex

Type: string or array of string

REPOSITORYTRIVY: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with REPOSITORYTRIVYCLILINT_MODE = project

REPOSITORY_TRIVY: Forward excluded directories in project lint mode

Type: boolean Default: true

REPOSITORY_TRIVY: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

REPOSITORY_TRIVY: Post-run commands

Type: array

REPOSITORYTRIVY: Define bash commands to run after running REPOSITORYTRIVY

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:

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"
    }
]

REPOSITORY_TRIVY: Pre-run commands

Type: array

REPOSITORYTRIVY: Define bash commands to run before running REPOSITORYTRIVY

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:

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"
    }
]

REPOSITORY_TRIVY: Custom config file path

Type: string

REPOSITORY_TRIVY: Path where to find linter configuration file

REPOSITORY_TRIVY_SBOM: Custom arguments

Type: array of string or string

REPOSITORYTRIVYSBOM: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_TRIVY_SBOM: CLI Executable

Type: array of string Default: [["trivy"]]

REPOSITORYTRIVYSBOM: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

REPOSITORY_TRIVY_SBOM: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORYTRIVYSBOM: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "project"

REPOSITORY_TRIVY_SBOM: Custom remove arguments

Type: array of string or string

REPOSITORYTRIVYSBOM: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_TRIVY_SBOM: Custom config file name

Type: string Default: "trivy-sbom.yaml"

REPOSITORYTRIVYSBOM: User custom config file name if different from default

REPOSITORY_TRIVY_SBOM: Disable errors

Type: boolean Default: false

REPOSITORYTRIVYSBOM: If true, REPOSITORYTRIVYSBOM doesn't make MegaLinter fail even if errors are found

REPOSITORY_TRIVY_SBOM: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYTRIVYSBOM: If the number of errors found is less than this value, REPOSITORYTRIVYSBOM doesn't make MegaLinter fail

REPOSITORY_TRIVY_SBOM: Excluding Regex

Type: string or array of string

REPOSITORYTRIVYSBOM: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with REPOSITORYTRIVYSBOMCLILINT_MODE = project

REPOSITORY_TRIVY_SBOM: Including Regex

Type: string or array of string

REPOSITORYTRIVYSBOM: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with REPOSITORYTRIVYSBOMCLILINT_MODE = project

REPOSITORY_TRIVY_SBOM: Forward excluded directories in project lint mode

Type: boolean Default: true

REPOSITORYTRIVYSBOM: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

REPOSITORY_TRIVY_SBOM: Post-run commands

Type: array

REPOSITORYTRIVYSBOM: Define bash commands to run after running REPOSITORYTRIVYSBOM

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:

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"
    }
]

REPOSITORY_TRIVY_SBOM: Pre-run commands

Type: array

REPOSITORYTRIVYSBOM: Define bash commands to run before running REPOSITORYTRIVYSBOM

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:

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"
    }
]

REPOSITORY_TRIVY_SBOM: Custom config file path

Type: string

REPOSITORYTRIVYSBOM: Path where to find linter configuration file

REPOSITORY_TRIVY_SBOM: Timeout in seconds

Type: integer

REPOSITORYTRIVYSBOM: Maximum duration in seconds of the REPOSITORYTRIVYSBOM 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

REPOSITORY_TRIVY_SBOM: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORYTRIVYSBOM and its pre/post commands

No Additional Items

Each item of this array must be:

REPOSITORY_TRIVY: Timeout in seconds

Type: integer

REPOSITORYTRIVY: Maximum duration in seconds of the REPOSITORYTRIVY 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

REPOSITORY_TRIVY: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_TRIVY and its pre/post commands

No Additional Items

Each item of this array must be:

REPOSITORY_TRUFFLEHOG: Custom arguments

Type: array of string or string

REPOSITORY_TRUFFLEHOG: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

REPOSITORY_TRUFFLEHOG: CLI Executable

Type: array of string Default: [["trufflehog"]]

REPOSITORY_TRUFFLEHOG: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

REPOSITORY_TRUFFLEHOG: CLI lint mode

Type: enum (of string) Default: "project"

REPOSITORY_TRUFFLEHOG: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

REPOSITORY_TRUFFLEHOG: Custom remove arguments

Type: array of string or string

REPOSITORY_TRUFFLEHOG: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

REPOSITORY_TRUFFLEHOG: Custom config file name

Type: string Default: ".trufflehog.yml"

REPOSITORY_TRUFFLEHOG: User custom config file name if different from default

REPOSITORY_TRUFFLEHOG: Disable errors

Type: boolean Default: false

REPOSITORYTRUFFLEHOG: If true, REPOSITORYTRUFFLEHOG doesn't make MegaLinter fail even if errors are found

REPOSITORY_TRUFFLEHOG: Maximum number of errors allowed

Type: number Default: 0

REPOSITORYTRUFFLEHOG: If the number of errors found is less than this value, REPOSITORYTRUFFLEHOG doesn't make MegaLinter fail

REPOSITORY_TRUFFLEHOG: Excluding Regex

Type: string or array of string

REPOSITORYTRUFFLEHOG: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with REPOSITORYTRUFFLEHOGCLILINT_MODE = project

REPOSITORY_TRUFFLEHOG: Including Regex

Type: string or array of string

REPOSITORYTRUFFLEHOG: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with REPOSITORYTRUFFLEHOGCLILINT_MODE = project

REPOSITORY_TRUFFLEHOG: Forward excluded directories in project lint mode

Type: boolean Default: true

REPOSITORY_TRUFFLEHOG: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

REPOSITORY_TRUFFLEHOG: Post-run commands

Type: array

REPOSITORYTRUFFLEHOG: Define bash commands to run after running REPOSITORYTRUFFLEHOG

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:

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"
    }
]

REPOSITORY_TRUFFLEHOG: Pre-run commands

Type: array

REPOSITORYTRUFFLEHOG: Define bash commands to run before running REPOSITORYTRUFFLEHOG

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:

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"
    }
]

REPOSITORY_TRUFFLEHOG: Custom config file path

Type: string

REPOSITORY_TRUFFLEHOG: Path where to find linter configuration file

REPOSITORY_TRUFFLEHOG: Timeout in seconds

Type: integer

REPOSITORYTRUFFLEHOG: Maximum duration in seconds of the REPOSITORYTRUFFLEHOG 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

REPOSITORY_TRUFFLEHOG: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling REPOSITORY_TRUFFLEHOG and its pre/post commands

No Additional Items

Each item of this array must be:

Excluding regex filter for ROBOTFRAMEWORK descriptor

Type: string or array of string

ROBOTFRAMEWORK: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for ROBOTFRAMEWORK descriptor

Type: string or array of string

ROBOTFRAMEWORK: Custom regex including filter: only files matching this regex will be linted

Post commands for ROBOTFRAMEWORK descriptor

Type: array

ROBOTFRAMEWORK: 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:

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 ROBOTFRAMEWORK descriptor

Type: array

ROBOTFRAMEWORK: 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:

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"
    }
]

ROBOTFRAMEWORK_ROBOCOP: Custom arguments

Type: array of string or string

ROBOTFRAMEWORK_ROBOCOP: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

ROBOTFRAMEWORK_ROBOCOP: CLI Executable

Type: array of string Default: [["robocop"]]

ROBOTFRAMEWORK_ROBOCOP: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

ROBOTFRAMEWORK_ROBOCOP: CLI lint mode

Type: enum (of string) Default: "list_of_files"

ROBOTFRAMEWORK_ROBOCOP: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

ROBOTFRAMEWORK_ROBOCOP: Custom remove arguments

Type: array of string or string

ROBOTFRAMEWORK_ROBOCOP: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

ROBOTFRAMEWORK_ROBOCOP: Custom config file name

Type: string Default: "robocop.toml"

ROBOTFRAMEWORK_ROBOCOP: User custom config file name if different from default

ROBOTFRAMEWORK_ROBOCOP: Disable errors

Type: boolean Default: false

ROBOTFRAMEWORKROBOCOP: If true, ROBOTFRAMEWORKROBOCOP doesn't make MegaLinter fail even if errors are found

ROBOTFRAMEWORK_ROBOCOP: Maximum number of errors allowed

Type: number Default: 0

ROBOTFRAMEWORKROBOCOP: If the number of errors found is less than this value, ROBOTFRAMEWORKROBOCOP doesn't make MegaLinter fail

ROBOTFRAMEWORK_ROBOCOP: Matching files extensions

Type: array of string Default: [".robot", ".resource"]

ROBOTFRAMEWORK_ROBOCOP: 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"

ROBOTFRAMEWORK_ROBOCOP: Matching file name regexes

Type: array of string Default: []

ROBOTFRAMEWORK_ROBOCOP: 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"

ROBOTFRAMEWORK_ROBOCOP: Excluding Regex

Type: string or array of string

ROBOTFRAMEWORKROBOCOP: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with ROBOTFRAMEWORKROBOCOPCLILINT_MODE = project

ROBOTFRAMEWORK_ROBOCOP: Including Regex

Type: string or array of string

ROBOTFRAMEWORKROBOCOP: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with ROBOTFRAMEWORKROBOCOPCLILINT_MODE = project

ROBOTFRAMEWORK_ROBOCOP: Forward excluded directories in project lint mode

Type: boolean Default: true

ROBOTFRAMEWORK_ROBOCOP: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

ROBOTFRAMEWORK_ROBOCOP: Post-run commands

Type: array

ROBOTFRAMEWORKROBOCOP: Define bash commands to run after running ROBOTFRAMEWORKROBOCOP

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:

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"
    }
]

ROBOTFRAMEWORK_ROBOCOP: Pre-run commands

Type: array

ROBOTFRAMEWORKROBOCOP: Define bash commands to run before running ROBOTFRAMEWORKROBOCOP

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:

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"
    }
]

ROBOTFRAMEWORK_ROBOCOP: Custom config file path

Type: string

ROBOTFRAMEWORK_ROBOCOP: Path where to find linter configuration file

ROBOTFRAMEWORK_ROBOCOP: Timeout in seconds

Type: integer

ROBOTFRAMEWORKROBOCOP: Maximum duration in seconds of the ROBOTFRAMEWORKROBOCOP 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

ROBOTFRAMEWORK_ROBOCOP: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling ROBOTFRAMEWORK_ROBOCOP and its pre/post commands

No Additional Items

Each item of this array must be:

Excluding regex filter for RST descriptor

Type: string or array of string

RST: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for RST descriptor

Type: string or array of string

RST: Custom regex including filter: only files matching this regex will be linted

Post commands for RST descriptor

Type: array

RST: 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:

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 RST descriptor

Type: array

RST: 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:

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"
    }
]

RST_RSTCHECK: Custom arguments

Type: array of string or string

RST_RSTCHECK: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

RST_RSTCHECK: CLI Executable

Type: array of string Default: [["rstcheck"]]

RST_RSTCHECK: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

RST_RSTCHECK: CLI lint mode

Type: enum (of string) Default: "list_of_files"

RST_RSTCHECK: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

RST_RSTCHECK: Custom remove arguments

Type: array of string or string

RST_RSTCHECK: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

RST_RSTCHECK: Custom config file name

Type: string Default: ".rstcheck.cfg"

RST_RSTCHECK: User custom config file name if different from default

RST_RSTCHECK: Disable errors

Type: boolean Default: false

RSTRSTCHECK: If true, RSTRSTCHECK doesn't make MegaLinter fail even if errors are found

RST_RSTCHECK: Maximum number of errors allowed

Type: number Default: 0

RSTRSTCHECK: If the number of errors found is less than this value, RSTRSTCHECK doesn't make MegaLinter fail

RST_RSTCHECK: Matching files extensions

Type: array of string Default: [".rst"]

RST_RSTCHECK: 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"

RST_RSTCHECK: Matching file name regexes

Type: array of string Default: []

RST_RSTCHECK: 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"

RST_RSTCHECK: Excluding Regex

Type: string or array of string

RSTRSTCHECK: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with RSTRSTCHECKCLILINT_MODE = project

RST_RSTCHECK: Including Regex

Type: string or array of string

RSTRSTCHECK: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with RSTRSTCHECKCLILINT_MODE = project

RST_RSTCHECK: Forward excluded directories in project lint mode

Type: boolean Default: true

RST_RSTCHECK: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

RST_RSTCHECK: Post-run commands

Type: array

RSTRSTCHECK: Define bash commands to run after running RSTRSTCHECK

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:

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"
    }
]

RST_RSTCHECK: Pre-run commands

Type: array

RSTRSTCHECK: Define bash commands to run before running RSTRSTCHECK

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:

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"
    }
]

RST_RSTCHECK: Custom config file path

Type: string

RST_RSTCHECK: Path where to find linter configuration file

RST_RSTCHECK: Timeout in seconds

Type: integer

RSTRSTCHECK: Maximum duration in seconds of the RSTRSTCHECK 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

RST_RSTCHECK: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling RST_RSTCHECK and its pre/post commands

No Additional Items

Each item of this array must be:

RST_RSTFMT: Custom arguments

Type: array of string or string

RST_RSTFMT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

RST_RSTFMT: CLI Executable

Type: array of string Default: [["rstfmt"]]

RST_RSTFMT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

RST_RSTFMT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

RST_RSTFMT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

RST_RSTFMT: Custom remove arguments

Type: array of string or string

RST_RSTFMT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

RST_RSTFMT: Disable errors

Type: boolean Default: false

RSTRSTFMT: If true, RSTRSTFMT doesn't make MegaLinter fail even if errors are found

RST_RSTFMT: Maximum number of errors allowed

Type: number Default: 0

RSTRSTFMT: If the number of errors found is less than this value, RSTRSTFMT doesn't make MegaLinter fail

RST_RSTFMT: Matching files extensions

Type: array of string Default: [".rst"]

RST_RSTFMT: 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"

RST_RSTFMT: Matching file name regexes

Type: array of string Default: []

RST_RSTFMT: 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"

RST_RSTFMT: Excluding Regex

Type: string or array of string

RSTRSTFMT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with RSTRSTFMTCLILINT_MODE = project

RST_RSTFMT: Including Regex

Type: string or array of string

RSTRSTFMT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with RSTRSTFMTCLILINT_MODE = project

RST_RSTFMT: Forward excluded directories in project lint mode

Type: boolean Default: true

RST_RSTFMT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

RST_RSTFMT: Post-run commands

Type: array

RSTRSTFMT: Define bash commands to run after running RSTRSTFMT

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:

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"
    }
]

RST_RSTFMT: Pre-run commands

Type: array

RSTRSTFMT: Define bash commands to run before running RSTRSTFMT

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:

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"
    }
]

RST_RSTFMT: Timeout in seconds

Type: integer

RSTRSTFMT: Maximum duration in seconds of the RSTRSTFMT 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

RST_RSTFMT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling RST_RSTFMT and its pre/post commands

No Additional Items

Each item of this array must be:

RST_RST_LINT: Custom arguments

Type: array of string or string

RSTRSTLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

RST_RST_LINT: CLI Executable

Type: array of string Default: [["rst-lint"]]

RSTRSTLINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

RST_RST_LINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

RSTRSTLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

RST_RST_LINT: Custom remove arguments

Type: array of string or string

RSTRSTLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

RST_RST_LINT: Disable errors

Type: boolean Default: false

RSTRSTLINT: If true, RSTRSTLINT doesn't make MegaLinter fail even if errors are found

RST_RST_LINT: Maximum number of errors allowed

Type: number Default: 0

RSTRSTLINT: If the number of errors found is less than this value, RSTRSTLINT doesn't make MegaLinter fail

RST_RST_LINT: Matching files extensions

Type: array of string Default: [".rst"]

RSTRSTLINT: 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"

RST_RST_LINT: Matching file name regexes

Type: array of string Default: []

RSTRSTLINT: 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"

RST_RST_LINT: Excluding Regex

Type: string or array of string

RSTRSTLINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with RSTRSTLINTCLILINT_MODE = project

RST_RST_LINT: Including Regex

Type: string or array of string

RSTRSTLINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with RSTRSTLINTCLILINT_MODE = project

RST_RST_LINT: Forward excluded directories in project lint mode

Type: boolean Default: true

RSTRSTLINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

RST_RST_LINT: Post-run commands

Type: array

RSTRSTLINT: Define bash commands to run after running RSTRSTLINT

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:

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"
    }
]

RST_RST_LINT: Pre-run commands

Type: array

RSTRSTLINT: Define bash commands to run before running RSTRSTLINT

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:

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"
    }
]

RST_RST_LINT: Timeout in seconds

Type: integer

RSTRSTLINT: Maximum duration in seconds of the RSTRSTLINT 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

RST_RST_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling RSTRSTLINT and its pre/post commands

No Additional Items

Each item of this array must be:

Excluding regex filter for RUBY descriptor

Type: string or array of string

RUBY: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for RUBY descriptor

Type: string or array of string

RUBY: Custom regex including filter: only files matching this regex will be linted

Post commands for RUBY descriptor

Type: array

RUBY: 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:

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 RUBY descriptor

Type: array

RUBY: 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:

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"
    }
]

RUBY_RUBOCOP: Custom arguments

Type: array of string or string

RUBY_RUBOCOP: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

RUBY_RUBOCOP: CLI Executable

Type: array of string Default: [["rubocop"]]

RUBY_RUBOCOP: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

RUBY_RUBOCOP: CLI lint mode

Type: enum (of string) Default: "list_of_files"

RUBY_RUBOCOP: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

RUBY_RUBOCOP: Custom remove arguments

Type: array of string or string

RUBY_RUBOCOP: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

RUBY_RUBOCOP: Custom config file name

Type: string Default: ".ruby-lint.yml"

RUBY_RUBOCOP: User custom config file name if different from default

RUBY_RUBOCOP: Disable errors

Type: boolean Default: false

RUBYRUBOCOP: If true, RUBYRUBOCOP doesn't make MegaLinter fail even if errors are found

RUBY_RUBOCOP: Maximum number of errors allowed

Type: number Default: 0

RUBYRUBOCOP: If the number of errors found is less than this value, RUBYRUBOCOP doesn't make MegaLinter fail

RUBY_RUBOCOP: Matching files extensions

Type: array of string Default: [".rb"]

RUBY_RUBOCOP: 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"

RUBY_RUBOCOP: Matching file name regexes

Type: array of string Default: []

RUBY_RUBOCOP: 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"

RUBY_RUBOCOP: Excluding Regex

Type: string or array of string

RUBYRUBOCOP: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with RUBYRUBOCOPCLILINT_MODE = project

RUBY_RUBOCOP: Including Regex

Type: string or array of string

RUBYRUBOCOP: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with RUBYRUBOCOPCLILINT_MODE = project

RUBY_RUBOCOP: Forward excluded directories in project lint mode

Type: boolean Default: true

RUBY_RUBOCOP: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

RUBY_RUBOCOP: Post-run commands

Type: array

RUBYRUBOCOP: Define bash commands to run after running RUBYRUBOCOP

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:

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"
    }
]

RUBY_RUBOCOP: Pre-run commands

Type: array

RUBYRUBOCOP: Define bash commands to run before running RUBYRUBOCOP

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:

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"
    }
]

RUBY_RUBOCOP: Custom config file path

Type: string

RUBY_RUBOCOP: Path where to find linter configuration file

RUBY_RUBOCOP: Timeout in seconds

Type: integer

RUBYRUBOCOP: Maximum duration in seconds of the RUBYRUBOCOP 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

RUBY_RUBOCOP: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling RUBY_RUBOCOP and its pre/post commands

No Additional Items

Each item of this array must be:

RUST_CLIPPY: Custom arguments

Type: array of string or string

RUST_CLIPPY: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

RUST_CLIPPY: CLI Executable

Type: array of string Default: [["cargo-clippy"]]

RUST_CLIPPY: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

RUST_CLIPPY: CLI lint mode

Type: enum (of string) Default: "project"

RUST_CLIPPY: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "project"

RUST_CLIPPY: Custom remove arguments

Type: array of string or string

RUST_CLIPPY: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

RUST_CLIPPY: Custom config file name

Type: string Default: ".clippy.toml"

RUST_CLIPPY: User custom config file name if different from default

RUST_CLIPPY: Disable errors

Type: boolean Default: false

RUSTCLIPPY: If true, RUSTCLIPPY doesn't make MegaLinter fail even if errors are found

RUST_CLIPPY: Maximum number of errors allowed

Type: number Default: 0

RUSTCLIPPY: If the number of errors found is less than this value, RUSTCLIPPY doesn't make MegaLinter fail

RUST_CLIPPY: Matching files extensions

Type: array of string Default: [".rs"]

RUST_CLIPPY: 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"

RUST_CLIPPY: Matching file name regexes

Type: array of string Default: []

RUST_CLIPPY: 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"

RUST_CLIPPY: Excluding Regex

Type: string or array of string

RUSTCLIPPY: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with RUSTCLIPPYCLILINT_MODE = project

RUST_CLIPPY: Including Regex

Type: string or array of string

RUSTCLIPPY: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with RUSTCLIPPYCLILINT_MODE = project

RUST_CLIPPY: Forward excluded directories in project lint mode

Type: boolean Default: true

RUST_CLIPPY: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

RUST_CLIPPY: Post-run commands

Type: array

RUSTCLIPPY: Define bash commands to run after running RUSTCLIPPY

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:

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"
    }
]

RUST_CLIPPY: Pre-run commands

Type: array

RUSTCLIPPY: Define bash commands to run before running RUSTCLIPPY

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:

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"
    }
]

RUST_CLIPPY: Custom config file path

Type: string

RUST_CLIPPY: Path where to find linter configuration file

RUST_CLIPPY: Timeout in seconds

Type: integer

RUSTCLIPPY: Maximum duration in seconds of the RUSTCLIPPY 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

RUST_CLIPPY: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling RUST_CLIPPY and its pre/post commands

No Additional Items

Each item of this array must be:

Excluding regex filter for RUST descriptor

Type: string or array of string

RUST: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for RUST descriptor

Type: string or array of string

RUST: Custom regex including filter: only files matching this regex will be linted

Post commands for RUST descriptor

Type: array

RUST: 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:

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 RUST descriptor

Type: array

RUST: 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:

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 R descriptor

Type: string or array of string

R: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for R descriptor

Type: string or array of string

R: Custom regex including filter: only files matching this regex will be linted

R_LINTR: Custom arguments

Type: array of string or string

R_LINTR: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

R_LINTR: CLI Executable

Type: array of string Default: [["lintr"]]

R_LINTR: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

R_LINTR: CLI lint mode

Type: enum (of string) Default: "file"

R_LINTR: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"

R_LINTR: Custom remove arguments

Type: array of string or string

R_LINTR: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

R_LINTR: Custom config file name

Type: string Default: ".lintr"

R_LINTR: User custom config file name if different from default

R_LINTR: Disable errors

Type: boolean Default: false

RLINTR: If true, RLINTR doesn't make MegaLinter fail even if errors are found

R_LINTR: Maximum number of errors allowed

Type: number Default: 0

RLINTR: If the number of errors found is less than this value, RLINTR doesn't make MegaLinter fail

R_LINTR: Matching files extensions

Type: array of string Default: [".r", ".R", ".Rmd", ".RMD"]

R_LINTR: 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"

R_LINTR: Matching file name regexes

Type: array of string Default: []

R_LINTR: 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"

R_LINTR: Excluding Regex

Type: string or array of string

R_LINTR: Including Regex

Type: string or array of string

R_LINTR: Post-run commands

Type: array

RLINTR: Define bash commands to run after running RLINTR

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:

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"
    }
]

R_LINTR: Pre-run commands

Type: array

RLINTR: Define bash commands to run before running RLINTR

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:

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"
    }
]

R_LINTR: Custom config file path

Type: string

R_LINTR: Path where to find linter configuration file

R_LINTR: Timeout in seconds

Type: integer

RLINTR: Maximum duration in seconds of the RLINTR 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

R_LINTR: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling R_LINTR and its pre/post commands

No Additional Items

Each item of this array must be:

Post commands for R descriptor

Type: array

R: 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:

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 R descriptor

Type: array

R: 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:

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"
    }
]

SALESFORCE_CODE_ANALYZER_APEX: Custom arguments

Type: array of string or string

SALESFORCECODEANALYZER_APEX: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_APEX: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCECODEANALYZER_APEX: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_APEX: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCECODEANALYZER_APEX: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "project"

SALESFORCE_CODE_ANALYZER_APEX: Custom remove arguments

Type: array of string or string

SALESFORCECODEANALYZER_APEX: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_APEX: Custom config file name

Type: string Default: "code-analyzer.yml"

SALESFORCECODEANALYZER_APEX: User custom config file name if different from default

SALESFORCE_CODE_ANALYZER_APEX: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

SALESFORCE_CODE_ANALYZER_APEX: Disable errors

Type: boolean Default: false

SALESFORCECODEANALYZERAPEX: If true, SALESFORCECODEANALYZERAPEX doesn't make MegaLinter fail even if errors are found

SALESFORCE_CODE_ANALYZER_APEX: Maximum number of errors allowed

Type: number Default: 0

SALESFORCECODEANALYZERAPEX: If the number of errors found is less than this value, SALESFORCECODEANALYZERAPEX doesn't make MegaLinter fail

SALESFORCE_CODE_ANALYZER_APEX: Excluding Regex

Type: string or array of string

SALESFORCECODEANALYZERAPEX: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SALESFORCECODEANALYZERAPEXCLILINT_MODE = project

SALESFORCE_CODE_ANALYZER_APEX: Including Regex

Type: string or array of string

SALESFORCECODEANALYZERAPEX: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SALESFORCECODEANALYZERAPEXCLILINT_MODE = project

SALESFORCE_CODE_ANALYZER_APEX: Forward excluded directories in project lint mode

Type: boolean Default: true

SALESFORCECODEANALYZER_APEX: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

SALESFORCE_CODE_ANALYZER_APEX: Post-run commands

Type: array

SALESFORCECODEANALYZERAPEX: Define bash commands to run after running SALESFORCECODEANALYZERAPEX

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:

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"
    }
]

SALESFORCE_CODE_ANALYZER_APEX: Pre-run commands

Type: array

SALESFORCECODEANALYZERAPEX: Define bash commands to run before running SALESFORCECODEANALYZERAPEX

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:

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"
    }
]

SALESFORCE_CODE_ANALYZER_APEX: Custom config file path

Type: string

SALESFORCECODEANALYZER_APEX: Path where to find linter configuration file

SALESFORCE_CODE_ANALYZER_APEX: Timeout in seconds

Type: integer

SALESFORCECODEANALYZERAPEX: Maximum duration in seconds of the SALESFORCECODEANALYZERAPEX 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

SALESFORCE_CODE_ANALYZER_APEX: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCECODEANALYZER_APEX and its pre/post commands

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_AURA: Custom arguments

Type: array of string or string

SALESFORCECODEANALYZER_AURA: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_AURA: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCECODEANALYZER_AURA: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_AURA: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCECODEANALYZER_AURA: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "project"

SALESFORCE_CODE_ANALYZER_AURA: Custom remove arguments

Type: array of string or string

SALESFORCECODEANALYZER_AURA: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_AURA: Custom config file name

Type: string Default: "code-analyzer.yml"

SALESFORCECODEANALYZER_AURA: User custom config file name if different from default

SALESFORCE_CODE_ANALYZER_AURA: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

SALESFORCE_CODE_ANALYZER_AURA: Disable errors

Type: boolean Default: false

SALESFORCECODEANALYZERAURA: If true, SALESFORCECODEANALYZERAURA doesn't make MegaLinter fail even if errors are found

SALESFORCE_CODE_ANALYZER_AURA: Maximum number of errors allowed

Type: number Default: 0

SALESFORCECODEANALYZERAURA: If the number of errors found is less than this value, SALESFORCECODEANALYZERAURA doesn't make MegaLinter fail

SALESFORCE_CODE_ANALYZER_AURA: Excluding Regex

Type: string or array of string

SALESFORCECODEANALYZERAURA: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SALESFORCECODEANALYZERAURACLILINT_MODE = project

SALESFORCE_CODE_ANALYZER_AURA: Including Regex

Type: string or array of string

SALESFORCECODEANALYZERAURA: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SALESFORCECODEANALYZERAURACLILINT_MODE = project

SALESFORCE_CODE_ANALYZER_AURA: Forward excluded directories in project lint mode

Type: boolean Default: true

SALESFORCECODEANALYZER_AURA: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

SALESFORCE_CODE_ANALYZER_AURA: Post-run commands

Type: array

SALESFORCECODEANALYZERAURA: Define bash commands to run after running SALESFORCECODEANALYZERAURA

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:

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"
    }
]

SALESFORCE_CODE_ANALYZER_AURA: Pre-run commands

Type: array

SALESFORCECODEANALYZERAURA: Define bash commands to run before running SALESFORCECODEANALYZERAURA

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:

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"
    }
]

SALESFORCE_CODE_ANALYZER_AURA: Custom config file path

Type: string

SALESFORCECODEANALYZER_AURA: Path where to find linter configuration file

SALESFORCE_CODE_ANALYZER_AURA: Timeout in seconds

Type: integer

SALESFORCECODEANALYZERAURA: Maximum duration in seconds of the SALESFORCECODEANALYZERAURA 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

SALESFORCE_CODE_ANALYZER_AURA: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCECODEANALYZER_AURA and its pre/post commands

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_FLOW: Custom arguments

Type: array of string or string

SALESFORCECODEANALYZER_FLOW: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_FLOW: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCECODEANALYZER_FLOW: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_FLOW: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCECODEANALYZER_FLOW: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"

SALESFORCE_CODE_ANALYZER_FLOW: Custom remove arguments

Type: array of string or string

SALESFORCECODEANALYZER_FLOW: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_FLOW: Custom config file name

Type: string Default: "code-analyzer-flow.yml"

SALESFORCECODEANALYZER_FLOW: User custom config file name if different from default

SALESFORCE_CODE_ANALYZER_FLOW: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

SALESFORCE_CODE_ANALYZER_FLOW: Disable errors

Type: boolean Default: false

SALESFORCECODEANALYZERFLOW: If true, SALESFORCECODEANALYZERFLOW doesn't make MegaLinter fail even if errors are found

SALESFORCE_CODE_ANALYZER_FLOW: Maximum number of errors allowed

Type: number Default: 0

SALESFORCECODEANALYZERFLOW: If the number of errors found is less than this value, SALESFORCECODEANALYZERFLOW doesn't make MegaLinter fail

SALESFORCE_CODE_ANALYZER_FLOW: Excluding Regex

Type: string or array of string

SALESFORCE_CODE_ANALYZER_FLOW: Including Regex

Type: string or array of string

SALESFORCE_CODE_ANALYZER_FLOW: Post-run commands

Type: array

SALESFORCECODEANALYZERFLOW: Define bash commands to run after running SALESFORCECODEANALYZERFLOW

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:

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"
    }
]

SALESFORCE_CODE_ANALYZER_FLOW: Pre-run commands

Type: array

SALESFORCECODEANALYZERFLOW: Define bash commands to run before running SALESFORCECODEANALYZERFLOW

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:

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"
    }
]

SALESFORCE_CODE_ANALYZER_FLOW: Custom config file path

Type: string

SALESFORCECODEANALYZER_FLOW: Path where to find linter configuration file

SALESFORCE_CODE_ANALYZER_FLOW: Timeout in seconds

Type: integer

SALESFORCECODEANALYZERFLOW: Maximum duration in seconds of the SALESFORCECODEANALYZERFLOW 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

SALESFORCE_CODE_ANALYZER_FLOW: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCECODEANALYZER_FLOW and its pre/post commands

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_LWC: Custom arguments

Type: array of string or string

SALESFORCECODEANALYZER_LWC: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_LWC: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCECODEANALYZER_LWC: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_LWC: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCECODEANALYZER_LWC: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "project"

SALESFORCE_CODE_ANALYZER_LWC: Custom remove arguments

Type: array of string or string

SALESFORCECODEANALYZER_LWC: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SALESFORCE_CODE_ANALYZER_LWC: Custom config file name

Type: string Default: "code-analyzer.yml"

SALESFORCECODEANALYZER_LWC: User custom config file name if different from default

SALESFORCE_CODE_ANALYZER_LWC: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

SALESFORCE_CODE_ANALYZER_LWC: Disable errors

Type: boolean Default: false

SALESFORCECODEANALYZERLWC: If true, SALESFORCECODEANALYZERLWC doesn't make MegaLinter fail even if errors are found

SALESFORCE_CODE_ANALYZER_LWC: Maximum number of errors allowed

Type: number Default: 0

SALESFORCECODEANALYZERLWC: If the number of errors found is less than this value, SALESFORCECODEANALYZERLWC doesn't make MegaLinter fail

SALESFORCE_CODE_ANALYZER_LWC: Excluding Regex

Type: string or array of string

SALESFORCECODEANALYZERLWC: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SALESFORCECODEANALYZERLWCCLILINT_MODE = project

SALESFORCE_CODE_ANALYZER_LWC: Including Regex

Type: string or array of string

SALESFORCECODEANALYZERLWC: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SALESFORCECODEANALYZERLWCCLILINT_MODE = project

SALESFORCE_CODE_ANALYZER_LWC: Forward excluded directories in project lint mode

Type: boolean Default: true

SALESFORCECODEANALYZER_LWC: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

SALESFORCE_CODE_ANALYZER_LWC: Post-run commands

Type: array

SALESFORCECODEANALYZERLWC: Define bash commands to run after running SALESFORCECODEANALYZERLWC

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:

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"
    }
]

SALESFORCE_CODE_ANALYZER_LWC: Pre-run commands

Type: array

SALESFORCECODEANALYZERLWC: Define bash commands to run before running SALESFORCECODEANALYZERLWC

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:

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"
    }
]

SALESFORCE_CODE_ANALYZER_LWC: Custom config file path

Type: string

SALESFORCECODEANALYZER_LWC: Path where to find linter configuration file

SALESFORCE_CODE_ANALYZER_LWC: Timeout in seconds

Type: integer

SALESFORCECODEANALYZERLWC: Maximum duration in seconds of the SALESFORCECODEANALYZERLWC 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

SALESFORCE_CODE_ANALYZER_LWC: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCECODEANALYZER_LWC and its pre/post commands

No Additional Items

Each item of this array must be:

SALESFORCE_DIRECTORY: Directory containing SALESFORCE files

Type: string Default: "force-app"

Excluding regex filter for SALESFORCE descriptor

Type: string or array of string

SALESFORCE: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for SALESFORCE descriptor

Type: string or array of string

SALESFORCE: Custom regex including filter: only files matching this regex will be linted

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: Custom arguments

Type: array of string or string

SALESFORCELIGHTNINGFLOW_SCANNER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCELIGHTNINGFLOW_SCANNER: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCELIGHTNINGFLOW_SCANNER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "project"

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: Custom remove arguments

Type: array of string or string

SALESFORCELIGHTNINGFLOW_SCANNER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: Custom config file name

Type: string Default: ".flow-scanner.json"

SALESFORCELIGHTNINGFLOW_SCANNER: User custom config file name if different from default

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: Disable errors

Type: boolean Default: false

SALESFORCELIGHTNINGFLOWSCANNER: If true, SALESFORCELIGHTNINGFLOWSCANNER doesn't make MegaLinter fail even if errors are found

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: Maximum number of errors allowed

Type: number Default: 0

SALESFORCELIGHTNINGFLOWSCANNER: If the number of errors found is less than this value, SALESFORCELIGHTNINGFLOWSCANNER doesn't make MegaLinter fail

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: Excluding Regex

Type: string or array of string

SALESFORCELIGHTNINGFLOWSCANNER: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SALESFORCELIGHTNINGFLOWSCANNERCLILINT_MODE = project

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: Including Regex

Type: string or array of string

SALESFORCELIGHTNINGFLOWSCANNER: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SALESFORCELIGHTNINGFLOWSCANNERCLILINT_MODE = project

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: Post-run commands

Type: array

SALESFORCELIGHTNINGFLOWSCANNER: Define bash commands to run after running SALESFORCELIGHTNINGFLOWSCANNER

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:

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) SALESFORCE_LIGHTNING_FLOW_SCANNER: Pre-run commands

Type: array

SALESFORCELIGHTNINGFLOWSCANNER: Define bash commands to run before running SALESFORCELIGHTNINGFLOWSCANNER

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:

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) SALESFORCE_LIGHTNING_FLOW_SCANNER: Custom config file path

Type: string

SALESFORCELIGHTNINGFLOW_SCANNER: Path where to find linter configuration file

(deprecated) SALESFORCE_LIGHTNING_FLOW_SCANNER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCELIGHTNINGFLOW_SCANNER and its pre/post commands

No Additional Items

Each item of this array must be:

Post commands for SALESFORCE descriptor

Type: array

SALESFORCE: 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:

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 SALESFORCE descriptor

Type: array

SALESFORCE: 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:

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) SALESFORCE_SFDX_SCANNER_APEX: Custom arguments

Type: array of string or string

SALESFORCESFDXSCANNER_APEX: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCESFDXSCANNER_APEX: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCESFDXSCANNER_APEX: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "project"

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Custom remove arguments

Type: array of string or string

SALESFORCESFDXSCANNER_APEX: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Custom config file name

Type: string Default: "apex-pmd-ruleset.xml"

SALESFORCESFDXSCANNER_APEX: User custom config file name if different from default

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Disable errors

Type: boolean Default: false

SALESFORCESFDXSCANNERAPEX: If true, SALESFORCESFDXSCANNERAPEX doesn't make MegaLinter fail even if errors are found

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Maximum number of errors allowed

Type: number Default: 0

SALESFORCESFDXSCANNERAPEX: If the number of errors found is less than this value, SALESFORCESFDXSCANNERAPEX doesn't make MegaLinter fail

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Excluding Regex

Type: string or array of string

SALESFORCESFDXSCANNERAPEX: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SALESFORCESFDXSCANNERAPEXCLILINT_MODE = project

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Including Regex

Type: string or array of string

SALESFORCESFDXSCANNERAPEX: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SALESFORCESFDXSCANNERAPEXCLILINT_MODE = project

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Post-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERAPEX: Define bash commands to run after running SALESFORCESFDXSCANNERAPEX

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:

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) SALESFORCE_SFDX_SCANNER_APEX: Pre-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERAPEX: Define bash commands to run before running SALESFORCESFDXSCANNERAPEX

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:

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) SALESFORCE_SFDX_SCANNER_APEX: Custom config file path

Type: string

SALESFORCESFDXSCANNER_APEX: Path where to find linter configuration file

(deprecated) SALESFORCE_SFDX_SCANNER_APEX: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCESFDXSCANNER_APEX and its pre/post commands

No Additional Items

Each item of this array must be:

SALESFORCE_SFDX_SCANNER: Custom arguments

Type: array of string or string

SALESFORCESFDXSCANNER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Custom arguments

Type: array of string or string

SALESFORCESFDXSCANNER_AURA: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCESFDXSCANNER_AURA: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCESFDXSCANNER_AURA: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "project"

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Custom remove arguments

Type: array of string or string

SALESFORCESFDXSCANNER_AURA: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Custom config file name

Type: string Default: "--eslintconfig"

SALESFORCESFDXSCANNER_AURA: User custom config file name if different from default

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Disable errors

Type: boolean Default: false

SALESFORCESFDXSCANNERAURA: If true, SALESFORCESFDXSCANNERAURA doesn't make MegaLinter fail even if errors are found

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Maximum number of errors allowed

Type: number Default: 0

SALESFORCESFDXSCANNERAURA: If the number of errors found is less than this value, SALESFORCESFDXSCANNERAURA doesn't make MegaLinter fail

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Excluding Regex

Type: string or array of string

SALESFORCESFDXSCANNERAURA: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SALESFORCESFDXSCANNERAURACLILINT_MODE = project

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Including Regex

Type: string or array of string

SALESFORCESFDXSCANNERAURA: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SALESFORCESFDXSCANNERAURACLILINT_MODE = project

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Post-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERAURA: Define bash commands to run after running SALESFORCESFDXSCANNERAURA

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:

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) SALESFORCE_SFDX_SCANNER_AURA: Pre-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERAURA: Define bash commands to run before running SALESFORCESFDXSCANNERAURA

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:

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) SALESFORCE_SFDX_SCANNER_AURA: Custom config file path

Type: string

SALESFORCESFDXSCANNER_AURA: Path where to find linter configuration file

(deprecated) SALESFORCE_SFDX_SCANNER_AURA: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCESFDXSCANNER_AURA and its pre/post commands

No Additional Items

Each item of this array must be:

SALESFORCE_SFDX_SCANNER: Directory containing SALESFORCE files

Type: string Default: "force-app"

SALESFORCE_SFDX_SCANNER: Linter does not make MegaLinter fail even if errors are found

Type: boolean Default: false

SALESFORCE_SFDX_SCANNER: Maximum number of errors allowed

Type: number Default: 0

SALESFORCE_SFDX_SCANNER: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

SALESFORCE_SFDX_SCANNER: Override descriptor/linter matching file name regex

Type: array of string
No Additional Items

Each item of this array must be:


Examples:

"Dockerfile(-.+)?"
"Jenkinsfile"

SALESFORCE_SFDX_SCANNER: Excluding Regex

Type: string

SALESFORCE_SFDX_SCANNER: Including Regex

Type: string

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Custom arguments

Type: array of string or string

SALESFORCESFDXSCANNER_LWC: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: CLI Executable

Type: array of string Default: [["sf"]]

SALESFORCESFDXSCANNER_LWC: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: CLI lint mode

Type: enum (of string) Default: "project"

SALESFORCESFDXSCANNER_LWC: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "project"

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Custom remove arguments

Type: array of string or string

SALESFORCESFDXSCANNER_LWC: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Custom config file name

Type: string Default: "--eslintconfig"

SALESFORCESFDXSCANNER_LWC: User custom config file name if different from default

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Directory containing SALESFORCE files

Type: string Default: "force-app"

Directory that must be found to activate linter. Use value "any" to always activate

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Disable errors

Type: boolean Default: false

SALESFORCESFDXSCANNERLWC: If true, SALESFORCESFDXSCANNERLWC doesn't make MegaLinter fail even if errors are found

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Maximum number of errors allowed

Type: number Default: 0

SALESFORCESFDXSCANNERLWC: If the number of errors found is less than this value, SALESFORCESFDXSCANNERLWC doesn't make MegaLinter fail

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Excluding Regex

Type: string or array of string

SALESFORCESFDXSCANNERLWC: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SALESFORCESFDXSCANNERLWCCLILINT_MODE = project

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Including Regex

Type: string or array of string

SALESFORCESFDXSCANNERLWC: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SALESFORCESFDXSCANNERLWCCLILINT_MODE = project

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Post-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERLWC: Define bash commands to run after running SALESFORCESFDXSCANNERLWC

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:

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) SALESFORCE_SFDX_SCANNER_LWC: Pre-run commands

Type: array

(deprecated) SALESFORCESFDXSCANNERLWC: Define bash commands to run before running SALESFORCESFDXSCANNERLWC

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:

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) SALESFORCE_SFDX_SCANNER_LWC: Custom config file path

Type: string

SALESFORCESFDXSCANNER_LWC: Path where to find linter configuration file

(deprecated) SALESFORCE_SFDX_SCANNER_LWC: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SALESFORCESFDXSCANNER_LWC and its pre/post commands

No Additional Items

Each item of this array must be:

Activate SARIF reporter

Type: boolean Default: false

Generate SARIF reports that can be used to display issues directly in GitHub UI

SARIF report file name

Type: string Default: "mega-linter-report.sarif"

Override SARIF output file name

SARIF enabled linters

Type: array

If SARIFREPORTERLINTERS is set, only the linters in the list will output SARIF

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_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_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_PRETTIER"
  • "JAVASCRIPT_STANDARD"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_JSONLINT"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSON_PRETTIER"
  • "JSON_V8R"
  • "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_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"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_PRETTIER"
  • "TYPESCRIPT_STANDARD"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_V8R"
  • "YAML_YAMLLINT"

Example:

[
    "BASH_BASH_SHFMT",
    "JAVASCRIPT_STANDARD"
]

Excluding regex filter for SCALA descriptor

Type: string or array of string

SCALA: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for SCALA descriptor

Type: string or array of string

SCALA: Custom regex including filter: only files matching this regex will be linted

Post commands for SCALA descriptor

Type: array

SCALA: 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:

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 SCALA descriptor

Type: array

SCALA: 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:

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"
    }
]

SCALA_SCALAFIX: Custom arguments

Type: array of string or string

SCALA_SCALAFIX: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SCALA_SCALAFIX: CLI Executable

Type: array of string Default: [["scalafix"]]

SCALA_SCALAFIX: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SCALA_SCALAFIX: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SCALA_SCALAFIX: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

SCALA_SCALAFIX: Custom remove arguments

Type: array of string or string

SCALA_SCALAFIX: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SCALA_SCALAFIX: Custom config file name

Type: string Default: ".scalafix.conf"

SCALA_SCALAFIX: User custom config file name if different from default

SCALA_SCALAFIX: Disable errors

Type: boolean Default: false

SCALASCALAFIX: If true, SCALASCALAFIX doesn't make MegaLinter fail even if errors are found

SCALA_SCALAFIX: Maximum number of errors allowed

Type: number Default: 0

SCALASCALAFIX: If the number of errors found is less than this value, SCALASCALAFIX doesn't make MegaLinter fail

SCALA_SCALAFIX: Matching files extensions

Type: array of string Default: [".scala"]

SCALA_SCALAFIX: 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"

SCALA_SCALAFIX: Matching file name regexes

Type: array of string Default: []

SCALA_SCALAFIX: 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"

SCALA_SCALAFIX: Excluding Regex

Type: string or array of string

SCALASCALAFIX: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SCALASCALAFIXCLILINT_MODE = project

SCALA_SCALAFIX: Including Regex

Type: string or array of string

SCALASCALAFIX: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SCALASCALAFIXCLILINT_MODE = project

SCALA_SCALAFIX: Forward excluded directories in project lint mode

Type: boolean Default: true

SCALA_SCALAFIX: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

SCALA_SCALAFIX: Post-run commands

Type: array

SCALASCALAFIX: Define bash commands to run after running SCALASCALAFIX

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:

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"
    }
]

SCALA_SCALAFIX: Pre-run commands

Type: array

SCALASCALAFIX: Define bash commands to run before running SCALASCALAFIX

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:

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"
    }
]

SCALA_SCALAFIX: Custom config file path

Type: string

SCALA_SCALAFIX: Path where to find linter configuration file

SCALA_SCALAFIX: Timeout in seconds

Type: integer

SCALASCALAFIX: Maximum duration in seconds of the SCALASCALAFIX 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

SCALA_SCALAFIX: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SCALA_SCALAFIX and its pre/post commands

No Additional Items

Each item of this array must be:

Additional secured environment variables

Type: array of string Default: []

List of additional secured environment variables to hide when calling linters. Can contain string or regex patterns.

No Additional Items

Each item of this array must be:

Default secured environment variables

Type: array of string Default: ["PAT", "SYSTEM_ACCESSTOKEN", "(^|_)(USERNAME)($|_)", "(^|_)(PASSWORD|PASSWD|PASS|PWD)($|_)", "(^|_)(TOKEN|ID_TOKEN|ACCESS_TOKEN|REFRESH_TOKEN|BEARER)($|_)", "(^|_)(SECRET|SECRETS)($|_)", "(^|_)(API_KEY|APP_KEY|CLIENT_ID|CLIENT_SECRET|CLIENT_KEY|SECRET_KEY|ACCESS_KEY|ACCESS_KEY_ID|PRIVATE_KEY|SSH_KEY|SIGNING_KEY|ENCRYPTION_KEY|LICENSE_KEY)($|_)", "(^|_)(AUTH|AUTHORIZATION)($|_)", "(^|_)(CERT|CERTIFICATE|CA_BUNDLE|KUBECONFIG)($|_)", "(^|_)(CONNECTION_STRING|DATABASE_URL|DB_URL|DSN)($|_)", "(GOOGLE_APPLICATION_CREDENTIALS)", "(GCP_SERVICE_ACCOUNT.*)", "(SFDX_CLIENT_ID_.*)", "(SFDX_CLIENT_KEY_.*)", "(^|_)(SLACK|DISCORD|TEAMS|WEBHOOK)_URL($|_)"]

List of default secured environment variables that will be hidden when calling linters. Can contain string or regex patterns. This should generally not be overridden, use (additional) SECUREDENVVARIABLES instead to add more variables to the list.

No Additional Items

Each item of this array must be:

Security suggestions

Type: boolean Default: true

Provides security-related suggestions and MegaLinter release announcements in reports

Show elapsed time

Type: boolean Default: false

Displays elapsed time for each linter in reports

Show skipped Linters

Type: boolean Default: true

Displays all linters that mega-linter could run but didn't

List of CLI lint modes to skip

Type: array of enum (of string)

Comma-separated list of clilintmodes. To use if you want to skip linters with some CLI lint modes (ex: "file,project"). Available values: file,clilintmode,project

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

Excluding regex filter for SNAKEMAKE descriptor

Type: string or array of string

SNAKEMAKE: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for SNAKEMAKE descriptor

Type: string or array of string

SNAKEMAKE: Custom regex including filter: only files matching this regex will be linted

SNAKEMAKE_LINT: Custom arguments

Type: array of string or string

SNAKEMAKE_LINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SNAKEMAKE_LINT: CLI Executable

Type: array of string Default: [["snakemake"]]

SNAKEMAKE_LINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SNAKEMAKE_LINT: CLI lint mode

Type: enum (of string) Default: "file"

SNAKEMAKE_LINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"

SNAKEMAKE_LINT: Custom remove arguments

Type: array of string or string

SNAKEMAKE_LINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SNAKEMAKE_LINT: Disable errors

Type: boolean Default: false

SNAKEMAKELINT: If true, SNAKEMAKELINT doesn't make MegaLinter fail even if errors are found

SNAKEMAKE_LINT: Maximum number of errors allowed

Type: number Default: 0

SNAKEMAKELINT: If the number of errors found is less than this value, SNAKEMAKELINT doesn't make MegaLinter fail

SNAKEMAKE_LINT: Matching files extensions

Type: array of string Default: [".smk"]

SNAKEMAKE_LINT: 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"

SNAKEMAKE_LINT: Matching file name regexes

Type: array of string Default: ["Snakefile"]

SNAKEMAKE_LINT: 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"

SNAKEMAKE_LINT: Excluding Regex

Type: string or array of string

SNAKEMAKE_LINT: Including Regex

Type: string or array of string

SNAKEMAKE_LINT: Post-run commands

Type: array

SNAKEMAKELINT: Define bash commands to run after running SNAKEMAKELINT

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:

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"
    }
]

SNAKEMAKE_LINT: Pre-run commands

Type: array

SNAKEMAKELINT: Define bash commands to run before running SNAKEMAKELINT

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:

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"
    }
]

SNAKEMAKE_LINT: Timeout in seconds

Type: integer

SNAKEMAKELINT: Maximum duration in seconds of the SNAKEMAKELINT 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

SNAKEMAKE_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SNAKEMAKE_LINT and its pre/post commands

No Additional Items

Each item of this array must be:

Post commands for SNAKEMAKE descriptor

Type: array

SNAKEMAKE: 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:

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 SNAKEMAKE descriptor

Type: array

SNAKEMAKE: 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:

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"
    }
]

SNAKEMAKE_SNAKEFMT: Custom arguments

Type: array of string or string

SNAKEMAKE_SNAKEFMT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SNAKEMAKE_SNAKEFMT: CLI Executable

Type: array of string Default: [["snakefmt"]]

SNAKEMAKE_SNAKEFMT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SNAKEMAKE_SNAKEFMT: CLI lint mode

Type: enum (of string) Default: "file"

SNAKEMAKE_SNAKEFMT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"

SNAKEMAKE_SNAKEFMT: Custom remove arguments

Type: array of string or string

SNAKEMAKE_SNAKEFMT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SNAKEMAKE_SNAKEFMT: Custom config file name

Type: string Default: ".snakefmt.toml"

SNAKEMAKE_SNAKEFMT: User custom config file name if different from default

SNAKEMAKE_SNAKEFMT: Disable errors

Type: boolean Default: false

SNAKEMAKESNAKEFMT: If true, SNAKEMAKESNAKEFMT doesn't make MegaLinter fail even if errors are found

SNAKEMAKE_SNAKEFMT: Maximum number of errors allowed

Type: number Default: 0

SNAKEMAKESNAKEFMT: If the number of errors found is less than this value, SNAKEMAKESNAKEFMT doesn't make MegaLinter fail

SNAKEMAKE_SNAKEFMT: Matching files extensions

Type: array of string Default: [".smk"]

SNAKEMAKE_SNAKEFMT: 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"

SNAKEMAKE_SNAKEFMT: Matching file name regexes

Type: array of string Default: ["Snakefile"]

SNAKEMAKE_SNAKEFMT: 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"

SNAKEMAKE_SNAKEFMT: Excluding Regex

Type: string or array of string

SNAKEMAKE_SNAKEFMT: Including Regex

Type: string or array of string

SNAKEMAKE_SNAKEFMT: Post-run commands

Type: array

SNAKEMAKESNAKEFMT: Define bash commands to run after running SNAKEMAKESNAKEFMT

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:

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"
    }
]

SNAKEMAKE_SNAKEFMT: Pre-run commands

Type: array

SNAKEMAKESNAKEFMT: Define bash commands to run before running SNAKEMAKESNAKEFMT

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:

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"
    }
]

SNAKEMAKE_SNAKEFMT: Custom config file path

Type: string

SNAKEMAKE_SNAKEFMT: Path where to find linter configuration file

SNAKEMAKE_SNAKEFMT: Timeout in seconds

Type: integer

SNAKEMAKESNAKEFMT: Maximum duration in seconds of the SNAKEMAKESNAKEFMT 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

SNAKEMAKE_SNAKEFMT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SNAKEMAKE_SNAKEFMT and its pre/post commands

No Additional Items

Each item of this array must be:

SPELL_CODESPELL: Custom arguments

Type: array of string or string

SPELL_CODESPELL: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SPELL_CODESPELL: CLI Executable

Type: array of string Default: [["codespell"]]

SPELL_CODESPELL: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SPELL_CODESPELL: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SPELL_CODESPELL: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

SPELL_CODESPELL: Custom remove arguments

Type: array of string or string

SPELL_CODESPELL: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SPELL_CODESPELL: Custom config file name

Type: string Default: ".codespellrc"

SPELL_CODESPELL: User custom config file name if different from default

SPELL_CODESPELL: Disable errors

Type: boolean Default: false

SPELLCODESPELL: If true, SPELLCODESPELL doesn't make MegaLinter fail even if errors are found

SPELL_CODESPELL: Maximum number of errors allowed

Type: number Default: 0

SPELLCODESPELL: If the number of errors found is less than this value, SPELLCODESPELL doesn't make MegaLinter fail

SPELL_CODESPELL: Matching files extensions

Type: array of string Default: [".md", ".mdx", ".markdown", ".html", ".htm", ".rst", ".txt", ".json", ".jsonc", ".json5", ".yaml", ".yml"]

SPELL_CODESPELL: 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"

SPELL_CODESPELL: Matching file name regexes

Type: array of string Default: []

SPELL_CODESPELL: 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"

SPELL_CODESPELL: Excluding Regex

Type: string or array of string

SPELLCODESPELL: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SPELLCODESPELLCLILINT_MODE = project

SPELL_CODESPELL: Including Regex

Type: string or array of string

SPELLCODESPELL: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SPELLCODESPELLCLILINT_MODE = project

SPELL_CODESPELL: Forward excluded directories in project lint mode

Type: boolean Default: true

SPELL_CODESPELL: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

SPELL_CODESPELL: Post-run commands

Type: array

SPELLCODESPELL: Define bash commands to run after running SPELLCODESPELL

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:

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"
    }
]

SPELL_CODESPELL: Pre-run commands

Type: array

SPELLCODESPELL: Define bash commands to run before running SPELLCODESPELL

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:

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"
    }
]

SPELL_CODESPELL: Custom config file path

Type: string

SPELL_CODESPELL: Path where to find linter configuration file

SPELL_CODESPELL: Timeout in seconds

Type: integer

SPELLCODESPELL: Maximum duration in seconds of the SPELLCODESPELL 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

SPELL_CODESPELL: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SPELL_CODESPELL and its pre/post commands

No Additional Items

Each item of this array must be:

SPELL_CSPELL: Analyze file names

Type: boolean Default: false

If set to true, MegaLinter will also send file names to cspell for analysis.

SPELL_CSPELL: Custom arguments

Type: array of string or string

SPELL_CSPELL: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SPELL_CSPELL: CLI Executable

Type: array of string Default: [["cspell"]]

SPELL_CSPELL: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SPELL_CSPELL: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SPELL_CSPELL: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

SPELL_CSPELL: Custom remove arguments

Type: array of string or string

SPELL_CSPELL: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SPELL_CSPELL: Custom config file name

Type: string Default: ".cspell.json"

SPELL_CSPELL: User custom config file name if different from default

SPELL_CSPELL: Disable errors

Type: boolean Default: false

SPELLCSPELL: If true, SPELLCSPELL doesn't make MegaLinter fail even if errors are found

SPELL_CSPELL: Maximum number of errors allowed

Type: number Default: 0

SPELLCSPELL: If the number of errors found is less than this value, SPELLCSPELL doesn't make MegaLinter fail

SPELL_CSPELL: Matching files extensions

Type: array of string Default: []

SPELL_CSPELL: 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"

SPELL_CSPELL: Matching file name regexes

Type: array of string Default: []

SPELL_CSPELL: 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"

SPELL_CSPELL: Excluding Regex

Type: string or array of string

SPELLCSPELL: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SPELLCSPELLCLILINT_MODE = project

SPELL_CSPELL: Including Regex

Type: string or array of string

SPELLCSPELL: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SPELLCSPELLCLILINT_MODE = project

SPELL_CSPELL: Forward excluded directories in project lint mode

Type: boolean Default: true

SPELL_CSPELL: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

SPELL_CSPELL: Post-run commands

Type: array

SPELLCSPELL: Define bash commands to run after running SPELLCSPELL

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:

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"
    }
]

SPELL_CSPELL: Pre-run commands

Type: array

SPELLCSPELL: Define bash commands to run before running SPELLCSPELL

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:

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"
    }
]

SPELL_CSPELL: Custom config file path

Type: string

SPELL_CSPELL: Path where to find linter configuration file

SPELL_CSPELL: Timeout in seconds

Type: integer

SPELLCSPELL: Maximum duration in seconds of the SPELLCSPELL 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

SPELL_CSPELL: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SPELL_CSPELL and its pre/post commands

No Additional Items

Each item of this array must be:

Excluding regex filter for SPELL descriptor

Type: string or array of string

SPELL: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for SPELL descriptor

Type: string or array of string

SPELL: Custom regex including filter: only files matching this regex will be linted

SPELL_LYCHEE: Custom arguments

Type: array of string or string

SPELL_LYCHEE: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SPELL_LYCHEE: CLI Executable

Type: array of string Default: [["lychee"]]

SPELL_LYCHEE: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SPELL_LYCHEE: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SPELL_LYCHEE: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

SPELL_LYCHEE: Custom remove arguments

Type: array of string or string

SPELL_LYCHEE: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SPELL_LYCHEE: Custom config file name

Type: string Default: "lychee.toml"

SPELL_LYCHEE: User custom config file name if different from default

SPELL_LYCHEE: Disable errors

Type: boolean Default: false

SPELLLYCHEE: If true, SPELLLYCHEE doesn't make MegaLinter fail even if errors are found

SPELL_LYCHEE: Maximum number of errors allowed

Type: number Default: 0

SPELLLYCHEE: If the number of errors found is less than this value, SPELLLYCHEE doesn't make MegaLinter fail

SPELL_LYCHEE: Matching files extensions

Type: array of string Default: [".md", ".mdx", ".markdown", ".html", ".htm", ".rst", ".txt", ".json", ".jsonc", ".json5", ".yaml", ".yml"]

SPELL_LYCHEE: 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"

SPELL_LYCHEE: Matching file name regexes

Type: array of string Default: []

SPELL_LYCHEE: 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"

SPELL_LYCHEE: Excluding Regex

Type: string or array of string

SPELLLYCHEE: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SPELLLYCHEECLILINT_MODE = project

SPELL_LYCHEE: Including Regex

Type: string or array of string

SPELLLYCHEE: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SPELLLYCHEECLILINT_MODE = project

SPELL_LYCHEE: Forward excluded directories in project lint mode

Type: boolean Default: true

SPELL_LYCHEE: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

SPELL_LYCHEE: Post-run commands

Type: array

SPELLLYCHEE: Define bash commands to run after running SPELLLYCHEE

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:

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"
    }
]

SPELL_LYCHEE: Pre-run commands

Type: array

SPELLLYCHEE: Define bash commands to run before running SPELLLYCHEE

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:

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"
    }
]

SPELL_LYCHEE: Custom config file path

Type: string

SPELL_LYCHEE: Path where to find linter configuration file

SPELL_LYCHEE: Timeout in seconds

Type: integer

SPELLLYCHEE: Maximum duration in seconds of the SPELLLYCHEE 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

SPELL_LYCHEE: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SPELL_LYCHEE and its pre/post commands

No Additional Items

Each item of this array must be:

(deprecated) SPELL_MISSPELL: Custom arguments

Type: array of string or string

SPELL_MISSPELL: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) SPELL_MISSPELL: CLI Executable

Type: array of string Default: [["misspell"]]
No Additional Items

Each item of this array must be:

(deprecated) SPELL_MISSPELL: Override default cli lint mode

Type: enum (of string) Default: "list_of_files"

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

(deprecated) SPELL_MISSPELL: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

(deprecated) SPELL_MISSPELL: Maximum number of errors allowed

Type: number Default: 0

(deprecated) SPELL_MISSPELL: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

(deprecated) SPELL_MISSPELL: 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) SPELL_MISSPELL: Excluding Regex

Type: string

(deprecated) SPELL_MISSPELL: Including Regex

Type: string

(deprecated) SPELL_MISSPELL: 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:

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) SPELL_MISSPELL: 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:

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"
    }
]

Post commands for SPELL descriptor

Type: array

SPELL: 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:

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 SPELL descriptor

Type: array

SPELL: 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:

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"
    }
]

SPELL_PROSELINT: Custom arguments

Type: array of string or string

SPELL_PROSELINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SPELL_PROSELINT: CLI Executable

Type: array of string Default: [["proselint"]]

SPELL_PROSELINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SPELL_PROSELINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SPELL_PROSELINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

SPELL_PROSELINT: Custom remove arguments

Type: array of string or string

SPELL_PROSELINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SPELL_PROSELINT: Custom config file name

Type: string Default: ".proselintrc.json"

SPELL_PROSELINT: User custom config file name if different from default

SPELL_PROSELINT: Disable errors

Type: boolean Default: false

SPELLPROSELINT: If true, SPELLPROSELINT doesn't make MegaLinter fail even if errors are found

SPELL_PROSELINT: Maximum number of errors allowed

Type: number Default: 0

SPELLPROSELINT: If the number of errors found is less than this value, SPELLPROSELINT doesn't make MegaLinter fail

SPELL_PROSELINT: Matching files extensions

Type: array of string Default: [".md", ".txt"]

SPELL_PROSELINT: 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"

SPELL_PROSELINT: Matching file name regexes

Type: array of string Default: []

SPELL_PROSELINT: 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"

SPELL_PROSELINT: Excluding Regex

Type: string or array of string

SPELLPROSELINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SPELLPROSELINTCLILINT_MODE = project

SPELL_PROSELINT: Including Regex

Type: string or array of string

SPELLPROSELINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SPELLPROSELINTCLILINT_MODE = project

SPELL_PROSELINT: Forward excluded directories in project lint mode

Type: boolean Default: true

SPELL_PROSELINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

SPELL_PROSELINT: Post-run commands

Type: array

SPELLPROSELINT: Define bash commands to run after running SPELLPROSELINT

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:

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"
    }
]

SPELL_PROSELINT: Pre-run commands

Type: array

SPELLPROSELINT: Define bash commands to run before running SPELLPROSELINT

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:

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"
    }
]

SPELL_PROSELINT: Custom config file path

Type: string

SPELL_PROSELINT: Path where to find linter configuration file

SPELL_PROSELINT: Timeout in seconds

Type: integer

SPELLPROSELINT: Maximum duration in seconds of the SPELLPROSELINT 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

SPELL_PROSELINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SPELL_PROSELINT and its pre/post commands

No Additional Items

Each item of this array must be:

SPELL_VALE: Custom arguments

Type: array of string or string

SPELL_VALE: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SPELL_VALE: CLI Executable

Type: array of string Default: [["vale"]]

SPELL_VALE: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SPELL_VALE: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SPELL_VALE: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

SPELL_VALE: Custom remove arguments

Type: array of string or string

SPELL_VALE: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SPELL_VALE: Custom config file name

Type: string Default: ".vale.ini"

SPELL_VALE: User custom config file name if different from default

SPELL_VALE: Disable errors

Type: boolean Default: false

SPELLVALE: If true, SPELLVALE doesn't make MegaLinter fail even if errors are found

SPELL_VALE: Maximum number of errors allowed

Type: number Default: 0

SPELLVALE: If the number of errors found is less than this value, SPELLVALE doesn't make MegaLinter fail

SPELL_VALE: Matching files extensions

Type: array of string Default: [".md", ".rst"]

SPELL_VALE: 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"

SPELL_VALE: Matching file name regexes

Type: array of string Default: []

SPELL_VALE: 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"

SPELL_VALE: Excluding Regex

Type: string or array of string

SPELLVALE: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SPELLVALECLILINT_MODE = project

SPELL_VALE: Including Regex

Type: string or array of string

SPELLVALE: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SPELLVALECLILINT_MODE = project

SPELL_VALE: Forward excluded directories in project lint mode

Type: boolean Default: true

SPELL_VALE: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

SPELL_VALE: Post-run commands

Type: array

SPELLVALE: Define bash commands to run after running SPELLVALE

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:

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"
    }
]

SPELL_VALE: Pre-run commands

Type: array

SPELLVALE: Define bash commands to run before running SPELLVALE

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:

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"
    }
]

SPELL_VALE: Custom config file path

Type: string

SPELL_VALE: Path where to find linter configuration file

SPELL_VALE: Timeout in seconds

Type: integer

SPELLVALE: Maximum duration in seconds of the SPELLVALE 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

SPELL_VALE: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SPELL_VALE and its pre/post commands

No Additional Items

Each item of this array must be:

Excluding regex filter for SQL descriptor

Type: string or array of string

SQL: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for SQL descriptor

Type: string or array of string

SQL: Custom regex including filter: only files matching this regex will be linted

Post commands for SQL descriptor

Type: array

SQL: 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:

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 SQL descriptor

Type: array

SQL: 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:

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"
    }
]

SQL_SQLFLUFF: Custom arguments

Type: array of string or string

SQL_SQLFLUFF: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SQL_SQLFLUFF: CLI Executable

Type: array of string Default: [["sqlfluff"]]

SQL_SQLFLUFF: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SQL_SQLFLUFF: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SQL_SQLFLUFF: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

SQL_SQLFLUFF: Custom remove arguments

Type: array of string or string

SQL_SQLFLUFF: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SQL_SQLFLUFF: Custom config file name

Type: string Default: ".sqlfluff"

SQL_SQLFLUFF: User custom config file name if different from default

SQL_SQLFLUFF: Disable errors

Type: boolean Default: false

SQLSQLFLUFF: If true, SQLSQLFLUFF doesn't make MegaLinter fail even if errors are found

SQL_SQLFLUFF: Maximum number of errors allowed

Type: number Default: 0

SQLSQLFLUFF: If the number of errors found is less than this value, SQLSQLFLUFF doesn't make MegaLinter fail

SQL_SQLFLUFF: Matching files extensions

Type: array of string Default: [".sql"]

SQL_SQLFLUFF: 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"

SQL_SQLFLUFF: Matching file name regexes

Type: array of string Default: []

SQL_SQLFLUFF: 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"

SQL_SQLFLUFF: Excluding Regex

Type: string or array of string

SQLSQLFLUFF: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SQLSQLFLUFFCLILINT_MODE = project

SQL_SQLFLUFF: Including Regex

Type: string or array of string

SQLSQLFLUFF: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SQLSQLFLUFFCLILINT_MODE = project

SQL_SQLFLUFF: Forward excluded directories in project lint mode

Type: boolean Default: true

SQL_SQLFLUFF: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

SQL_SQLFLUFF: Post-run commands

Type: array

SQLSQLFLUFF: Define bash commands to run after running SQLSQLFLUFF

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:

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"
    }
]

SQL_SQLFLUFF: Pre-run commands

Type: array

SQLSQLFLUFF: Define bash commands to run before running SQLSQLFLUFF

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:

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"
    }
]

SQL_SQLFLUFF: Custom config file path

Type: string

SQL_SQLFLUFF: Path where to find linter configuration file

SQL_SQLFLUFF: Timeout in seconds

Type: integer

SQLSQLFLUFF: Maximum duration in seconds of the SQLSQLFLUFF 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

SQL_SQLFLUFF: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SQL_SQLFLUFF and its pre/post commands

No Additional Items

Each item of this array must be:

(deprecated) SQL_SQL_LINT: Custom arguments

Type: array of string or string

SQLSQLLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) SQL_SQL_LINT: CLI Executable

Type: array of string Default: [["sql-lint"]]
No Additional Items

Each item of this array must be:

(deprecated) SQL_SQL_LINT: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "project"

(deprecated) SQL_SQL_LINT: Custom remove arguments

Type: array of string or string

SQLSQLLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) SQL_SQL_LINT: Custom config file name

Type: string Default: ".sql-config.json"

SQLSQLLINT: User custom config file name if different from default

(deprecated) SQL_SQL_LINT: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

(deprecated) SQL_SQL_LINT: Maximum number of errors allowed

Type: number Default: 0

(deprecated) SQL_SQL_LINT: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

(deprecated) SQL_SQL_LINT: Custom config file name

Type: string Default: ".sql-config.json"

SQLSQLLINT: User custom config file name if different from default

(deprecated) SQL_SQL_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) SQL_SQL_LINT: Excluding Regex

Type: string

(deprecated) SQL_SQL_LINT: Including Regex

Type: string

(deprecated) SQL_SQL_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:

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) SQL_SQL_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:

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) SQL_SQL_LINT: Custom config file path

Type: string

SQLSQLLINT: Path where to find linter configuration file

(deprecated) SQL_SQL_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SQLSQLLINT and its pre/post commands

No Additional Items

Each item of this array must be:

(deprecated) SQL_TSQLLINT: Custom arguments

Type: array of string or string

SQL_TSQLLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) SQL_TSQLLINT: CLI Executable

Type: array of string Default: [["tsqllint"]]

SQL_TSQLLINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

(deprecated) SQL_TSQLLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

SQL_TSQLLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

(deprecated) SQL_TSQLLINT: Custom remove arguments

Type: array of string or string

SQL_TSQLLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) SQL_TSQLLINT: Custom config file name

Type: string Default: ".tsqllintrc"

SQL_TSQLLINT: User custom config file name if different from default

(deprecated) SQL_TSQLLINT: Disable errors

Type: boolean Default: false

SQLTSQLLINT: If true, SQLTSQLLINT doesn't make MegaLinter fail even if errors are found

(deprecated) SQL_TSQLLINT: Maximum number of errors allowed

Type: number Default: 0

SQLTSQLLINT: If the number of errors found is less than this value, SQLTSQLLINT doesn't make MegaLinter fail

(deprecated) SQL_TSQLLINT: Matching files extensions

Type: array of string Default: [".sql"]

SQL_TSQLLINT: 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"

(deprecated) SQL_TSQLLINT: Matching file name regexes

Type: array of string Default: []

SQL_TSQLLINT: 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"

(deprecated) SQL_TSQLLINT: Excluding Regex

Type: string or array of string

SQLTSQLLINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SQLTSQLLINTCLILINT_MODE = project

(deprecated) SQL_TSQLLINT: Including Regex

Type: string or array of string

SQLTSQLLINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SQLTSQLLINTCLILINT_MODE = project

(deprecated) SQL_TSQLLINT: Post-run commands

Type: array

SQLTSQLLINT: Define bash commands to run after running SQLTSQLLINT

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:

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) SQL_TSQLLINT: Pre-run commands

Type: array

SQLTSQLLINT: Define bash commands to run before running SQLTSQLLINT

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:

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) SQL_TSQLLINT: Custom config file path

Type: string

SQL_TSQLLINT: Path where to find linter configuration file

(deprecated) SQL_TSQLLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SQL_TSQLLINT and its pre/post commands

No Additional Items

Each item of this array must be:

Excluding regex filter for SWIFT descriptor

Type: string or array of string

SWIFT: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for SWIFT descriptor

Type: string or array of string

SWIFT: Custom regex including filter: only files matching this regex will be linted

Post commands for SWIFT descriptor

Type: array

SWIFT: 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:

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 SWIFT descriptor

Type: array

SWIFT: 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:

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"
    }
]

SWIFT_SWIFTLINT: Custom arguments

Type: array of string or string

SWIFT_SWIFTLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

SWIFT_SWIFTLINT: CLI Executable

Type: array of string Default: [["swiftlint"]]

SWIFT_SWIFTLINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

SWIFT_SWIFTLINT: CLI lint mode

Type: enum (of string) Default: "project"

SWIFT_SWIFTLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

SWIFT_SWIFTLINT: Custom remove arguments

Type: array of string or string

SWIFT_SWIFTLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

SWIFT_SWIFTLINT: Custom config file name

Type: string Default: ".swiftlint.yml"

SWIFT_SWIFTLINT: User custom config file name if different from default

SWIFT_SWIFTLINT: Disable errors

Type: boolean Default: false

SWIFTSWIFTLINT: If true, SWIFTSWIFTLINT doesn't make MegaLinter fail even if errors are found

SWIFT_SWIFTLINT: Maximum number of errors allowed

Type: number Default: 0

SWIFTSWIFTLINT: If the number of errors found is less than this value, SWIFTSWIFTLINT doesn't make MegaLinter fail

SWIFT_SWIFTLINT: Matching files extensions

Type: array of string Default: [".swift"]

SWIFT_SWIFTLINT: 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"

SWIFT_SWIFTLINT: Matching file name regexes

Type: array of string Default: []

SWIFT_SWIFTLINT: 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"

SWIFT_SWIFTLINT: Excluding Regex

Type: string or array of string

SWIFTSWIFTLINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with SWIFTSWIFTLINTCLILINT_MODE = project

SWIFT_SWIFTLINT: Including Regex

Type: string or array of string

SWIFTSWIFTLINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with SWIFTSWIFTLINTCLILINT_MODE = project

SWIFT_SWIFTLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

SWIFT_SWIFTLINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

SWIFT_SWIFTLINT: Post-run commands

Type: array

SWIFTSWIFTLINT: Define bash commands to run after running SWIFTSWIFTLINT

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:

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"
    }
]

SWIFT_SWIFTLINT: Pre-run commands

Type: array

SWIFTSWIFTLINT: Define bash commands to run before running SWIFTSWIFTLINT

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:

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"
    }
]

SWIFT_SWIFTLINT: Custom config file path

Type: string

SWIFT_SWIFTLINT: Path where to find linter configuration file

SWIFT_SWIFTLINT: Timeout in seconds

Type: integer

SWIFTSWIFTLINT: Maximum duration in seconds of the SWIFTSWIFTLINT 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

SWIFT_SWIFTLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling SWIFT_SWIFTLINT and its pre/post commands

No Additional Items

Each item of this array must be:

Activate TAP reporter

Type: boolean Default: false

General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter

TAP reporter sub folder

Type: string Default: "tap"

Sub-folder of reports folder containing TAP logs

Excluding regex filter for TEKTON descriptor

Type: string or array of string

TEKTON: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for TEKTON descriptor

Type: string or array of string

TEKTON: Custom regex including filter: only files matching this regex will be linted

Post commands for TEKTON descriptor

Type: array

TEKTON: 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:

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 TEKTON descriptor

Type: array

TEKTON: 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:

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"
    }
]

TEKTON_TEKTON_LINT: Custom arguments

Type: array of string or string

TEKTONTEKTONLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

TEKTON_TEKTON_LINT: CLI Executable

Type: array of string Default: [["tekton-lint"]]

TEKTONTEKTONLINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

TEKTON_TEKTON_LINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

TEKTONTEKTONLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

TEKTON_TEKTON_LINT: Custom remove arguments

Type: array of string or string

TEKTONTEKTONLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

TEKTON_TEKTON_LINT: Custom config file name

Type: string Default: ".tektonlintrc.yaml"

TEKTONTEKTONLINT: User custom config file name if different from default

TEKTON_TEKTON_LINT: Disable errors

Type: boolean Default: false

TEKTONTEKTONLINT: If true, TEKTONTEKTONLINT doesn't make MegaLinter fail even if errors are found

TEKTON_TEKTON_LINT: Maximum number of errors allowed

Type: number Default: 0

TEKTONTEKTONLINT: If the number of errors found is less than this value, TEKTONTEKTONLINT doesn't make MegaLinter fail

TEKTON_TEKTON_LINT: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

TEKTONTEKTONLINT: 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"

TEKTON_TEKTON_LINT: Matching file name regexes

Type: array of string Default: []

TEKTONTEKTONLINT: 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"

TEKTON_TEKTON_LINT: Excluding Regex

Type: string or array of string

TEKTONTEKTONLINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with TEKTONTEKTONLINTCLILINT_MODE = project

TEKTON_TEKTON_LINT: Including Regex

Type: string or array of string

TEKTONTEKTONLINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with TEKTONTEKTONLINTCLILINT_MODE = project

TEKTON_TEKTON_LINT: Forward excluded directories in project lint mode

Type: boolean Default: true

TEKTONTEKTONLINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

TEKTON_TEKTON_LINT: Post-run commands

Type: array

TEKTONTEKTONLINT: Define bash commands to run after running TEKTONTEKTONLINT

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:

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"
    }
]

TEKTON_TEKTON_LINT: Pre-run commands

Type: array

TEKTONTEKTONLINT: Define bash commands to run before running TEKTONTEKTONLINT

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:

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"
    }
]

TEKTON_TEKTON_LINT: Custom config file path

Type: string

TEKTONTEKTONLINT: Path where to find linter configuration file

TEKTON_TEKTON_LINT: Timeout in seconds

Type: integer

TEKTONTEKTONLINT: Maximum duration in seconds of the TEKTONTEKTONLINT 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

TEKTON_TEKTON_LINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TEKTONTEKTONLINT and its pre/post commands

No Additional Items

Each item of this array must be:

(deprecated) (removed) TERRAFORM_CHECKOV: Custom arguments

Type: array of string or string

TERRAFORM_CHECKOV: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) (removed) TERRAFORM_CHECKOV: CLI Executable

Type: array of string Default: [["checkov"]]
No Additional Items

Each item of this array must be:

(deprecated) (removed) TERRAFORM_CHECKOV: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "project"

(deprecated) (removed) TERRAFORM_CHECKOV: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

(deprecated) (removed) TERRAFORM_CHECKOV: Maximum number of errors allowed

Type: number Default: 0

(deprecated) (removed) TERRAFORM_CHECKOV: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

(deprecated) (removed) TERRAFORM_CHECKOV: 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) TERRAFORM_CHECKOV: Excluding Regex

Type: string

(deprecated) (removed) TERRAFORM_CHECKOV: Including Regex

Type: string

(deprecated) (removed) TERRAFORM_CHECKOV: 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:

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) TERRAFORM_CHECKOV: 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:

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"
    }
]

Excluding regex filter for TERRAFORM descriptor

Type: string or array of string

TERRAFORM: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for TERRAFORM descriptor

Type: string or array of string

TERRAFORM: Custom regex including filter: only files matching this regex will be linted

(deprecated) (removed) TERRAFORM_KICS: Custom arguments

Type: array of string or string

TERRAFORM_KICS: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) (removed) TERRAFORM_KICS: CLI Executable

Type: array of string Default: [["kics"]]
No Additional Items

Each item of this array must be:

(deprecated) (removed) TERRAFORM_KICS: Override default cli lint mode

Type: enum (of string) Default: "file"

Must be one of:

  • "file"
  • "project"

(deprecated) (removed) TERRAFORM_KICS: Linter doesn't make MegaLinter fail even if errors are found

Type: boolean Default: false

(deprecated) (removed) TERRAFORM_KICS: Maximum number of errors allowed

Type: number Default: 0

(deprecated) (removed) TERRAFORM_KICS: Override descriptor/linter matching files extensions

Type: array of string
No Additional Items

Each item of this array must be:

(deprecated) (removed) TERRAFORM_KICS: 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) TERRAFORM_KICS: Excluding Regex

Type: string

(deprecated) (removed) TERRAFORM_KICS: Including Regex

Type: string

(deprecated) (removed) TERRAFORM_KICS: 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:

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) TERRAFORM_KICS: 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:

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"
    }
]

Post commands for TERRAFORM descriptor

Type: array

TERRAFORM: 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:

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 TERRAFORM descriptor

Type: array

TERRAFORM: 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:

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"
    }
]

TERRAFORM_TERRAFORM_FMT: Custom arguments

Type: array of string or string

TERRAFORMTERRAFORMFMT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

TERRAFORM_TERRAFORM_FMT: CLI Executable

Type: array of string Default: [["terraform"]]

TERRAFORMTERRAFORMFMT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

TERRAFORM_TERRAFORM_FMT: CLI lint mode

Type: enum (of string) Default: "file"

TERRAFORMTERRAFORMFMT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"

TERRAFORM_TERRAFORM_FMT: Custom remove arguments

Type: array of string or string

TERRAFORMTERRAFORMFMT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

TERRAFORM_TERRAFORM_FMT: Disable errors

Type: boolean Default: false

TERRAFORMTERRAFORMFMT: If true, TERRAFORMTERRAFORMFMT doesn't make MegaLinter fail even if errors are found

TERRAFORM_TERRAFORM_FMT: Maximum number of errors allowed

Type: number Default: 0

TERRAFORMTERRAFORMFMT: If the number of errors found is less than this value, TERRAFORMTERRAFORMFMT doesn't make MegaLinter fail

TERRAFORM_TERRAFORM_FMT: Matching files extensions

Type: array of string Default: [".tf"]

TERRAFORMTERRAFORMFMT: 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"

TERRAFORM_TERRAFORM_FMT: Matching file name regexes

Type: array of string Default: []

TERRAFORMTERRAFORMFMT: 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"

TERRAFORM_TERRAFORM_FMT: Excluding Regex

Type: string or array of string

TERRAFORM_TERRAFORM_FMT: Including Regex

Type: string or array of string

TERRAFORM_TERRAFORM_FMT: Post-run commands

Type: array

TERRAFORMTERRAFORMFMT: Define bash commands to run after running TERRAFORMTERRAFORMFMT

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:

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"
    }
]

TERRAFORM_TERRAFORM_FMT: Pre-run commands

Type: array

TERRAFORMTERRAFORMFMT: Define bash commands to run before running TERRAFORMTERRAFORMFMT

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:

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"
    }
]

TERRAFORM_TERRAFORM_FMT: Timeout in seconds

Type: integer

TERRAFORMTERRAFORMFMT: Maximum duration in seconds of the TERRAFORMTERRAFORMFMT 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

TERRAFORM_TERRAFORM_FMT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TERRAFORMTERRAFORMFMT and its pre/post commands

No Additional Items

Each item of this array must be:

TERRAFORM_TERRAGRUNT: Custom arguments

Type: array of string or string

TERRAFORM_TERRAGRUNT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

TERRAFORM_TERRAGRUNT: CLI Executable

Type: array of string Default: [["terragrunt"]]

TERRAFORM_TERRAGRUNT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

TERRAFORM_TERRAGRUNT: CLI lint mode

Type: enum (of string) Default: "file"

TERRAFORM_TERRAGRUNT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"

TERRAFORM_TERRAGRUNT: Custom remove arguments

Type: array of string or string

TERRAFORM_TERRAGRUNT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

TERRAFORM_TERRAGRUNT: Custom config file name

Type: string Default: "terragrunt.hcl"

TERRAFORM_TERRAGRUNT: User custom config file name if different from default

TERRAFORM_TERRAGRUNT: Disable errors

Type: boolean Default: false

TERRAFORMTERRAGRUNT: If true, TERRAFORMTERRAGRUNT doesn't make MegaLinter fail even if errors are found

TERRAFORM_TERRAGRUNT: Maximum number of errors allowed

Type: number Default: 0

TERRAFORMTERRAGRUNT: If the number of errors found is less than this value, TERRAFORMTERRAGRUNT doesn't make MegaLinter fail

TERRAFORM_TERRAGRUNT: Matching files extensions

Type: array of string Default: [".hcl"]

TERRAFORM_TERRAGRUNT: 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"

TERRAFORM_TERRAGRUNT: Matching file name regexes

Type: array of string Default: []

TERRAFORM_TERRAGRUNT: 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"

TERRAFORM_TERRAGRUNT: Excluding Regex

Type: string or array of string

TERRAFORM_TERRAGRUNT: Including Regex

Type: string or array of string

TERRAFORM_TERRAGRUNT: Post-run commands

Type: array

TERRAFORMTERRAGRUNT: Define bash commands to run after running TERRAFORMTERRAGRUNT

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:

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"
    }
]

TERRAFORM_TERRAGRUNT: Pre-run commands

Type: array

TERRAFORMTERRAGRUNT: Define bash commands to run before running TERRAFORMTERRAGRUNT

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:

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"
    }
]

TERRAFORM_TERRAGRUNT: Custom config file path

Type: string

TERRAFORM_TERRAGRUNT: Path where to find linter configuration file

TERRAFORM_TERRAGRUNT: Timeout in seconds

Type: integer

TERRAFORMTERRAGRUNT: Maximum duration in seconds of the TERRAFORMTERRAGRUNT 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

TERRAFORM_TERRAGRUNT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TERRAFORM_TERRAGRUNT and its pre/post commands

No Additional Items

Each item of this array must be:

(deprecated) TERRAFORM_TERRASCAN: Custom arguments

Type: array of string or string

TERRAFORM_TERRASCAN: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

(deprecated) TERRAFORM_TERRASCAN: CLI Executable

Type: array of string Default: [["terrascan"]]

TERRAFORM_TERRASCAN: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

(deprecated) TERRAFORM_TERRASCAN: CLI lint mode

Type: enum (of string) Default: "project"

TERRAFORM_TERRASCAN: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

(deprecated) TERRAFORM_TERRASCAN: Custom remove arguments

Type: array of string or string

TERRAFORM_TERRASCAN: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

(deprecated) TERRAFORM_TERRASCAN: Custom config file name

Type: string Default: "terrascan.toml"

TERRAFORM_TERRASCAN: User custom config file name if different from default

(deprecated) TERRAFORM_TERRASCAN: Disable errors

Type: boolean Default: false

TERRAFORMTERRASCAN: If true, TERRAFORMTERRASCAN doesn't make MegaLinter fail even if errors are found

(deprecated) TERRAFORM_TERRASCAN: Maximum number of errors allowed

Type: number Default: 0

TERRAFORMTERRASCAN: If the number of errors found is less than this value, TERRAFORMTERRASCAN doesn't make MegaLinter fail

(deprecated) TERRAFORM_TERRASCAN: Matching files extensions

Type: array of string Default: [".tf"]

TERRAFORM_TERRASCAN: 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"

(deprecated) TERRAFORM_TERRASCAN: Matching file name regexes

Type: array of string Default: []

TERRAFORM_TERRASCAN: 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"

(deprecated) TERRAFORM_TERRASCAN: Excluding Regex

Type: string or array of string

TERRAFORMTERRASCAN: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with TERRAFORMTERRASCANCLILINT_MODE = project

(deprecated) TERRAFORM_TERRASCAN: Including Regex

Type: string or array of string

TERRAFORMTERRASCAN: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with TERRAFORMTERRASCANCLILINT_MODE = project

(deprecated) TERRAFORM_TERRASCAN: Post-run commands

Type: array

(deprecated) TERRAFORMTERRASCAN: Define bash commands to run after running TERRAFORMTERRASCAN

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:

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) TERRAFORM_TERRASCAN: Pre-run commands

Type: array

(deprecated) TERRAFORMTERRASCAN: Define bash commands to run before running TERRAFORMTERRASCAN

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:

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) TERRAFORM_TERRASCAN: Custom config file path

Type: string

TERRAFORM_TERRASCAN: Path where to find linter configuration file

(deprecated) TERRAFORM_TERRASCAN: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TERRAFORM_TERRASCAN and its pre/post commands

No Additional Items

Each item of this array must be:

TERRAFORM_TFLINT: Custom arguments

Type: array of string or string

TERRAFORM_TFLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

TERRAFORM_TFLINT: CLI Executable

Type: array of string Default: [["tflint"]]

TERRAFORM_TFLINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

TERRAFORM_TFLINT: CLI lint mode

Type: enum (of string) Default: "project"

TERRAFORM_TFLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

TERRAFORM_TFLINT: Custom remove arguments

Type: array of string or string

TERRAFORM_TFLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

TERRAFORM_TFLINT: Custom config file name

Type: string Default: ".tflint.hcl"

TERRAFORM_TFLINT: User custom config file name if different from default

TERRAFORM_TFLINT: Disable errors

Type: boolean Default: false

TERRAFORMTFLINT: If true, TERRAFORMTFLINT doesn't make MegaLinter fail even if errors are found

TERRAFORM_TFLINT: Maximum number of errors allowed

Type: number Default: 0

TERRAFORMTFLINT: If the number of errors found is less than this value, TERRAFORMTFLINT doesn't make MegaLinter fail

TERRAFORM_TFLINT: Matching files extensions

Type: array of string Default: [".tf"]

TERRAFORM_TFLINT: 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"

TERRAFORM_TFLINT: Matching file name regexes

Type: array of string Default: []

TERRAFORM_TFLINT: 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"

TERRAFORM_TFLINT: Excluding Regex

Type: string or array of string

TERRAFORMTFLINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with TERRAFORMTFLINTCLILINT_MODE = project

TERRAFORM_TFLINT: Including Regex

Type: string or array of string

TERRAFORMTFLINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with TERRAFORMTFLINTCLILINT_MODE = project

TERRAFORM_TFLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

TERRAFORM_TFLINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

TERRAFORM_TFLINT: Post-run commands

Type: array

TERRAFORMTFLINT: Define bash commands to run after running TERRAFORMTFLINT

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:

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"
    }
]

TERRAFORM_TFLINT: Pre-run commands

Type: array

TERRAFORMTFLINT: Define bash commands to run before running TERRAFORMTFLINT

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:

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"
    }
]

TERRAFORM_TFLINT: Custom config file path

Type: string

TERRAFORM_TFLINT: Path where to find linter configuration file

TERRAFORM_TFLINT: Secured Environment Flag

Type: boolean Default: true

TERRAFORM_TFLINT: Allows to send the full env to tflint --init. Initialized with default value true. Set to false to allow tflint --init to access your env vars.

TERRAFORM_TFLINT: Timeout in seconds

Type: integer

TERRAFORMTFLINT: Maximum duration in seconds of the TERRAFORMTFLINT 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

TERRAFORM_TFLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TERRAFORM_TFLINT and its pre/post commands

No Additional Items

Each item of this array must be:

Activate text reporter

Type: boolean Default: true

General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter

Text reporter sub folder

Type: string Default: "linters_logs"

Sub-folder of reports folder containing text logs

TSX_ESLINT: Custom arguments

Type: array of string or string

TSX_ESLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

TSX_ESLINT: CLI Executable

Type: array of string Default: [["eslint"]]

TSX_ESLINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

TSX_ESLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

TSX_ESLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

TSX_ESLINT: Custom remove arguments

Type: array of string or string

TSX_ESLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

TSX_ESLINT: Custom config file name

Type: string Default: "eslint.config.cjs"

TSX_ESLINT: User custom config file name if different from default

TSX_ESLINT: Disable errors

Type: boolean Default: false

TSXESLINT: If true, TSXESLINT doesn't make MegaLinter fail even if errors are found

TSX_ESLINT: Maximum number of errors allowed

Type: number Default: 0

TSXESLINT: If the number of errors found is less than this value, TSXESLINT doesn't make MegaLinter fail

TSX_ESLINT: Matching files extensions

Type: array of string Default: [".tsx"]

TSX_ESLINT: 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"

TSX_ESLINT: Matching file name regexes

Type: array of string Default: []

TSX_ESLINT: 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"

TSX_ESLINT: Excluding Regex

Type: string or array of string

TSXESLINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with TSXESLINTCLILINT_MODE = project

TSX_ESLINT: Including Regex

Type: string or array of string

TSXESLINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with TSXESLINTCLILINT_MODE = project

TSX_ESLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

TSX_ESLINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

TSX_ESLINT: Post-run commands

Type: array

TSXESLINT: Define bash commands to run after running TSXESLINT

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:

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"
    }
]

TSX_ESLINT: Pre-run commands

Type: array

TSXESLINT: Define bash commands to run before running TSXESLINT

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:

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"
    }
]

TSX_ESLINT: Custom config file path

Type: string

TSX_ESLINT: Path where to find linter configuration file

TSX_ESLINT: Timeout in seconds

Type: integer

TSXESLINT: Maximum duration in seconds of the TSXESLINT 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

TSX_ESLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TSX_ESLINT and its pre/post commands

No Additional Items

Each item of this array must be:

Excluding regex filter for TSX descriptor

Type: string or array of string

TSX: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for TSX descriptor

Type: string or array of string

TSX: Custom regex including filter: only files matching this regex will be linted

Post commands for TSX descriptor

Type: array

TSX: 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:

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 TSX descriptor

Type: array

TSX: 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:

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"
    }
]

Typescript default style

Type: enum (of string) Default: "prettier"

Style of typescript formatting to apply

Must be one of:

  • "standard"
  • "prettier"

Examples:

"standard"
"prettier"

TYPESCRIPT_ES: Custom arguments

Type: array of string or string

TYPESCRIPT_ES: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

TYPESCRIPT_ES: CLI Executable

Type: array of string Default: [["eslint"]]

TYPESCRIPT_ES: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

TYPESCRIPT_ES: CLI lint mode

Type: enum (of string) Default: "list_of_files"

TYPESCRIPT_ES: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

TYPESCRIPT_ES: Custom remove arguments

Type: array of string or string

TYPESCRIPT_ES: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

TYPESCRIPT_ES: Custom config file name

Type: string Default: "eslint.config.js"

TYPESCRIPT_ES: User custom config file name if different from default

TYPESCRIPT_ES: Disable errors

Type: boolean Default: false

TYPESCRIPTES: If true, TYPESCRIPTES doesn't make MegaLinter fail even if errors are found

TYPESCRIPT_ES: Maximum number of errors allowed

Type: number Default: 0

TYPESCRIPTES: If the number of errors found is less than this value, TYPESCRIPTES doesn't make MegaLinter fail

TYPESCRIPT_ES: Matching files extensions

Type: array of string Default: [".ts"]

TYPESCRIPT_ES: 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"

TYPESCRIPT_ES: Matching file name regexes

Type: array of string Default: []

TYPESCRIPT_ES: 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"

TYPESCRIPT_ES: Excluding Regex

Type: string or array of string

TYPESCRIPTES: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with TYPESCRIPTESCLILINT_MODE = project

TYPESCRIPT_ES: Including Regex

Type: string or array of string

TYPESCRIPTES: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with TYPESCRIPTESCLILINT_MODE = project

TYPESCRIPT_ES: Forward excluded directories in project lint mode

Type: boolean Default: true

TYPESCRIPT_ES: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

TYPESCRIPT_ES: Post-run commands

Type: array

TYPESCRIPTES: Define bash commands to run after running TYPESCRIPTES

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:

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"
    }
]

TYPESCRIPT_ES: Pre-run commands

Type: array

TYPESCRIPTES: Define bash commands to run before running TYPESCRIPTES

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:

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"
    }
]

TYPESCRIPT_ES: Custom config file path

Type: string

TYPESCRIPT_ES: Path where to find linter configuration file

TYPESCRIPT_ES: Timeout in seconds

Type: integer

TYPESCRIPTES: Maximum duration in seconds of the TYPESCRIPTES 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

TYPESCRIPT_ES: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TYPESCRIPT_ES and its pre/post commands

No Additional Items

Each item of this array must be:

Excluding regex filter for TYPESCRIPT descriptor

Type: string or array of string

TYPESCRIPT: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for TYPESCRIPT descriptor

Type: string or array of string

TYPESCRIPT: Custom regex including filter: only files matching this regex will be linted

Post commands for TYPESCRIPT descriptor

Type: array

TYPESCRIPT: 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:

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"
    }
]

TYPESCRIPT_PRETTIER: Custom arguments

Type: array of string or string

TYPESCRIPT_PRETTIER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

TYPESCRIPT_PRETTIER: CLI Executable

Type: array of string Default: [["prettier"]]

TYPESCRIPT_PRETTIER: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

TYPESCRIPT_PRETTIER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

TYPESCRIPT_PRETTIER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

TYPESCRIPT_PRETTIER: Custom remove arguments

Type: array of string or string

TYPESCRIPT_PRETTIER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

TYPESCRIPT_PRETTIER: Custom config file name

Type: string Default: ".prettierrc.json"

TYPESCRIPT_PRETTIER: User custom config file name if different from default

TYPESCRIPT_PRETTIER: Disable errors

Type: boolean Default: false

TYPESCRIPTPRETTIER: If true, TYPESCRIPTPRETTIER doesn't make MegaLinter fail even if errors are found

TYPESCRIPT_PRETTIER: Maximum number of errors allowed

Type: number Default: 0

TYPESCRIPTPRETTIER: If the number of errors found is less than this value, TYPESCRIPTPRETTIER doesn't make MegaLinter fail

TYPESCRIPT_PRETTIER: Matching files extensions

Type: array of string Default: [".ts"]

TYPESCRIPT_PRETTIER: 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"

TYPESCRIPT_PRETTIER: Matching file name regexes

Type: array of string Default: []

TYPESCRIPT_PRETTIER: 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"

TYPESCRIPT_PRETTIER: Excluding Regex

Type: string or array of string

TYPESCRIPTPRETTIER: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with TYPESCRIPTPRETTIERCLILINT_MODE = project

TYPESCRIPT_PRETTIER: Including Regex

Type: string or array of string

TYPESCRIPTPRETTIER: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with TYPESCRIPTPRETTIERCLILINT_MODE = project

TYPESCRIPT_PRETTIER: Forward excluded directories in project lint mode

Type: boolean Default: true

TYPESCRIPT_PRETTIER: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

TYPESCRIPT_PRETTIER: Post-run commands

Type: array

TYPESCRIPTPRETTIER: Define bash commands to run after running TYPESCRIPTPRETTIER

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:

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"
    }
]

TYPESCRIPT_PRETTIER: Pre-run commands

Type: array

TYPESCRIPTPRETTIER: Define bash commands to run before running TYPESCRIPTPRETTIER

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:

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"
    }
]

TYPESCRIPT_PRETTIER: Custom config file path

Type: string

TYPESCRIPT_PRETTIER: Path where to find linter configuration file

TYPESCRIPT_PRETTIER: Timeout in seconds

Type: integer

TYPESCRIPTPRETTIER: Maximum duration in seconds of the TYPESCRIPTPRETTIER 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

TYPESCRIPT_PRETTIER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TYPESCRIPT_PRETTIER and its pre/post commands

No Additional Items

Each item of this array must be:

Pre commands for TYPESCRIPT descriptor

Type: array

TYPESCRIPT: 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:

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"
    }
]

TYPESCRIPT_STANDARD: Custom arguments

Type: array of string or string

TYPESCRIPT_STANDARD: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

TYPESCRIPT_STANDARD: CLI Executable

Type: array of string Default: [["ts-standard"]]

TYPESCRIPT_STANDARD: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

TYPESCRIPT_STANDARD: CLI lint mode

Type: enum (of string) Default: "list_of_files"

TYPESCRIPT_STANDARD: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

TYPESCRIPT_STANDARD: Custom remove arguments

Type: array of string or string

TYPESCRIPT_STANDARD: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

TYPESCRIPT_STANDARD: Disable errors

Type: boolean Default: false

TYPESCRIPTSTANDARD: If true, TYPESCRIPTSTANDARD doesn't make MegaLinter fail even if errors are found

TYPESCRIPT_STANDARD: Maximum number of errors allowed

Type: number Default: 0

TYPESCRIPTSTANDARD: If the number of errors found is less than this value, TYPESCRIPTSTANDARD doesn't make MegaLinter fail

TYPESCRIPT_STANDARD: Matching files extensions

Type: array of string Default: [".ts"]

TYPESCRIPT_STANDARD: 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"

TYPESCRIPT_STANDARD: Matching file name regexes

Type: array of string Default: []

TYPESCRIPT_STANDARD: 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"

TYPESCRIPT_STANDARD: Excluding Regex

Type: string or array of string

TYPESCRIPTSTANDARD: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with TYPESCRIPTSTANDARDCLILINT_MODE = project

TYPESCRIPT_STANDARD: Including Regex

Type: string or array of string

TYPESCRIPTSTANDARD: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with TYPESCRIPTSTANDARDCLILINT_MODE = project

TYPESCRIPT_STANDARD: Forward excluded directories in project lint mode

Type: boolean Default: true

TYPESCRIPT_STANDARD: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

TYPESCRIPT_STANDARD: Post-run commands

Type: array

TYPESCRIPTSTANDARD: Define bash commands to run after running TYPESCRIPTSTANDARD

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:

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"
    }
]

TYPESCRIPT_STANDARD: Pre-run commands

Type: array

TYPESCRIPTSTANDARD: Define bash commands to run before running TYPESCRIPTSTANDARD

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:

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"
    }
]

TYPESCRIPT_STANDARD: Timeout in seconds

Type: integer

TYPESCRIPTSTANDARD: Maximum duration in seconds of the TYPESCRIPTSTANDARD 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

TYPESCRIPT_STANDARD: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling TYPESCRIPT_STANDARD and its pre/post commands

No Additional Items

Each item of this array must be:

Activates/Deactivates updated sources reporter

Type: boolean

Sub-folder of reports folder containing updated sources

Type: string

Validate all code base

Type: boolean Default: true

Will parse the entire repository and find all files to validate across all types. When set to false, only new or edited files will be parsed for validation.

VBDOTNET_DOTNET_FORMAT: Custom arguments

Type: array of string or string

VBDOTNETDOTNETFORMAT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

VBDOTNET_DOTNET_FORMAT: CLI Executable

Type: array of string Default: [["dotnet"]]

VBDOTNETDOTNETFORMAT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

VBDOTNET_DOTNET_FORMAT: CLI lint mode

Type: enum (of string) Default: "project"

VBDOTNETDOTNETFORMAT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "project"

VBDOTNET_DOTNET_FORMAT: Custom remove arguments

Type: array of string or string

VBDOTNETDOTNETFORMAT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

VBDOTNET_DOTNET_FORMAT: Disable errors

Type: boolean Default: false

VBDOTNETDOTNETFORMAT: If true, VBDOTNETDOTNETFORMAT doesn't make MegaLinter fail even if errors are found

VBDOTNET_DOTNET_FORMAT: Maximum number of errors allowed

Type: number Default: 0

VBDOTNETDOTNETFORMAT: If the number of errors found is less than this value, VBDOTNETDOTNETFORMAT doesn't make MegaLinter fail

VBDOTNET_DOTNET_FORMAT: Matching files extensions

Type: array of string Default: [".vb"]

VBDOTNETDOTNETFORMAT: 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"

VBDOTNET_DOTNET_FORMAT: Matching file name regexes

Type: array of string Default: []

VBDOTNETDOTNETFORMAT: 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"

VBDOTNET_DOTNET_FORMAT: Excluding Regex

Type: string or array of string

VBDOTNETDOTNETFORMAT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with VBDOTNETDOTNETFORMATCLILINT_MODE = project

VBDOTNET_DOTNET_FORMAT: Including Regex

Type: string or array of string

VBDOTNETDOTNETFORMAT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with VBDOTNETDOTNETFORMATCLILINT_MODE = project

VBDOTNET_DOTNET_FORMAT: Forward excluded directories in project lint mode

Type: boolean Default: true

VBDOTNETDOTNETFORMAT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

VBDOTNET_DOTNET_FORMAT: Post-run commands

Type: array

VBDOTNETDOTNETFORMAT: Define bash commands to run after running VBDOTNETDOTNETFORMAT

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:

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"
    }
]

VBDOTNET_DOTNET_FORMAT: Pre-run commands

Type: array

VBDOTNETDOTNETFORMAT: Define bash commands to run before running VBDOTNETDOTNETFORMAT

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:

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"
    }
]

VBDOTNET_DOTNET_FORMAT: Timeout in seconds

Type: integer

VBDOTNETDOTNETFORMAT: Maximum duration in seconds of the VBDOTNETDOTNETFORMAT 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

VBDOTNET_DOTNET_FORMAT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling VBDOTNETDOTNETFORMAT and its pre/post commands

No Additional Items

Each item of this array must be:

Excluding regex filter for VBDOTNET descriptor

Type: string or array of string

VBDOTNET: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for VBDOTNET descriptor

Type: string or array of string

VBDOTNET: Custom regex including filter: only files matching this regex will be linted

Post commands for VBDOTNET descriptor

Type: array

VBDOTNET: 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:

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 VBDOTNET descriptor

Type: array

VBDOTNET: 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:

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"
    }
]

Get linter versions at runtime

Type: boolean Default: false

Force calling the linter executables to collect their version, instead of using the versions collected at MegaLinter Docker image build time. Slower, but useful if you install additional or different linter versions with PRE_COMMANDS

Excluding regex filter for XML descriptor

Type: string or array of string

XML: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for XML descriptor

Type: string or array of string

XML: Custom regex including filter: only files matching this regex will be linted

Post commands for XML descriptor

Type: array

XML: 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:

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 XML descriptor

Type: array

XML: 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:

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"
    }
]

XML_XMLLINT: Custom arguments

Type: array of string or string

XML_XMLLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

XML_XMLLINT: If set to `true`, it will reformat and reindent the output

Type: boolean Default: false

XML_XMLLINT: CLI Executable

Type: array of string Default: [["xmllint"]]

XML_XMLLINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

XML_XMLLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

XML_XMLLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"

XML_XMLLINT: Custom remove arguments

Type: array of string or string

XML_XMLLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

XML_XMLLINT: Disable errors

Type: boolean Default: false

XMLXMLLINT: If true, XMLXMLLINT doesn't make MegaLinter fail even if errors are found

XML_XMLLINT: Maximum number of errors allowed

Type: number Default: 0

XMLXMLLINT: If the number of errors found is less than this value, XMLXMLLINT doesn't make MegaLinter fail

XML_XMLLINT: Matching files extensions

Type: array of string Default: [".xml", ".xsd"]

XML_XMLLINT: 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"

XML_XMLLINT: Matching file name regexes

Type: array of string Default: []

XML_XMLLINT: 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"

XML_XMLLINT: Excluding Regex

Type: string or array of string

XML_XMLLINT: Including Regex

Type: string or array of string

XML_XMLLINT: The number of indentation spaces when `XML_XMLLINT_AUTOFORMAT` is `true`

Type: string Default: " "

XML_XMLLINT: Post-run commands

Type: array

XMLXMLLINT: Define bash commands to run after running XMLXMLLINT

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:

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"
    }
]

XML_XMLLINT: Pre-run commands

Type: array

XMLXMLLINT: Define bash commands to run before running XMLXMLLINT

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:

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"
    }
]

XML_XMLLINT: Timeout in seconds

Type: integer

XMLXMLLINT: Maximum duration in seconds of the XMLXMLLINT 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

XML_XMLLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling XML_XMLLINT and its pre/post commands

No Additional Items

Each item of this array must be:

Excluding regex filter for YAML descriptor

Type: string or array of string

YAML: Custom regex excluding filter: files matching this regex will NOT be linted

Including regex filter for YAML descriptor

Type: string or array of string

YAML: Custom regex including filter: only files matching this regex will be linted

Post commands for YAML descriptor

Type: array

YAML: 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:

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"
    }
]

YAML_PRETTIER: Custom arguments

Type: array of string or string

YAML_PRETTIER: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

YAML_PRETTIER: CLI Executable

Type: array of string Default: [["prettier"]]

YAML_PRETTIER: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

YAML_PRETTIER: CLI lint mode

Type: enum (of string) Default: "list_of_files"

YAML_PRETTIER: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

YAML_PRETTIER: Custom remove arguments

Type: array of string or string

YAML_PRETTIER: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

YAML_PRETTIER: Custom config file name

Type: string Default: ".prettierrc.json"

YAML_PRETTIER: User custom config file name if different from default

YAML_PRETTIER: Disable errors

Type: boolean Default: false

YAMLPRETTIER: If true, YAMLPRETTIER doesn't make MegaLinter fail even if errors are found

YAML_PRETTIER: Maximum number of errors allowed

Type: number Default: 0

YAMLPRETTIER: If the number of errors found is less than this value, YAMLPRETTIER doesn't make MegaLinter fail

YAML_PRETTIER: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

YAML_PRETTIER: 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"

YAML_PRETTIER: Matching file name regexes

Type: array of string Default: []

YAML_PRETTIER: 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"

YAML_PRETTIER: Excluding Regex

Type: string or array of string

YAMLPRETTIER: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with YAMLPRETTIERCLILINT_MODE = project

YAML_PRETTIER: Including Regex

Type: string or array of string

YAMLPRETTIER: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with YAMLPRETTIERCLILINT_MODE = project

YAML_PRETTIER: Forward excluded directories in project lint mode

Type: boolean Default: true

YAML_PRETTIER: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

YAML_PRETTIER: Post-run commands

Type: array

YAMLPRETTIER: Define bash commands to run after running YAMLPRETTIER

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:

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"
    }
]

YAML_PRETTIER: Pre-run commands

Type: array

YAMLPRETTIER: Define bash commands to run before running YAMLPRETTIER

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:

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"
    }
]

YAML_PRETTIER: Custom config file path

Type: string

YAML_PRETTIER: Path where to find linter configuration file

YAML_PRETTIER: Timeout in seconds

Type: integer

YAMLPRETTIER: Maximum duration in seconds of the YAMLPRETTIER 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

YAML_PRETTIER: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling YAML_PRETTIER and its pre/post commands

No Additional Items

Each item of this array must be:

Pre commands for YAML descriptor

Type: array

YAML: 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:

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"
    }
]

YAML_V8R: Custom arguments

Type: array of string or string

YAML_V8R: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

YAML_V8R: CLI Executable

Type: array of string Default: [["v8r"]]

YAML_V8R: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

YAML_V8R: CLI lint mode

Type: enum (of string) Default: "list_of_files"

YAML_V8R: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

YAML_V8R: Custom remove arguments

Type: array of string or string

YAML_V8R: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

YAML_V8R: Custom config file name

Type: string Default: ".v8rrc.yml"

YAML_V8R: User custom config file name if different from default

YAML_V8R: Disable errors

Type: boolean Default: false

YAMLV8R: If true, YAMLV8R doesn't make MegaLinter fail even if errors are found

YAML_V8R: Maximum number of errors allowed

Type: number Default: 0

YAMLV8R: If the number of errors found is less than this value, YAMLV8R doesn't make MegaLinter fail

YAML_V8R: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

YAML_V8R: 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"

YAML_V8R: Matching file name regexes

Type: array of string Default: []

YAML_V8R: 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"

YAML_V8R: Excluding Regex

Type: string or array of string

YAMLV8R: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with YAMLV8RCLILINT_MODE = project

YAML_V8R: Including Regex

Type: string or array of string

YAMLV8R: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with YAMLV8RCLILINT_MODE = project

YAML_V8R: Forward excluded directories in project lint mode

Type: boolean Default: true

YAML_V8R: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

YAML_V8R: Post-run commands

Type: array

YAMLV8R: Define bash commands to run after running YAMLV8R

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:

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"
    }
]

YAML_V8R: Pre-run commands

Type: array

YAMLV8R: Define bash commands to run before running YAMLV8R

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:

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"
    }
]

YAML_V8R: Custom config file path

Type: string

YAML_V8R: Path where to find linter configuration file

YAML_V8R: Timeout in seconds

Type: integer

YAMLV8R: Maximum duration in seconds of the YAMLV8R 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

YAML_V8R: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling YAML_V8R and its pre/post commands

No Additional Items

Each item of this array must be:

YAML_YAMLLINT: Custom arguments

Type: array of string or string

YAML_YAMLLINT: User custom arguments to add in linter CLI call

No Additional Items

Each item of this array must be:

YAML_YAMLLINT: CLI Executable

Type: array of string Default: [["yamllint"]]

YAML_YAMLLINT: Override CLI executable used to build the linter command line (rarely needed)

No Additional Items

Each item of this array must be:

YAML_YAMLLINT: CLI lint mode

Type: enum (of string) Default: "list_of_files"

YAML_YAMLLINT: Override default CLI lint mode used to call the linter (rarely needed)

Must be one of:

  • "file"
  • "list_of_files"
  • "project"

YAML_YAMLLINT: Custom remove arguments

Type: array of string or string

YAML_YAMLLINT: User custom arguments to remove before calling linter

No Additional Items

Each item of this array must be:

YAML_YAMLLINT: Custom config file name

Type: string Default: ".yamllint.yml"

YAML_YAMLLINT: User custom config file name if different from default

YAML_YAMLLINT: Disable errors

Type: boolean Default: false

YAMLYAMLLINT: If true, YAMLYAMLLINT doesn't make MegaLinter fail even if errors are found

YAML_YAMLLINT: Maximum number of errors allowed

Type: number Default: 0

YAMLYAMLLINT: If the number of errors found is less than this value, YAMLYAMLLINT doesn't make MegaLinter fail

YAML_YAMLLINT: Matching files extensions

Type: array of string Default: [".yml", ".yaml"]

YAML_YAMLLINT: 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"

YAML_YAMLLINT: Matching file name regexes

Type: array of string Default: []

YAML_YAMLLINT: 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"

YAML_YAMLLINT: Excluding Regex

Type: string or array of string

YAMLYAMLLINT: Custom regex excluding filter: files matching this regex will NOT be linted. ⚠️ Not available with YAMLYAMLLINTCLILINT_MODE = project

YAML_YAMLLINT: Including Regex

Type: string or array of string

YAMLYAMLLINT: Custom regex including filter: only files matching this regex will be linted. ⚠️ Not available with YAMLYAMLLINTCLILINT_MODE = project

YAML_YAMLLINT: Forward excluded directories in project lint mode

Type: boolean Default: true

YAML_YAMLLINT: In project CLI lint mode, forward excluded directories to the linter through its native exclusion arguments or generated ignore/config files

YAML_YAMLLINT: Post-run commands

Type: array

YAMLYAMLLINT: Define bash commands to run after running YAMLYAMLLINT

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:

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"
    }
]

YAML_YAMLLINT: Pre-run commands

Type: array

YAMLYAMLLINT: Define bash commands to run before running YAMLYAMLLINT

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:

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"
    }
]

YAML_YAMLLINT: Custom config file path

Type: string

YAML_YAMLLINT: Path where to find linter configuration file

YAML_YAMLLINT: Timeout in seconds

Type: integer

YAMLYAMLLINT: Maximum duration in seconds of the YAMLYAMLLINT 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

YAML_YAMLLINT: Unsecured env variables

Type: array of string Default: []

List of env variables explicitly not filtered before calling YAML_YAMLLINT and its pre/post commands

No Additional Items

Each item of this array must be: