From 9069721e1500c8d2055e8cd9d537a3849658f8d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edouard=20Choini=C3=A8re?= <27212526+echoix@users.noreply.github.com> Date: Tue, 17 Jan 2023 02:33:49 +0000 Subject: [PATCH 1/3] docs: Configure options of jsonschema doc --- .automation/build_schemas_doc.sh | 10 +- docs/json-schemas/configuration.html | 121026 +++++++++++++++++++++++- docs/json-schemas/descriptor.html | 7437 +- docs/json-schemas/schema_doc.min.js | 2 +- 4 files changed, 126565 insertions(+), 1910 deletions(-) diff --git a/.automation/build_schemas_doc.sh b/.automation/build_schemas_doc.sh index 85682aa46a8..91ed718d08c 100755 --- a/.automation/build_schemas_doc.sh +++ b/.automation/build_schemas_doc.sh @@ -3,7 +3,13 @@ # Generate HTML documentation from JSON schemas, using json-schema-for-humans :) generate-schema-doc ../megalinter/descriptors/schemas/megalinter-descriptor.jsonschema.json \ - ../docs/json-schemas/descriptor.html + ../docs/json-schemas/descriptor.html \ + --config minify=false \ + --config expand_buttons=false \ + --config link_to_reused_ref=false generate-schema-doc ../megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json \ - ../docs/json-schemas/configuration.html + ../docs/json-schemas/configuration.html \ + --config minify=false \ + --config expand_buttons=false \ + --config link_to_reused_ref=false diff --git a/docs/json-schemas/configuration.html b/docs/json-schemas/configuration.html index e1a3761bfd9..ec39c26b713 100644 --- a/docs/json-schemas/configuration.html +++ b/docs/json-schemas/configuration.html @@ -1,1609 +1,119417 @@ - Schema Docs
Type: object

MegaLinter configuration file

 No Additional Properties

root ACTION_ACTIONLINT_ARGUMENTS
Type: array of string or string

ACTION_ACTIONLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root ACTION_ACTIONLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root ACTION_ACTIONLINT_CONFIG_FILE
Type: string Default: "actionlint.yml"

ACTION_ACTIONLINT: User custom config file name if different from default

root ACTION_ACTIONLINT_DIRECTORY
Type: string Default: ".github/workflows"

root ACTION_ACTIONLINT_DISABLE_ERRORS
Type: boolean Default: false

root ACTION_ACTIONLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root ACTION_ACTIONLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root ACTION_ACTIONLINT_FILE_EXTENSIONS items
Type: string

root ACTION_ACTIONLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root ACTION_ACTIONLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root ACTION_ACTIONLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root ACTION_ACTIONLINT_POST_COMMANDS command_info
Type: object

Command information

root ACTION_ACTIONLINT_POST_COMMANDS Command command
Type: string

Examples:

"npm run test"
-
"echo \"This is a custom command\""
-

root ACTION_ACTIONLINT_POST_COMMANDS Command continue_if_failed
Type: boolean Default: true

root ACTION_ACTIONLINT_POST_COMMANDS Command cwd
Type: enum (of string)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
-
"workspace"
-

Example:

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

root ACTION_ACTIONLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root ACTION_ACTIONLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root ACTION_ACTIONLINT_RULES_PATH
Type: string

ACTION_ACTIONLINT: Path where to find linter configuration file

root ACTION_FILTER_REGEX_EXCLUDE
Type: string

root ACTION_FILTER_REGEX_INCLUDE
Type: string

root 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.

Each item of this array must be:

root ADDITIONAL_EXCLUDED_DIRECTORIES items
Type: string

Example:

[
-    "test"
-]
-

root ANSIBLE_ANSIBLE_LINT_ARGUMENTS
Type: array of string or string

ANSIBLEANSIBLELINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_ARGUMENTS items
Type: string

root ANSIBLE_ANSIBLE_LINT_CONFIG_FILE
Type: string Default: ".ansible-lint"

ANSIBLEANSIBLELINT: User custom config file name if different from default

root ANSIBLE_ANSIBLE_LINT_DIRECTORY
Type: string Default: "ansible"

root ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS
Type: boolean Default: false

root ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS items
Type: string

root ANSIBLE_ANSIBLE_LINT_FILE_NAME
Type: string Default: ".ansible-lint.yml"

ANSIBLEANSIBLELINT: User custom config file name if different from default

root ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root ANSIBLE_ANSIBLE_LINT_RULES_PATH
Type: string

ANSIBLEANSIBLELINT: Path where to find linter configuration file

root ANSIBLE_DIRECTORY
Type: string Default: "ansible"

root ANSIBLE_FILTER_REGEX_EXCLUDE
Type: string

root ANSIBLE_FILTER_REGEX_INCLUDE
Type: string

root APPLY_FIXES
Type: array or string Default: "none"

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

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

root ARM_ARM_TTK_ARGUMENTS
Type: array of string or string

ARMARMTTK: User custom arguments to add in linter CLI call

Each item of this array must be:

root ARM_ARM_TTK_ARGUMENTS items
Type: string

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

Must be one of:

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

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

ARMARMTTK: User custom config file name if different from default

root ARM_ARM_TTK_DISABLE_ERRORS
Type: boolean Default: false

root ARM_ARM_TTK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root ARM_ARM_TTK_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root ARM_ARM_TTK_FILE_EXTENSIONS items
Type: string

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

ARMARMTTK: User custom config file name if different from default

root ARM_ARM_TTK_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root ARM_ARM_TTK_FILE_NAMES_REGEX items
Type: string

Examples:

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

root ARM_ARM_TTK_POST_COMMANDS
Type: array

Each item of this array must be:

root ARM_ARM_TTK_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root ARM_ARM_TTK_PRE_COMMANDS
Type: array

Each item of this array must be:

root ARM_ARM_TTK_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root ARM_ARM_TTK_RULES_PATH
Type: string

ARMARMTTK: Path where to find linter configuration file

root ARM_FILTER_REGEX_EXCLUDE
Type: string

root ARM_FILTER_REGEX_INCLUDE
Type: string

root BASH_EXEC_ARGUMENTS
Type: array of string or string

BASH_EXEC: User custom arguments to add in linter CLI call

Each item of this array must be:

root BASH_EXEC_ARGUMENTS items
Type: string

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

Must be one of:

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

root BASH_EXEC_DISABLE_ERRORS
Type: boolean Default: false

root BASH_EXEC_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root BASH_EXEC_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root BASH_EXEC_FILE_EXTENSIONS items
Type: string

root BASH_EXEC_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root BASH_EXEC_FILE_NAMES_REGEX items
Type: string

Examples:

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

root BASH_EXEC_POST_COMMANDS
Type: array

Each item of this array must be:

root BASH_EXEC_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root BASH_EXEC_PRE_COMMANDS
Type: array

Each item of this array must be:

root BASH_EXEC_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root BASH_FILTER_REGEX_EXCLUDE
Type: string

root BASH_FILTER_REGEX_INCLUDE
Type: string

root BASH_SHELLCHECK_ARGUMENTS
Type: array of string or string

BASH_SHELLCHECK: User custom arguments to add in linter CLI call

Each item of this array must be:

root BASH_SHELLCHECK_ARGUMENTS items
Type: string

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

Must be one of:

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

root BASH_SHELLCHECK_DISABLE_ERRORS
Type: boolean Default: false

root BASH_SHELLCHECK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root BASH_SHELLCHECK_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root BASH_SHELLCHECK_FILE_EXTENSIONS items
Type: string

root BASH_SHELLCHECK_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root BASH_SHELLCHECK_FILE_NAMES_REGEX items
Type: string

Examples:

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

root BASH_SHELLCHECK_POST_COMMANDS
Type: array

Each item of this array must be:

root BASH_SHELLCHECK_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root BASH_SHELLCHECK_PRE_COMMANDS
Type: array

Each item of this array must be:

root BASH_SHELLCHECK_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root BASH_SHFMT_ARGUMENTS
Type: array of string or string

BASH_SHFMT: User custom arguments to add in linter CLI call

Each item of this array must be:

root BASH_SHFMT_ARGUMENTS items
Type: string

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

Must be one of:

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

root BASH_SHFMT_DISABLE_ERRORS
Type: boolean Default: false

root BASH_SHFMT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root BASH_SHFMT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root BASH_SHFMT_FILE_EXTENSIONS items
Type: string

root BASH_SHFMT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root BASH_SHFMT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root BASH_SHFMT_POST_COMMANDS
Type: array

Each item of this array must be:

root BASH_SHFMT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root BASH_SHFMT_PRE_COMMANDS
Type: array

Each item of this array must be:

root BASH_SHFMT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CLOJURE_CLJ_KONDO_ARGUMENTS
Type: array of string or string

CLOJURECLJKONDO: User custom arguments to add in linter CLI call

Each item of this array must be:

root CLOJURE_CLJ_KONDO_ARGUMENTS items
Type: string

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

Must be one of:

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

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

CLOJURECLJKONDO: User custom config file name if different from default

root CLOJURE_CLJ_KONDO_DISABLE_ERRORS
Type: boolean Default: false

root CLOJURE_CLJ_KONDO_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root CLOJURE_CLJ_KONDO_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root CLOJURE_CLJ_KONDO_FILE_EXTENSIONS items
Type: string

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

CLOJURECLJKONDO: User custom config file name if different from default

root CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX items
Type: string

Examples:

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

root CLOJURE_CLJ_KONDO_POST_COMMANDS
Type: array

Each item of this array must be:

root CLOJURE_CLJ_KONDO_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CLOJURE_CLJ_KONDO_PRE_COMMANDS
Type: array

Each item of this array must be:

root CLOJURE_CLJ_KONDO_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CLOJURE_CLJ_KONDO_RULES_PATH
Type: string

CLOJURECLJKONDO: Path where to find linter configuration file

root CLOJURE_FILTER_REGEX_EXCLUDE
Type: string

root CLOJURE_FILTER_REGEX_INCLUDE
Type: string

root CLOUDFORMATION_CFN_LINT_ARGUMENTS
Type: array of string or string

CLOUDFORMATIONCFNLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root CLOUDFORMATION_CFN_LINT_CONFIG_FILE
Type: string Default: ".cfnlintrc.yml"

CLOUDFORMATIONCFNLINT: User custom config file name if different from default

root CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS
Type: boolean Default: false

root CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS items
Type: string

root CLOUDFORMATION_CFN_LINT_FILE_NAME
Type: string Default: ".cfnlintrc.yml"

CLOUDFORMATIONCFNLINT: User custom config file name if different from default

root CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root CLOUDFORMATION_CFN_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CLOUDFORMATION_CFN_LINT_RULES_PATH
Type: string

CLOUDFORMATIONCFNLINT: Path where to find linter configuration file

root COFFEE_COFFEELINT_ARGUMENTS
Type: array of string or string

COFFEE_COFFEELINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root COFFEE_COFFEELINT_ARGUMENTS items
Type: string

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

Must be one of:

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

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

COFFEE_COFFEELINT: User custom config file name if different from default

root COFFEE_COFFEELINT_DISABLE_ERRORS
Type: boolean Default: false

root COFFEE_COFFEELINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root COFFEE_COFFEELINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root COFFEE_COFFEELINT_FILE_EXTENSIONS items
Type: string

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

COFFEE_COFFEELINT: User custom config file name if different from default

root COFFEE_COFFEELINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root COFFEE_COFFEELINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root COFFEE_COFFEELINT_POST_COMMANDS
Type: array

Each item of this array must be:

root COFFEE_COFFEELINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root COFFEE_COFFEELINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root COFFEE_COFFEELINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root COFFEE_COFFEELINT_RULES_PATH
Type: string

COFFEE_COFFEELINT: Path where to find linter configuration file

root COFFEE_FILTER_REGEX_EXCLUDE
Type: string

root COFFEE_FILTER_REGEX_INCLUDE
Type: string

root CONFIG_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

root CONFIG_REPORTER_SUB_FOLDER
Type: string Default: "IDE-config"

root CONSOLE_REPORTER
Type: boolean Default: true

root COPYPASTE_JSCPD_ARGUMENTS
Type: array of string or string

COPYPASTE_JSCPD: User custom arguments to add in linter CLI call

Each item of this array must be:

root COPYPASTE_JSCPD_ARGUMENTS items
Type: string

root COPYPASTE_JSCPD_CONFIG_FILE
Type: string Default: ".jscpd.json"

COPYPASTE_JSCPD: User custom config file name if different from default

root COPYPASTE_JSCPD_DISABLE_ERRORS
Type: boolean Default: false

root COPYPASTE_JSCPD_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root COPYPASTE_JSCPD_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root COPYPASTE_JSCPD_FILE_EXTENSIONS items
Type: string

root COPYPASTE_JSCPD_FILE_NAME
Type: string Default: ".jscpd.json"

COPYPASTE_JSCPD: User custom config file name if different from default

root COPYPASTE_JSCPD_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root COPYPASTE_JSCPD_FILE_NAMES_REGEX items
Type: string

Examples:

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

root COPYPASTE_JSCPD_POST_COMMANDS
Type: array

Each item of this array must be:

root COPYPASTE_JSCPD_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root COPYPASTE_JSCPD_PRE_COMMANDS
Type: array

Each item of this array must be:

root COPYPASTE_JSCPD_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root COPYPASTE_JSCPD_RULES_PATH
Type: string

COPYPASTE_JSCPD: Path where to find linter configuration file

root CPP_CPPLINT_ARGUMENTS
Type: array of string or string

CPP_CPPLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root CPP_CPPLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root CPP_CPPLINT_DISABLE_ERRORS
Type: boolean Default: false

root CPP_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root CPP_CPPLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root CPP_CPPLINT_FILE_EXTENSIONS items
Type: string

root CPP_CPPLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root CPP_CPPLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root CPP_CPPLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root CPP_CPPLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CPP_CPPLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root CPP_CPPLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CPP_FILTER_REGEX_EXCLUDE
Type: string

root CPP_FILTER_REGEX_INCLUDE
Type: string

root CREDENTIALS_SECRETLINT_ARGUMENTS
Type: array of string or string

CREDENTIALS_SECRETLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root CREDENTIALS_SECRETLINT_ARGUMENTS items
Type: string

root CREDENTIALS_SECRETLINT_CONFIG_FILE
Type: string Default: ".secretlintrc.json"

CREDENTIALS_SECRETLINT: User custom config file name if different from default

root CREDENTIALS_SECRETLINT_DISABLE_ERRORS
Type: boolean Default: false

root CREDENTIALS_SECRETLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root CREDENTIALS_SECRETLINT_FILE_EXTENSIONS items
Type: string

root CREDENTIALS_SECRETLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root CREDENTIALS_SECRETLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root CREDENTIALS_SECRETLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root CREDENTIALS_SECRETLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CREDENTIALS_SECRETLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root CREDENTIALS_SECRETLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CREDENTIALS_SECRETLINT_RULES_PATH
Type: string

CREDENTIALS_SECRETLINT: Path where to find linter configuration file

root CSHARP_DOTNET_FORMAT_ARGUMENTS
Type: array of string or string

CSHARPDOTNETFORMAT: User custom arguments to add in linter CLI call

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_ARGUMENTS items
Type: string

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

Must be one of:

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

root CSHARP_DOTNET_FORMAT_DISABLE_ERRORS
Type: boolean Default: false

root CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS items
Type: string

root CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root CSHARP_DOTNET_FORMAT_POST_COMMANDS
Type: array

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS
Type: array

Each item of this array must be:

root CSHARP_DOTNET_FORMAT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CSHARP_FILTER_REGEX_EXCLUDE
Type: string

root CSHARP_FILTER_REGEX_INCLUDE
Type: string

root CSS_FILTER_REGEX_EXCLUDE
Type: string

root CSS_FILTER_REGEX_INCLUDE
Type: string

root CSS_SCSS_LINT_ARGUMENTS
Type: array of string or string

CSSSCSSLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root CSS_SCSS_LINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root CSS_SCSS_LINT_CONFIG_FILE
Type: string Default: ".scss-lint.yml"

CSSSCSSLINT: User custom config file name if different from default

root CSS_SCSS_LINT_DISABLE_ERRORS
Type: boolean Default: false

root CSS_SCSS_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root CSS_SCSS_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root CSS_SCSS_LINT_FILE_EXTENSIONS items
Type: string

root CSS_SCSS_LINT_FILE_NAME
Type: string Default: ".scss-lint.yml"

CSSSCSSLINT: User custom config file name if different from default

root CSS_SCSS_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root CSS_SCSS_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root CSS_SCSS_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root CSS_SCSS_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CSS_SCSS_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root CSS_SCSS_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CSS_SCSS_LINT_RULES_PATH
Type: string

CSSSCSSLINT: Path where to find linter configuration file

root CSS_STYLELINT_ARGUMENTS
Type: array of string or string

CSS_STYLELINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root CSS_STYLELINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root CSS_STYLELINT_CONFIG_FILE
Type: string Default: ".stylelintrc.json"

CSS_STYLELINT: User custom config file name if different from default

root CSS_STYLELINT_DISABLE_ERRORS
Type: boolean Default: false

root CSS_STYLELINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root CSS_STYLELINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root CSS_STYLELINT_FILE_EXTENSIONS items
Type: string

root CSS_STYLELINT_FILE_NAME
Type: string Default: ".stylelintrc.json"

CSS_STYLELINT: User custom config file name if different from default

root CSS_STYLELINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root CSS_STYLELINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root CSS_STYLELINT_POST_COMMANDS
Type: array

Each item of this array must be:

root CSS_STYLELINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CSS_STYLELINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root CSS_STYLELINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root CSS_STYLELINT_RULES_PATH
Type: string

CSS_STYLELINT: Path where to find linter configuration file

root C_CPPLINT_ARGUMENTS
Type: array of string or string

C_CPPLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root C_CPPLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root C_CPPLINT_DISABLE_ERRORS
Type: boolean Default: false

root C_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root C_CPPLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root C_CPPLINT_FILE_EXTENSIONS items
Type: string

root C_CPPLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root C_CPPLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root C_CPPLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root C_CPPLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root C_CPPLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root C_CPPLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root C_FILTER_REGEX_EXCLUDE
Type: string

root C_FILTER_REGEX_INCLUDE
Type: string

root DART_DARTANALYZER_ARGUMENTS
Type: array of string or string

DART_DARTANALYZER: User custom arguments to add in linter CLI call

Each item of this array must be:

root DART_DARTANALYZER_ARGUMENTS items
Type: string

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

Must be one of:

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

root DART_DARTANALYZER_CONFIG_FILE
Type: string Default: "analysis_options.yml"

DART_DARTANALYZER: User custom config file name if different from default

root DART_DARTANALYZER_DISABLE_ERRORS
Type: boolean Default: false

root DART_DARTANALYZER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root DART_DARTANALYZER_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root DART_DARTANALYZER_FILE_EXTENSIONS items
Type: string

root DART_DARTANALYZER_FILE_NAME
Type: string Default: "analysis_options.yml"

DART_DARTANALYZER: User custom config file name if different from default

root DART_DARTANALYZER_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root DART_DARTANALYZER_FILE_NAMES_REGEX items
Type: string

Examples:

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

root DART_DARTANALYZER_POST_COMMANDS
Type: array

Each item of this array must be:

root DART_DARTANALYZER_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root DART_DARTANALYZER_PRE_COMMANDS
Type: array

Each item of this array must be:

root DART_DARTANALYZER_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root DART_DARTANALYZER_RULES_PATH
Type: string

DART_DARTANALYZER: Path where to find linter configuration file

root DART_FILTER_REGEX_EXCLUDE
Type: string

root DART_FILTER_REGEX_INCLUDE
Type: string

root DEFAULT_BRANCH
Type: string Default: "HEAD"

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

"master"
-
"main"
-

root DEFAULT_WORKSPACE
Type: string Default: "/tmp/lint"

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

root DISABLE
Type: array

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

Each item of this array must be:

root DISABLE enum_descriptor_keys
Type: enum (of string)

Must be one of:

  • "ACTION"
  • "ANSIBLE"
  • "ARM"
  • "BASH"
  • "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"
  • "MARKDOWN"
  • "OPENAPI"
  • "PERL"
  • "PHP"
  • "POWERSHELL"
  • "PROTOBUF"
  • "PUPPET"
  • "PYTHON"
  • "R"
  • "RAKU"
  • "RST"
  • "RUBY"
  • "RUST"
  • "SALESFORCE"
  • "SCALA"
  • "SNAKEMAKE"
  • "SPELL"
  • "SQL"
  • "SWIFT"
  • "TEKTON"
  • "TERRAFORM"
  • "TSX"
  • "TYPESCRIPT"
  • "VBDOTNET"
  • "XML"
  • "YAML"

Example:

[
-    "BASH",
-    "HTML"
-]
-

root DISABLE_ERRORS
Type: boolean Default: false

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

root DISABLE_LINTERS
Type: array

If DISABLE_LINTERS is set, the listed linters will be skipped

Each item of this array must be:

root DISABLE_LINTERS enum_linter_keys
Type: enum (of string)

Must be one of:

  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "C_CPPLINT"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CPPLINT"
  • "CREDENTIALS_SECRETLINT"
  • "CSHARP_DOTNET_FORMAT"
  • "CSS_STYLELINT"
  • "CSS_SCSS_LINT"
  • "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_HTMLHINT"
  • "JAVA_CHECKSTYLE"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_STANDARD"
  • "JAVASCRIPT_PRETTIER"
  • "JSON_JSONLINT"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_V8R"
  • "JSON_PRETTIER"
  • "JSX_ESLINT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_KUBEVAL"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_BUILTIN"
  • "PHP_PHPCS"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "PHP_PHPLINT"
  • "POWERSHELL_POWERSHELL"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_PYLINT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_BANDIT"
  • "PYTHON_MYPY"
  • "R_LINTR"
  • "RAKU_RAKU"
  • "RST_RST_LINT"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_MISSPELL"
  • "SPELL_CSPELL"
  • "SQL_SQL_LINT"
  • "SQL_SQLFLUFF"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_TFLINT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_STANDARD"
  • "TYPESCRIPT_PRETTIER"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_YAMLLINT"
  • "YAML_V8R"

Example:

[
-    "BASH_BASH_SHFMT",
-    "JAVASCRIPT_STANDARD"
-]
-

root DOCKERFILE_DOCKERFILELINT_ARGUMENTS
Type: array of string or string

DOCKERFILE_DOCKERFILELINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root DOCKERFILE_DOCKERFILELINT_CONFIG_FILE
Type: string Default: ".dockerfilelintrc"

DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default

root DOCKERFILE_DOCKERFILELINT_DISABLE_ERRORS
Type: boolean Default: false

root DOCKERFILE_DOCKERFILELINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_FILE_EXTENSIONS items
Type: string

root DOCKERFILE_DOCKERFILELINT_FILE_NAME
Type: string Default: ".dockerfilelintrc"

DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default

root DOCKERFILE_DOCKERFILELINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS
Type: array

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root DOCKERFILE_DOCKERFILELINT_RULES_PATH
Type: string

DOCKERFILE_DOCKERFILELINT: Path where to find linter configuration file

root DOCKERFILE_HADOLINT_ARGUMENTS
Type: array of string or string

DOCKERFILE_HADOLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root DOCKERFILE_HADOLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root DOCKERFILE_HADOLINT_CONFIG_FILE
Type: string Default: ".hadolint.yml"

DOCKERFILE_HADOLINT: User custom config file name if different from default

root DOCKERFILE_HADOLINT_DISABLE_ERRORS
Type: boolean Default: false

root DOCKERFILE_HADOLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root DOCKERFILE_HADOLINT_FILE_EXTENSIONS items
Type: string

root DOCKERFILE_HADOLINT_FILE_NAME
Type: string Default: ".hadolint.yml"

DOCKERFILE_HADOLINT: User custom config file name if different from default

root DOCKERFILE_HADOLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root DOCKERFILE_HADOLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root DOCKERFILE_HADOLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root DOCKERFILE_HADOLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root DOCKERFILE_HADOLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root DOCKERFILE_HADOLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root DOCKERFILE_HADOLINT_RULES_PATH
Type: string

DOCKERFILE_HADOLINT: Path where to find linter configuration file

root EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS
Type: array of string or string

EDITORCONFIGEDITORCONFIGCHECKER: User custom arguments to add in linter CLI call

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS items
Type: string

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

Must be one of:

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

root EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE
Type: string Default: ".ecrc"

EDITORCONFIGEDITORCONFIGCHECKER: User custom config file name if different from default

root EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS
Type: boolean Default: false

root EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS items
Type: string

root EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAME
Type: string Default: ".ecrc"

EDITORCONFIGEDITORCONFIGCHECKER: User custom config file name if different from default

root EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX items
Type: string

Examples:

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

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS
Type: array

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS
Type: array

Each item of this array must be:

root EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root EDITORCONFIG_EDITORCONFIG_CHECKER_RULES_PATH
Type: string

EDITORCONFIGEDITORCONFIGCHECKER: Path where to find linter configuration file

root EMAIL_REPORTER
Type: boolean Default: true

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

root EMAIL_REPORTER_EMAIL
Type: string

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

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

root EMAIL_REPORTER_SEND_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

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

root EMAIL_REPORTER_SMTP_PASSWORD
Type: string

root EMAIL_REPORTER_SMTP_PORT
Type: number Default: "465"

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

root ENABLE
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

Each item of this array must be:

root ENABLE enum_descriptor_keys
Type: enum (of string)
Same definition as enum_descriptor_keys

Example:

[
-    "BASH",
-    "HTML",
-    "JAVASCRIPT"
-]
-

root ENABLE_LINTERS
Type: array

If ENABLE_LINTERS is set, only listed linters will be processed

Each item of this array must be:

root ENABLE_LINTERS enum_linter_keys
Type: enum (of string)
Same definition as enum_linter_keys

Example:

[
-    "JAVASCRIPT_ES",
-    "PYTHON_PYLINT"
-]
-

root ENV_DOTENV_LINTER_ARGUMENTS
Type: array of string or string

ENVDOTENVLINTER: User custom arguments to add in linter CLI call

Each item of this array must be:

root ENV_DOTENV_LINTER_ARGUMENTS items
Type: string

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

Must be one of:

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

root ENV_DOTENV_LINTER_DISABLE_ERRORS
Type: boolean Default: false

root ENV_DOTENV_LINTER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root ENV_DOTENV_LINTER_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root ENV_DOTENV_LINTER_FILE_EXTENSIONS items
Type: string

root ENV_DOTENV_LINTER_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root ENV_DOTENV_LINTER_FILE_NAMES_REGEX items
Type: string

Examples:

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

root ENV_DOTENV_LINTER_POST_COMMANDS
Type: array

Each item of this array must be:

root ENV_DOTENV_LINTER_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root ENV_DOTENV_LINTER_PRE_COMMANDS
Type: array

Each item of this array must be:

root ENV_DOTENV_LINTER_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root ENV_FILTER_REGEX_EXCLUDE
Type: string

root ENV_FILTER_REGEX_INCLUDE
Type: string

root ERROR_ON_MISSING_EXEC_BIT
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

root EXCLUDED_DIRECTORIES
Type: array of string

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

Each item of this array must be:

root EXCLUDED_DIRECTORIES items
Type: string

Example:

[
-    ".github",
-    "node_modules"
-]
-

root EXTENDS
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

Each item of this array must be:

root EXTENDS items
Type: string

root FAIL_IF_MISSING_LINTER_IN_FLAVOR
Type: boolean Default: false

MegaLinter fails if a linter is missing in the selected flavor

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

root FILTER_REGEX_EXCLUDE
Type: string

Regular expression defining which files will be excluded from linting
Examples:

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

root FILTER_REGEX_INCLUDE
Type: string

Regular expression defining which files will be processed by linters
Example:

"(src/)"
-

root FLAVOR_SUGGESTIONS
Type: boolean Default: true

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

root FORMATTERS_DISABLE_ERRORS
Type: boolean Default: true

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

root GHERKIN_FILTER_REGEX_EXCLUDE
Type: string

root GHERKIN_FILTER_REGEX_INCLUDE
Type: string

root GHERKIN_GHERKIN_LINT_ARGUMENTS
Type: array of string or string

GHERKINGHERKINLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root GHERKIN_GHERKIN_LINT_CONFIG_FILE
Type: string Default: ".gherkin-lintrc"

GHERKINGHERKINLINT: User custom config file name if different from default

root GHERKIN_GHERKIN_LINT_DISABLE_ERRORS
Type: boolean Default: false

root GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS items
Type: string

root GHERKIN_GHERKIN_LINT_FILE_NAME
Type: string Default: ".gherkin-lintrc"

GHERKINGHERKINLINT: User custom config file name if different from default

root GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root GHERKIN_GHERKIN_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root GHERKIN_GHERKIN_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GHERKIN_GHERKIN_LINT_RULES_PATH
Type: string

GHERKINGHERKINLINT: Path where to find linter configuration file

root GITHUB_API_URL
Type: string 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"
-

root GITHUB_COMMENT_REPORTER
Type: boolean Default: true

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

root GITHUB_SERVER_URL
Type: string Default: "https://github.com"

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

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

root GITHUB_STATUS_REPORTER
Type: boolean Default: true

Posts a status on the pull request for each processed linter

root 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

root GITLAB_ACCESS_TOKEN_MEGALINTER
Type: string Default: true

Gitlab access token with API access (can be user or project Access token)

root GITLAB_CERTIFICATE_PATH
Type: string Default: true

Path to SSL certificate if necessary

root GITLAB_COMMENT_REPORTER
Type: boolean Default: true

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

root GITLAB_CUSTOM_CERTIFICATE
Type: string Default: true

Store your SSL certificate string value in a CI env variable named GITLABCUSTOMCERTIFICATE if you want it to be copied by MegaLinter in a local certificate file that will be used by python gitlab lib

root GIT_FILTER_REGEX_EXCLUDE
Type: string

root GIT_FILTER_REGEX_INCLUDE
Type: string

root GIT_GIT_DIFF_ARGUMENTS
Type: array of string or string

GITGITDIFF: User custom arguments to add in linter CLI call

Each item of this array must be:

root GIT_GIT_DIFF_ARGUMENTS items
Type: string

root GIT_GIT_DIFF_DISABLE_ERRORS
Type: boolean Default: false

root GIT_GIT_DIFF_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root GIT_GIT_DIFF_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root GIT_GIT_DIFF_FILE_EXTENSIONS items
Type: string

root GIT_GIT_DIFF_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root GIT_GIT_DIFF_FILE_NAMES_REGEX items
Type: string

Examples:

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

root GIT_GIT_DIFF_POST_COMMANDS
Type: array

Each item of this array must be:

root GIT_GIT_DIFF_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GIT_GIT_DIFF_PRE_COMMANDS
Type: array

Each item of this array must be:

root GIT_GIT_DIFF_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GO_FILTER_REGEX_EXCLUDE
Type: string

root GO_FILTER_REGEX_INCLUDE
Type: string

root GO_GOLANGCI_LINT_ARGUMENTS
Type: array of string or string

GOGOLANGCILINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root GO_GOLANGCI_LINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root GO_GOLANGCI_LINT_CONFIG_FILE
Type: string Default: ".golangci.yml"

GOGOLANGCILINT: User custom config file name if different from default

root GO_GOLANGCI_LINT_DISABLE_ERRORS
Type: boolean Default: false

root GO_GOLANGCI_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root GO_GOLANGCI_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root GO_GOLANGCI_LINT_FILE_EXTENSIONS items
Type: string

root GO_GOLANGCI_LINT_FILE_NAME
Type: string Default: ".golangci.yml"

GOGOLANGCILINT: User custom config file name if different from default

root GO_GOLANGCI_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root GO_GOLANGCI_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root GO_GOLANGCI_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root GO_GOLANGCI_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GO_GOLANGCI_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root GO_GOLANGCI_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GO_GOLANGCI_LINT_RULES_PATH
Type: string

GOGOLANGCILINT: Path where to find linter configuration file

root GO_REVIVE_ARGUMENTS
Type: array of string or string

GO_REVIVE: User custom arguments to add in linter CLI call

Each item of this array must be:

root GO_REVIVE_ARGUMENTS items
Type: string

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

Must be one of:

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

root GO_REVIVE_CONFIG_FILE
Type: string Default: "revive.toml"

GO_REVIVE: User custom config file name if different from default

root GO_REVIVE_DISABLE_ERRORS
Type: boolean Default: false

root GO_REVIVE_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root GO_REVIVE_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root GO_REVIVE_FILE_EXTENSIONS items
Type: string

root GO_REVIVE_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root GO_REVIVE_FILE_NAMES_REGEX items
Type: string

Examples:

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

root GO_REVIVE_POST_COMMANDS
Type: array

Each item of this array must be:

root GO_REVIVE_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GO_REVIVE_PRE_COMMANDS
Type: array

Each item of this array must be:

root GO_REVIVE_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GO_REVIVE_RULES_PATH
Type: string

GO_REVIVE: Path where to find linter configuration file

root GRAPHQL_FILTER_REGEX_EXCLUDE
Type: string

root GRAPHQL_FILTER_REGEX_INCLUDE
Type: string

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS
Type: array of string or string

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom arguments to add in linter CLI call

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS items
Type: string

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

Must be one of:

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

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

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom config file name if different from default

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS
Type: boolean Default: false

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS items
Type: string

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

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom config file name if different from default

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX items
Type: string

Examples:

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

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS
Type: array

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS
Type: array

Each item of this array must be:

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GRAPHQL_GRAPHQL_SCHEMA_LINTER_RULES_PATH
Type: string

GRAPHQLGRAPHQLSCHEMA_LINTER: Path where to find linter configuration file

root GROOVY_FILTER_REGEX_EXCLUDE
Type: string

root GROOVY_FILTER_REGEX_INCLUDE
Type: string

root GROOVY_NPM_GROOVY_LINT_ARGUMENTS
Type: array of string or string

GROOVYNPMGROOVY_LINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root GROOVY_NPM_GROOVY_LINT_CONFIG_FILE
Type: string Default: ".groovylintrc.json"

GROOVYNPMGROOVY_LINT: User custom config file name if different from default

root GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS
Type: boolean Default: false

root GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS items
Type: string

root GROOVY_NPM_GROOVY_LINT_FILE_NAME
Type: string Default: ".groovylintrc.json"

GROOVYNPMGROOVY_LINT: User custom config file name if different from default

root GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root GROOVY_NPM_GROOVY_LINT_RULES_PATH
Type: string

GROOVYNPMGROOVY_LINT: Path where to find linter configuration file

root HTML_FILTER_REGEX_EXCLUDE
Type: string

root HTML_FILTER_REGEX_INCLUDE
Type: string

root HTML_HTMLHINT_ARGUMENTS
Type: array of string or string

HTML_HTMLHINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root HTML_HTMLHINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root HTML_HTMLHINT_CONFIG_FILE
Type: string Default: ".htmlhintrc"

HTML_HTMLHINT: User custom config file name if different from default

root HTML_HTMLHINT_DISABLE_ERRORS
Type: boolean Default: false

root HTML_HTMLHINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root HTML_HTMLHINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root HTML_HTMLHINT_FILE_EXTENSIONS items
Type: string

root HTML_HTMLHINT_FILE_NAME
Type: string Default: ".htmlhintrc"

HTML_HTMLHINT: User custom config file name if different from default

root HTML_HTMLHINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root HTML_HTMLHINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root HTML_HTMLHINT_POST_COMMANDS
Type: array

Each item of this array must be:

root HTML_HTMLHINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root HTML_HTMLHINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root HTML_HTMLHINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root HTML_HTMLHINT_RULES_PATH
Type: string

HTML_HTMLHINT: Path where to find linter configuration file

root IGNORE_GENERATED_FILES
Type: boolean Default: false

root IGNORE_GITIGNORED_FILES
Type: boolean Default: false

root JAVASCRIPT_DEFAULT_STYLE
Type: enum (of string)

Style of javascript formatting to apply

Must be one of:

  • "standard"
  • "prettier"

Examples:

"standard"
-
"prettier"
-

root JAVASCRIPT_ES_ARGUMENTS
Type: array of string or string

JAVASCRIPT_ES: User custom arguments to add in linter CLI call

Each item of this array must be:

root JAVASCRIPT_ES_ARGUMENTS items
Type: string

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

Must be one of:

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

root JAVASCRIPT_ES_CONFIG_FILE
Type: string Default: ".eslintrc.json"

JAVASCRIPT_ES: User custom config file name if different from default

root JAVASCRIPT_ES_DISABLE_ERRORS
Type: boolean Default: false

root JAVASCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root JAVASCRIPT_ES_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root JAVASCRIPT_ES_FILE_EXTENSIONS items
Type: string

root JAVASCRIPT_ES_FILE_NAME
Type: string Default: ".eslintrc.json"

JAVASCRIPT_ES: User custom config file name if different from default

root JAVASCRIPT_ES_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root JAVASCRIPT_ES_FILE_NAMES_REGEX items
Type: string

Examples:

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

root JAVASCRIPT_ES_POST_COMMANDS
Type: array

Each item of this array must be:

root JAVASCRIPT_ES_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JAVASCRIPT_ES_PRE_COMMANDS
Type: array

Each item of this array must be:

root JAVASCRIPT_ES_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JAVASCRIPT_ES_RULES_PATH
Type: string

JAVASCRIPT_ES: Path where to find linter configuration file

root JAVASCRIPT_PRETTIER_ARGUMENTS
Type: array of string or string

JAVASCRIPT_PRETTIER: User custom arguments to add in linter CLI call

Each item of this array must be:

root JAVASCRIPT_PRETTIER_ARGUMENTS items
Type: string

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

Must be one of:

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

root JAVASCRIPT_PRETTIER_CONFIG_FILE
Type: string Default: ".prettierrc.json"

JAVASCRIPT_PRETTIER: User custom config file name if different from default

root JAVASCRIPT_PRETTIER_DISABLE_ERRORS
Type: boolean Default: false

root JAVASCRIPT_PRETTIER_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root JAVASCRIPT_PRETTIER_FILE_EXTENSIONS items
Type: string

root JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX items
Type: string

Examples:

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

root JAVASCRIPT_PRETTIER_POST_COMMANDS
Type: array

Each item of this array must be:

root JAVASCRIPT_PRETTIER_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JAVASCRIPT_PRETTIER_PRE_COMMANDS
Type: array

Each item of this array must be:

root JAVASCRIPT_PRETTIER_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JAVASCRIPT_PRETTIER_RULES_PATH
Type: string

JAVASCRIPT_PRETTIER: Path where to find linter configuration file

root JAVASCRIPT_STANDARD_ARGUMENTS
Type: array of string or string

JAVASCRIPT_STANDARD: User custom arguments to add in linter CLI call

Each item of this array must be:

root JAVASCRIPT_STANDARD_ARGUMENTS items
Type: string

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

Must be one of:

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

root JAVASCRIPT_STANDARD_DISABLE_ERRORS
Type: boolean Default: false

root JAVASCRIPT_STANDARD_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root JAVASCRIPT_STANDARD_FILE_EXTENSIONS items
Type: string

root JAVASCRIPT_STANDARD_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root JAVASCRIPT_STANDARD_FILE_NAMES_REGEX items
Type: string

Examples:

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

root JAVASCRIPT_STANDARD_POST_COMMANDS
Type: array

Each item of this array must be:

root JAVASCRIPT_STANDARD_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JAVASCRIPT_STANDARD_PRE_COMMANDS
Type: array

Each item of this array must be:

root JAVASCRIPT_STANDARD_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JAVA_CHECKSTYLE_ARGUMENTS
Type: array of string or string

JAVA_CHECKSTYLE: User custom arguments to add in linter CLI call

Each item of this array must be:

root JAVA_CHECKSTYLE_ARGUMENTS items
Type: string

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

Must be one of:

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

root JAVA_CHECKSTYLE_CONFIG_FILE
Type: string Default: "sun_checks.xml"

JAVA_CHECKSTYLE: User custom config file name if different from default

root JAVA_CHECKSTYLE_DISABLE_ERRORS
Type: boolean Default: false

root JAVA_CHECKSTYLE_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root JAVA_CHECKSTYLE_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root JAVA_CHECKSTYLE_FILE_EXTENSIONS items
Type: string

root JAVA_CHECKSTYLE_FILE_NAME
Type: string Default: "sun_checks.xml"

JAVA_CHECKSTYLE: User custom config file name if different from default

root JAVA_CHECKSTYLE_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root JAVA_CHECKSTYLE_FILE_NAMES_REGEX items
Type: string

Examples:

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

root JAVA_CHECKSTYLE_POST_COMMANDS
Type: array

Each item of this array must be:

root JAVA_CHECKSTYLE_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JAVA_CHECKSTYLE_PRE_COMMANDS
Type: array

Each item of this array must be:

root JAVA_CHECKSTYLE_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JAVA_CHECKSTYLE_RULES_PATH
Type: string

JAVA_CHECKSTYLE: Path where to find linter configuration file

root JAVA_FILTER_REGEX_EXCLUDE
Type: string

root JAVA_FILTER_REGEX_INCLUDE
Type: string

root JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS
Type: array of string or string

JSONESLINTPLUGIN_JSONC: User custom arguments to add in linter CLI call

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS items
Type: string

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

Must be one of:

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

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

JSONESLINTPLUGIN_JSONC: User custom config file name if different from default

root JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS
Type: boolean Default: false

root JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS items
Type: string

root JSON_ESLINT_PLUGIN_JSONC_FILE_NAME
Type: string Default: ".eslintrc.json"

JSONESLINTPLUGIN_JSONC: User custom config file name if different from default

root JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX items
Type: string

Examples:

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

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS
Type: array

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS
Type: array

Each item of this array must be:

root JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JSON_ESLINT_PLUGIN_JSONC_RULES_PATH
Type: string

JSONESLINTPLUGIN_JSONC: Path where to find linter configuration file

root JSON_FILTER_REGEX_EXCLUDE
Type: string

root JSON_FILTER_REGEX_INCLUDE
Type: string

root JSON_JSONLINT_ARGUMENTS
Type: array of string or string

JSON_JSONLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root JSON_JSONLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root JSON_JSONLINT_DISABLE_ERRORS
Type: boolean Default: false

root JSON_JSONLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root JSON_JSONLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root JSON_JSONLINT_FILE_EXTENSIONS items
Type: string

root JSON_JSONLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root JSON_JSONLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root JSON_JSONLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root JSON_JSONLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JSON_JSONLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root JSON_JSONLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JSON_PRETTIER_ARGUMENTS
Type: array of string or string

JSON_PRETTIER: User custom arguments to add in linter CLI call

Each item of this array must be:

root JSON_PRETTIER_ARGUMENTS items
Type: string

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

Must be one of:

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

root JSON_PRETTIER_CONFIG_FILE
Type: string Default: ".prettierrc.json"

JSON_PRETTIER: User custom config file name if different from default

root JSON_PRETTIER_DISABLE_ERRORS
Type: boolean Default: false

root JSON_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root JSON_PRETTIER_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root JSON_PRETTIER_FILE_EXTENSIONS items
Type: string

root JSON_PRETTIER_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root JSON_PRETTIER_FILE_NAMES_REGEX items
Type: string

Examples:

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

root JSON_PRETTIER_POST_COMMANDS
Type: array

Each item of this array must be:

root JSON_PRETTIER_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JSON_PRETTIER_PRE_COMMANDS
Type: array

Each item of this array must be:

root JSON_PRETTIER_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JSON_PRETTIER_RULES_PATH
Type: string

JSON_PRETTIER: Path where to find linter configuration file

root JSON_REPORTER
Type: boolean Default: false

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

root JSON_V8R_ARGUMENTS
Type: array of string or string

JSON_V8R: User custom arguments to add in linter CLI call

Each item of this array must be:

root JSON_V8R_ARGUMENTS items
Type: string

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

Must be one of:

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

root JSON_V8R_DISABLE_ERRORS
Type: boolean Default: false

root JSON_V8R_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root JSON_V8R_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root JSON_V8R_FILE_EXTENSIONS items
Type: string

root JSON_V8R_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root JSON_V8R_FILE_NAMES_REGEX items
Type: string

Examples:

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

root JSON_V8R_POST_COMMANDS
Type: array

Each item of this array must be:

root JSON_V8R_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JSON_V8R_PRE_COMMANDS
Type: array

Each item of this array must be:

root JSON_V8R_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JSX_ESLINT_ARGUMENTS
Type: array of string or string

JSX_ESLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root JSX_ESLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root JSX_ESLINT_CONFIG_FILE
Type: string Default: ".eslintrc.json"

JSX_ESLINT: User custom config file name if different from default

root JSX_ESLINT_DISABLE_ERRORS
Type: boolean Default: false

root JSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root JSX_ESLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root JSX_ESLINT_FILE_EXTENSIONS items
Type: string

root JSX_ESLINT_FILE_NAME
Type: string Default: ".eslintrc.json"

JSX_ESLINT: User custom config file name if different from default

root JSX_ESLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root JSX_ESLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root JSX_ESLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root JSX_ESLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JSX_ESLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root JSX_ESLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root JSX_ESLINT_RULES_PATH
Type: string

JSX_ESLINT: Path where to find linter configuration file

root JSX_FILTER_REGEX_EXCLUDE
Type: string

root JSX_FILTER_REGEX_INCLUDE
Type: string

root KOTLIN_FILTER_REGEX_EXCLUDE
Type: string

root KOTLIN_FILTER_REGEX_INCLUDE
Type: string

root KOTLIN_KTLINT_ARGUMENTS
Type: array of string or string

KOTLIN_KTLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root KOTLIN_KTLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root KOTLIN_KTLINT_DISABLE_ERRORS
Type: boolean Default: false

root KOTLIN_KTLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root KOTLIN_KTLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root KOTLIN_KTLINT_FILE_EXTENSIONS items
Type: string

root KOTLIN_KTLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root KOTLIN_KTLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root KOTLIN_KTLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root KOTLIN_KTLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root KOTLIN_KTLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root KOTLIN_KTLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root KUBERNETES_DIRECTORY
Type: string

root KUBERNETES_KUBEVAL_ARGUMENTS
Type: array of string or string

KUBERNETES_KUBEVAL: User custom arguments to add in linter CLI call

Each item of this array must be:

root KUBERNETES_KUBEVAL_ARGUMENTS items
Type: string

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

Must be one of:

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

root KUBERNETES_KUBEVAL_DIRECTORY
Type: string Default: "kubernetes"

root KUBERNETES_KUBEVAL_DISABLE_ERRORS
Type: boolean Default: false

root KUBERNETES_KUBEVAL_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root KUBERNETES_KUBEVAL_FILE_EXTENSIONS items
Type: string

root KUBERNETES_KUBEVAL_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root KUBERNETES_KUBEVAL_FILE_NAMES_REGEX items
Type: string

Examples:

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

root KUBERNETES_KUBEVAL_POST_COMMANDS
Type: array

Each item of this array must be:

root KUBERNETES_KUBEVAL_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root KUBERNETES_KUBEVAL_PRE_COMMANDS
Type: array

Each item of this array must be:

root KUBERNETES_KUBEVAL_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root LATEX_CHKTEX_ARGUMENTS
Type: array of string or string

LATEX_CHKTEX: User custom arguments to add in linter CLI call

Each item of this array must be:

root LATEX_CHKTEX_ARGUMENTS items
Type: string

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

Must be one of:

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

root LATEX_CHKTEX_CONFIG_FILE
Type: string Default: ".chktexrc"

LATEX_CHKTEX: User custom config file name if different from default

root LATEX_CHKTEX_DISABLE_ERRORS
Type: boolean Default: false

root LATEX_CHKTEX_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root LATEX_CHKTEX_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root LATEX_CHKTEX_FILE_EXTENSIONS items
Type: string

root LATEX_CHKTEX_FILE_NAME
Type: string Default: ".chktexrc"

LATEX_CHKTEX: User custom config file name if different from default

root LATEX_CHKTEX_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root LATEX_CHKTEX_FILE_NAMES_REGEX items
Type: string

Examples:

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

root LATEX_CHKTEX_POST_COMMANDS
Type: array

Each item of this array must be:

root LATEX_CHKTEX_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root LATEX_CHKTEX_PRE_COMMANDS
Type: array

Each item of this array must be:

root LATEX_CHKTEX_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root LATEX_CHKTEX_RULES_PATH
Type: string

LATEX_CHKTEX: Path where to find linter configuration file

root LATEX_FILTER_REGEX_EXCLUDE
Type: string

root LATEX_FILTER_REGEX_INCLUDE
Type: string

root 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"
-

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

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

root 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"

root LUA_FILTER_REGEX_EXCLUDE
Type: string

root LUA_FILTER_REGEX_INCLUDE
Type: string

root LUA_LUACHECK_ARGUMENTS
Type: array of string or string

LUA_LUACHECK: User custom arguments to add in linter CLI call

Each item of this array must be:

root LUA_LUACHECK_ARGUMENTS items
Type: string

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

Must be one of:

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

root LUA_LUACHECK_CONFIG_FILE
Type: string Default: ".luacheckrc"

LUA_LUACHECK: User custom config file name if different from default

root LUA_LUACHECK_DISABLE_ERRORS
Type: boolean Default: false

root LUA_LUACHECK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root LUA_LUACHECK_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root LUA_LUACHECK_FILE_EXTENSIONS items
Type: string

root LUA_LUACHECK_FILE_NAME
Type: string Default: ".luacheckrc"

LUA_LUACHECK: User custom config file name if different from default

root LUA_LUACHECK_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root LUA_LUACHECK_FILE_NAMES_REGEX items
Type: string

Examples:

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

root LUA_LUACHECK_POST_COMMANDS
Type: array

Each item of this array must be:

root LUA_LUACHECK_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root LUA_LUACHECK_PRE_COMMANDS
Type: array

Each item of this array must be:

root LUA_LUACHECK_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root LUA_LUACHECK_RULES_PATH
Type: string

LUA_LUACHECK: Path where to find linter configuration file

root MARKDOWN_DEFAULT_STYLE
Type: enum (of string)

Style of markdown formatting to apply

Must be one of:

  • "markdownlint"
  • "remark-lint"

root MARKDOWN_MARKDOWNLINT_ARGUMENTS
Type: array of string or string

MARKDOWN_MARKDOWNLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root MARKDOWN_MARKDOWNLINT_CONFIG_FILE
Type: string Default: ".markdownlint.json"

MARKDOWN_MARKDOWNLINT: User custom config file name if different from default

root MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS
Type: boolean Default: false

root MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS items
Type: string

root MARKDOWN_MARKDOWNLINT_FILE_NAME
Type: string Default: ".markdownlint.json"

MARKDOWN_MARKDOWNLINT: User custom config file name if different from default

root MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root MARKDOWN_MARKDOWNLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root MARKDOWN_MARKDOWNLINT_RULES_PATH
Type: string

MARKDOWN_MARKDOWNLINT: Path where to find linter configuration file

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS
Type: array

Each item of this array must be:

root MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS
Type: array of string or string

MARKDOWNMARKDOWNTABLE_FORMATTER: User custom arguments to add in linter CLI call

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS items
Type: string

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

Must be one of:

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

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS
Type: boolean Default: false

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS items
Type: string

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX items
Type: string

Examples:

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

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS
Type: array

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS
Type: array

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_ARGUMENTS
Type: array of string

MARKDOWNMARKDOWNTABLE_PRETTIFY: User custom arguments to add in linter CLI call

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_ARGUMENTS items
Type: string

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_DISABLE_ERRORS
Type: boolean Default: false

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_EXTENSIONS items
Type: string

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_NAMES_REGEX items
Type: string

Examples:

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

root MARKDOWN_REMARK_LINT_ARGUMENTS
Type: array of string or string

MARKDOWNREMARKLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root MARKDOWN_REMARK_LINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root MARKDOWN_REMARK_LINT_CONFIG_FILE
Type: string Default: ".remarkrc"

MARKDOWNREMARKLINT: User custom config file name if different from default

root MARKDOWN_REMARK_LINT_DISABLE_ERRORS
Type: boolean Default: false

root MARKDOWN_REMARK_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root MARKDOWN_REMARK_LINT_FILE_EXTENSIONS items
Type: string

root MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root MARKDOWN_REMARK_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root MARKDOWN_REMARK_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root MARKDOWN_REMARK_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root MARKDOWN_REMARK_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root MARKDOWN_REMARK_LINT_RULES_PATH
Type: string

MARKDOWNREMARKLINT: Path where to find linter configuration file

root OPENAPI_FILTER_REGEX_EXCLUDE
Type: string

root OPENAPI_FILTER_REGEX_INCLUDE
Type: string

root OPENAPI_SPECTRAL_ARGUMENTS
Type: array of string or string

OPENAPI_SPECTRAL: User custom arguments to add in linter CLI call

Each item of this array must be:

root OPENAPI_SPECTRAL_ARGUMENTS items
Type: string

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

Must be one of:

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

root OPENAPI_SPECTRAL_CONFIG_FILE
Type: string Default: ".openapirc.yml"

OPENAPI_SPECTRAL: User custom config file name if different from default

root OPENAPI_SPECTRAL_DISABLE_ERRORS
Type: boolean Default: false

root OPENAPI_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root OPENAPI_SPECTRAL_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root OPENAPI_SPECTRAL_FILE_EXTENSIONS items
Type: string

root OPENAPI_SPECTRAL_FILE_NAME
Type: string Default: ".openapirc.yml"

OPENAPI_SPECTRAL: User custom config file name if different from default

root OPENAPI_SPECTRAL_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root OPENAPI_SPECTRAL_FILE_NAMES_REGEX items
Type: string

Examples:

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

root OPENAPI_SPECTRAL_POST_COMMANDS
Type: array

Each item of this array must be:

root OPENAPI_SPECTRAL_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root OPENAPI_SPECTRAL_PRE_COMMANDS
Type: array

Each item of this array must be:

root OPENAPI_SPECTRAL_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root OPENAPI_SPECTRAL_RULES_PATH
Type: string

OPENAPI_SPECTRAL: Path where to find linter configuration file

root PARALLEL
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

root PERL_FILTER_REGEX_EXCLUDE
Type: string

root PERL_FILTER_REGEX_INCLUDE
Type: string

root PERL_PERLCRITIC_ARGUMENTS
Type: array of string or string

PERL_PERLCRITIC: User custom arguments to add in linter CLI call

Each item of this array must be:

root PERL_PERLCRITIC_ARGUMENTS items
Type: string

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

Must be one of:

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

root PERL_PERLCRITIC_DISABLE_ERRORS
Type: boolean Default: false

root PERL_PERLCRITIC_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PERL_PERLCRITIC_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PERL_PERLCRITIC_FILE_EXTENSIONS items
Type: string

root PERL_PERLCRITIC_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PERL_PERLCRITIC_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PERL_PERLCRITIC_POST_COMMANDS
Type: array

Each item of this array must be:

root PERL_PERLCRITIC_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PERL_PERLCRITIC_PRE_COMMANDS
Type: array

Each item of this array must be:

root PERL_PERLCRITIC_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PHP_BUILTIN_ARGUMENTS
Type: array of string or string

PHP_BUILTIN: User custom arguments to add in linter CLI call

Each item of this array must be:

root PHP_BUILTIN_ARGUMENTS items
Type: string

root PHP_BUILTIN_CLI_EXECUTABLE
Type: string

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

Must be one of:

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

root PHP_BUILTIN_DISABLE_ERRORS
Type: boolean Default: false

root PHP_BUILTIN_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PHP_BUILTIN_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PHP_BUILTIN_FILE_EXTENSIONS items
Type: string

root PHP_BUILTIN_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PHP_BUILTIN_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PHP_BUILTIN_POST_COMMANDS
Type: array

Each item of this array must be:

root PHP_BUILTIN_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PHP_BUILTIN_PRE_COMMANDS
Type: array

Each item of this array must be:

root PHP_BUILTIN_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PHP_FILTER_REGEX_EXCLUDE
Type: string

root PHP_FILTER_REGEX_INCLUDE
Type: string

root PHP_PHPCS_ARGUMENTS
Type: array of string or string

PHP_PHPCS: User custom arguments to add in linter CLI call

Each item of this array must be:

root PHP_PHPCS_ARGUMENTS items
Type: string

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

Must be one of:

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

root PHP_PHPCS_CONFIG_FILE
Type: string Default: "phpcs.xml"

PHP_PHPCS: User custom config file name if different from default

root PHP_PHPCS_DISABLE_ERRORS
Type: boolean Default: false

root PHP_PHPCS_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PHP_PHPCS_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PHP_PHPCS_FILE_EXTENSIONS items
Type: string

root PHP_PHPCS_FILE_NAME
Type: string Default: "phpcs.xml"

PHP_PHPCS: User custom config file name if different from default

root PHP_PHPCS_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PHP_PHPCS_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PHP_PHPCS_POST_COMMANDS
Type: array

Each item of this array must be:

root PHP_PHPCS_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PHP_PHPCS_PRE_COMMANDS
Type: array

Each item of this array must be:

root PHP_PHPCS_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PHP_PHPCS_RULES_PATH
Type: string

PHP_PHPCS: Path where to find linter configuration file

root PHP_PHPLINT_ARGUMENTS
Type: array of string or string

PHP_PHPLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root PHP_PHPLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root PHP_PHPLINT_CONFIG_FILE
Type: string Default: ".phplint.yml"

PHP_PHPLINT: User custom config file name if different from default

root PHP_PHPLINT_DISABLE_ERRORS
Type: boolean Default: false

root PHP_PHPLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PHP_PHPLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PHP_PHPLINT_FILE_EXTENSIONS items
Type: string

root PHP_PHPLINT_FILE_NAME
Type: string Default: ".phplint.yml"

PHP_PHPLINT: User custom config file name if different from default

root PHP_PHPLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PHP_PHPLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PHP_PHPLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root PHP_PHPLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PHP_PHPLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root PHP_PHPLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PHP_PHPLINT_RULES_PATH
Type: string

PHP_PHPLINT: Path where to find linter configuration file

root PHP_PHPSTAN_ARGUMENTS
Type: array of string or string

PHP_PHPSTAN: User custom arguments to add in linter CLI call

Each item of this array must be:

root PHP_PHPSTAN_ARGUMENTS items
Type: string

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

Must be one of:

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

root PHP_PHPSTAN_CONFIG_FILE
Type: string Default: "phpstan.neon.dist"

PHP_PHPSTAN: User custom config file name if different from default

root PHP_PHPSTAN_DISABLE_ERRORS
Type: boolean Default: false

root PHP_PHPSTAN_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PHP_PHPSTAN_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PHP_PHPSTAN_FILE_EXTENSIONS items
Type: string

root PHP_PHPSTAN_FILE_NAME
Type: string Default: "phpstan.neon"

PHP_PHPSTAN: User custom config file name if different from default

root PHP_PHPSTAN_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PHP_PHPSTAN_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PHP_PHPSTAN_POST_COMMANDS
Type: array

Each item of this array must be:

root PHP_PHPSTAN_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PHP_PHPSTAN_PRE_COMMANDS
Type: array

Each item of this array must be:

root PHP_PHPSTAN_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PHP_PHPSTAN_RULES_PATH
Type: string

PHP_PHPSTAN: Path where to find linter configuration file

root PHP_PSALM_ARGUMENTS
Type: array of string or string

PHP_PSALM: User custom arguments to add in linter CLI call

Each item of this array must be:

root PHP_PSALM_ARGUMENTS items
Type: string

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

Must be one of:

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

root PHP_PSALM_CONFIG_FILE
Type: string Default: "psalm.xml"

PHP_PSALM: User custom config file name if different from default

root PHP_PSALM_DISABLE_ERRORS
Type: boolean Default: false

root PHP_PSALM_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PHP_PSALM_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PHP_PSALM_FILE_EXTENSIONS items
Type: string

root PHP_PSALM_FILE_NAME
Type: string Default: "psalm.xml"

PHP_PSALM: User custom config file name if different from default

root PHP_PSALM_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PHP_PSALM_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PHP_PSALM_POST_COMMANDS
Type: array

Each item of this array must be:

root PHP_PSALM_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PHP_PSALM_PRE_COMMANDS
Type: array

Each item of this array must be:

root PHP_PSALM_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PHP_PSALM_RULES_PATH
Type: string

PHP_PSALM: Path where to find linter configuration file

root PLUGINS
Type: array of string

List of MegaLinter plugins. URL must follow format https:///mega-linter-plugin-/**.mega-linter-descriptor.yml

Each item of this array must be:

root PLUGINS items
Type: string

Example:

[
-    "https://raw.githubusercontent.com/cookiejar/megalinter-plugin-cookiejar/master/cookietemplate.mega-linter-descriptor.yml"
-]
-

root POST_COMMANDS
Type: array Default: []

Custom bash commands to run after linters

Each item of this array must be:

root POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root POWERSHELL_POWERSHELL_ARGUMENTS
Type: array of string or string

POWERSHELL_POWERSHELL: User custom arguments to add in linter CLI call

Each item of this array must be:

root POWERSHELL_POWERSHELL_ARGUMENTS items
Type: string

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

Must be one of:

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

root POWERSHELL_POWERSHELL_CONFIG_FILE
Type: string Default: ".powershell-psscriptanalyzer.psd1"

POWERSHELL_POWERSHELL: User custom config file name if different from default

root POWERSHELL_POWERSHELL_DISABLE_ERRORS
Type: boolean Default: false

root POWERSHELL_POWERSHELL_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root POWERSHELL_POWERSHELL_FILE_EXTENSIONS items
Type: string

root POWERSHELL_POWERSHELL_FILE_NAME
Type: string Default: ".powershell-psscriptanalyzer.psd1"

POWERSHELL_POWERSHELL: User custom config file name if different from default

root POWERSHELL_POWERSHELL_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root POWERSHELL_POWERSHELL_FILE_NAMES_REGEX items
Type: string

Examples:

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

root POWERSHELL_POWERSHELL_POST_COMMANDS
Type: array

Each item of this array must be:

root POWERSHELL_POWERSHELL_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root POWERSHELL_POWERSHELL_PRE_COMMANDS
Type: array

Each item of this array must be:

root POWERSHELL_POWERSHELL_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root POWERSHELL_POWERSHELL_RULES_PATH
Type: string

POWERSHELL_POWERSHELL: Path where to find linter configuration file

root PRE_COMMANDS
Type: array Default: []

Custom bash commands to run before linters

Each item of this array must be:

root PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

[
-    {
-        "command": "npm install java-caller",
-        "continue_if_failed": false,
-        "cwd": "root"
-    },
-    {
-        "command": "echo \"pre-run command has been called\"",
-        "cwd": "workspace"
-    }
-]
-

root PROTOBUF_PROTOLINT_ARGUMENTS
Type: array of string or string

PROTOBUF_PROTOLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root PROTOBUF_PROTOLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root PROTOBUF_PROTOLINT_CONFIG_FILE
Type: string Default: ".protolintrc.yml"

PROTOBUF_PROTOLINT: User custom config file name if different from default

root PROTOBUF_PROTOLINT_DISABLE_ERRORS
Type: boolean Default: false

root PROTOBUF_PROTOLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PROTOBUF_PROTOLINT_FILE_EXTENSIONS items
Type: string

root PROTOBUF_PROTOLINT_FILE_NAME
Type: string Default: ".protolintrc.yml"

PROTOBUF_PROTOLINT: User custom config file name if different from default

root PROTOBUF_PROTOLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PROTOBUF_PROTOLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PROTOBUF_PROTOLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root PROTOBUF_PROTOLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PROTOBUF_PROTOLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root PROTOBUF_PROTOLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PROTOBUF_PROTOLINT_RULES_PATH
Type: string

PROTOBUF_PROTOLINT: Path where to find linter configuration file

root PUPPET_FILTER_REGEX_EXCLUDE
Type: string

root PUPPET_FILTER_REGEX_INCLUDE
Type: string

root PUPPET_PUPPET_LINT_ARGUMENTS
Type: array of string or string

PUPPETPUPPETLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root PUPPET_PUPPET_LINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root PUPPET_PUPPET_LINT_CONFIG_FILE
Type: string Default: ".puppet-lint.rc"

PUPPETPUPPETLINT: User custom config file name if different from default

root PUPPET_PUPPET_LINT_DISABLE_ERRORS
Type: boolean Default: false

root PUPPET_PUPPET_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PUPPET_PUPPET_LINT_FILE_EXTENSIONS items
Type: string

root PUPPET_PUPPET_LINT_FILE_NAME
Type: string Default: ".puppet-lint.rc"

PUPPETPUPPETLINT: User custom config file name if different from default

root PUPPET_PUPPET_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PUPPET_PUPPET_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PUPPET_PUPPET_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root PUPPET_PUPPET_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PUPPET_PUPPET_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root PUPPET_PUPPET_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PUPPET_PUPPET_LINT_RULES_PATH
Type: string

PUPPETPUPPETLINT: Path where to find linter configuration file

root PYTHON_BANDIT_ARGUMENTS
Type: array of string or string

PYTHON_BANDIT: User custom arguments to add in linter CLI call

Each item of this array must be:

root PYTHON_BANDIT_ARGUMENTS items
Type: string

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

Must be one of:

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

root PYTHON_BANDIT_CONFIG_FILE
Type: string Default: ".bandit.yml"

PYTHON_BANDIT: User custom config file name if different from default

root PYTHON_BANDIT_DISABLE_ERRORS
Type: boolean Default: false

root PYTHON_BANDIT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PYTHON_BANDIT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PYTHON_BANDIT_FILE_EXTENSIONS items
Type: string

root PYTHON_BANDIT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PYTHON_BANDIT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PYTHON_BANDIT_POST_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_BANDIT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_BANDIT_PRE_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_BANDIT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_BANDIT_RULES_PATH
Type: string

PYTHON_BANDIT: Path where to find linter configuration file

root PYTHON_BLACK_ARGUMENTS
Type: array of string or string

PYTHON_BLACK: User custom arguments to add in linter CLI call

Each item of this array must be:

root PYTHON_BLACK_ARGUMENTS items
Type: string

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

Must be one of:

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

root PYTHON_BLACK_CONFIG_FILE
Type: string Default: "pyproject.toml"

PYTHON_BLACK: User custom config file name if different from default

root PYTHON_BLACK_DISABLE_ERRORS
Type: boolean Default: false

root PYTHON_BLACK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PYTHON_BLACK_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PYTHON_BLACK_FILE_EXTENSIONS items
Type: string

root PYTHON_BLACK_FILE_NAME
Type: string Default: ".python-black"

PYTHON_BLACK: User custom config file name if different from default

root PYTHON_BLACK_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PYTHON_BLACK_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PYTHON_BLACK_POST_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_BLACK_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_BLACK_PRE_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_BLACK_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_BLACK_RULES_PATH
Type: string

PYTHON_BLACK: Path where to find linter configuration file

root PYTHON_FILTER_REGEX_EXCLUDE
Type: string

root PYTHON_FILTER_REGEX_INCLUDE
Type: string

root PYTHON_FLAKE8_ARGUMENTS
Type: array of string or string

PYTHON_FLAKE8: User custom arguments to add in linter CLI call

Each item of this array must be:

root PYTHON_FLAKE8_ARGUMENTS items
Type: string

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

Must be one of:

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

root PYTHON_FLAKE8_CONFIG_FILE
Type: string Default: ".flake8"

PYTHON_FLAKE8: User custom config file name if different from default

root PYTHON_FLAKE8_DISABLE_ERRORS
Type: boolean Default: false

root PYTHON_FLAKE8_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PYTHON_FLAKE8_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PYTHON_FLAKE8_FILE_EXTENSIONS items
Type: string

root PYTHON_FLAKE8_FILE_NAME
Type: string Default: ".flake8"

PYTHON_FLAKE8: User custom config file name if different from default

root PYTHON_FLAKE8_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PYTHON_FLAKE8_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PYTHON_FLAKE8_POST_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_FLAKE8_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_FLAKE8_PRE_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_FLAKE8_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_FLAKE8_RULES_PATH
Type: string

PYTHON_FLAKE8: Path where to find linter configuration file

root PYTHON_ISORT_ARGUMENTS
Type: array of string or string

PYTHON_ISORT: User custom arguments to add in linter CLI call

Each item of this array must be:

root PYTHON_ISORT_ARGUMENTS items
Type: string

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

Must be one of:

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

root PYTHON_ISORT_CONFIG_FILE
Type: string Default: ".isort.cfg"

PYTHON_ISORT: User custom config file name if different from default

root PYTHON_ISORT_DISABLE_ERRORS
Type: boolean Default: false

root PYTHON_ISORT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PYTHON_ISORT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PYTHON_ISORT_FILE_EXTENSIONS items
Type: string

root PYTHON_ISORT_FILE_NAME
Type: string Default: ".isort.cfg"

PYTHON_ISORT: User custom config file name if different from default

root PYTHON_ISORT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PYTHON_ISORT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PYTHON_ISORT_POST_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_ISORT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_ISORT_PRE_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_ISORT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_ISORT_RULES_PATH
Type: string

PYTHON_ISORT: Path where to find linter configuration file

root PYTHON_MYPY_ARGUMENTS
Type: array of string or string

PYTHON_MYPY: User custom arguments to add in linter CLI call

Each item of this array must be:

root PYTHON_MYPY_ARGUMENTS items
Type: string

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

Must be one of:

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

root PYTHON_MYPY_CONFIG_FILE
Type: string Default: ".mypy.ini"

PYTHON_MYPY: User custom config file name if different from default

root PYTHON_MYPY_DISABLE_ERRORS
Type: boolean Default: false

root PYTHON_MYPY_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PYTHON_MYPY_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PYTHON_MYPY_FILE_EXTENSIONS items
Type: string

root PYTHON_MYPY_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PYTHON_MYPY_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PYTHON_MYPY_POST_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_MYPY_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_MYPY_PRE_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_MYPY_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_MYPY_RULES_PATH
Type: string

PYTHON_MYPY: Path where to find linter configuration file

root PYTHON_PYLINT_ARGUMENTS
Type: array of string or string

PYTHON_PYLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root PYTHON_PYLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root PYTHON_PYLINT_CONFIG_FILE
Type: string Default: ".python-lint"

PYTHON_PYLINT: User custom config file name if different from default

root PYTHON_PYLINT_DISABLE_ERRORS
Type: boolean Default: false

root PYTHON_PYLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root PYTHON_PYLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root PYTHON_PYLINT_FILE_EXTENSIONS items
Type: string

root PYTHON_PYLINT_FILE_NAME
Type: string Default: ".python-lint"

PYTHON_PYLINT: User custom config file name if different from default

root PYTHON_PYLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root PYTHON_PYLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root PYTHON_PYLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_PYLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_PYLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root PYTHON_PYLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root PYTHON_PYLINT_RULES_PATH
Type: string

PYTHON_PYLINT: Path where to find linter configuration file

root RAKU_FILTER_REGEX_EXCLUDE
Type: string

root RAKU_FILTER_REGEX_INCLUDE
Type: string

root RAKU_RAKU_ARGUMENTS
Type: array of string or string

RAKU_RAKU: User custom arguments to add in linter CLI call

Each item of this array must be:

root RAKU_RAKU_ARGUMENTS items
Type: string

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

Must be one of:

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

root RAKU_RAKU_CONFIG_FILE
Type: string Default: "META6.json"

RAKU_RAKU: User custom config file name if different from default

root RAKU_RAKU_DISABLE_ERRORS
Type: boolean Default: false

root RAKU_RAKU_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root RAKU_RAKU_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root RAKU_RAKU_FILE_EXTENSIONS items
Type: string

root RAKU_RAKU_FILE_NAME
Type: string Default: "META6.json"

RAKU_RAKU: User custom config file name if different from default

root RAKU_RAKU_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root RAKU_RAKU_FILE_NAMES_REGEX items
Type: string

Examples:

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

root RAKU_RAKU_POST_COMMANDS
Type: array

Each item of this array must be:

root RAKU_RAKU_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RAKU_RAKU_PRE_COMMANDS
Type: array

Each item of this array must be:

root RAKU_RAKU_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RAKU_RAKU_RULES_PATH
Type: string

RAKU_RAKU: Path where to find linter configuration file

root REPORT_OUTPUT_FOLDER
Type: string Default: "report"

The location where the output reporting will be generated to

root RST_FILTER_REGEX_EXCLUDE
Type: string

root RST_FILTER_REGEX_INCLUDE
Type: string

root RST_RSTCHECK_ARGUMENTS
Type: array of string or string

RST_RSTCHECK: User custom arguments to add in linter CLI call

Each item of this array must be:

root RST_RSTCHECK_ARGUMENTS items
Type: string

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

Must be one of:

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

root RST_RSTCHECK_CONFIG_FILE
Type: string Default: ".rstcheck.cfg"

RST_RSTCHECK: User custom config file name if different from default

root RST_RSTCHECK_DISABLE_ERRORS
Type: boolean Default: false

root RST_RSTCHECK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root RST_RSTCHECK_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root RST_RSTCHECK_FILE_EXTENSIONS items
Type: string

root RST_RSTCHECK_FILE_NAME
Type: string Default: ".rstcheck.cfg"

RST_RSTCHECK: User custom config file name if different from default

root RST_RSTCHECK_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root RST_RSTCHECK_FILE_NAMES_REGEX items
Type: string

Examples:

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

root RST_RSTCHECK_POST_COMMANDS
Type: array

Each item of this array must be:

root RST_RSTCHECK_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RST_RSTCHECK_PRE_COMMANDS
Type: array

Each item of this array must be:

root RST_RSTCHECK_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RST_RSTCHECK_RULES_PATH
Type: string

RST_RSTCHECK: Path where to find linter configuration file

root RST_RSTFMT_ARGUMENTS
Type: array of string or string

RST_RSTFMT: User custom arguments to add in linter CLI call

Each item of this array must be:

root RST_RSTFMT_ARGUMENTS items
Type: string

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

Must be one of:

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

root RST_RSTFMT_DISABLE_ERRORS
Type: boolean Default: false

root RST_RSTFMT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root RST_RSTFMT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root RST_RSTFMT_FILE_EXTENSIONS items
Type: string

root RST_RSTFMT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root RST_RSTFMT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root RST_RSTFMT_POST_COMMANDS
Type: array

Each item of this array must be:

root RST_RSTFMT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RST_RSTFMT_PRE_COMMANDS
Type: array

Each item of this array must be:

root RST_RSTFMT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RST_RST_LINT_ARGUMENTS
Type: array of string or string

RSTRSTLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root RST_RST_LINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root RST_RST_LINT_DISABLE_ERRORS
Type: boolean Default: false

root RST_RST_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root RST_RST_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root RST_RST_LINT_FILE_EXTENSIONS items
Type: string

root RST_RST_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root RST_RST_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root RST_RST_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root RST_RST_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RST_RST_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root RST_RST_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RUBY_FILTER_REGEX_EXCLUDE
Type: string

root RUBY_FILTER_REGEX_INCLUDE
Type: string

root RUBY_RUBOCOP_ARGUMENTS
Type: array of string or string

RUBY_RUBOCOP: User custom arguments to add in linter CLI call

Each item of this array must be:

root RUBY_RUBOCOP_ARGUMENTS items
Type: string

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

Must be one of:

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

root RUBY_RUBOCOP_CONFIG_FILE
Type: string Default: ".ruby-lint.yml"

RUBY_RUBOCOP: User custom config file name if different from default

root RUBY_RUBOCOP_DISABLE_ERRORS
Type: boolean Default: false

root RUBY_RUBOCOP_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root RUBY_RUBOCOP_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root RUBY_RUBOCOP_FILE_EXTENSIONS items
Type: string

root RUBY_RUBOCOP_FILE_NAME
Type: string Default: ".ruby-lint.yml"

RUBY_RUBOCOP: User custom config file name if different from default

root RUBY_RUBOCOP_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root RUBY_RUBOCOP_FILE_NAMES_REGEX items
Type: string

Examples:

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

root RUBY_RUBOCOP_POST_COMMANDS
Type: array

Each item of this array must be:

root RUBY_RUBOCOP_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RUBY_RUBOCOP_PRE_COMMANDS
Type: array

Each item of this array must be:

root RUBY_RUBOCOP_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RUBY_RUBOCOP_RULES_PATH
Type: string

RUBY_RUBOCOP: Path where to find linter configuration file

root RUST_CLIPPY_ARGUMENTS
Type: array of string or string

RUST_CLIPPY: User custom arguments to add in linter CLI call

Each item of this array must be:

root RUST_CLIPPY_ARGUMENTS items
Type: string

root RUST_CLIPPY_CONFIG_FILE
Type: string Default: ".clippy.toml"

RUST_CLIPPY: User custom config file name if different from default

root RUST_CLIPPY_DISABLE_ERRORS
Type: boolean Default: false

root RUST_CLIPPY_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root RUST_CLIPPY_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root RUST_CLIPPY_FILE_EXTENSIONS items
Type: string

root RUST_CLIPPY_FILE_NAME
Type: string Default: ".clippy.toml"

RUST_CLIPPY: User custom config file name if different from default

root RUST_CLIPPY_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root RUST_CLIPPY_FILE_NAMES_REGEX items
Type: string

Examples:

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

root RUST_CLIPPY_POST_COMMANDS
Type: array

Each item of this array must be:

root RUST_CLIPPY_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RUST_CLIPPY_PRE_COMMANDS
Type: array

Each item of this array must be:

root RUST_CLIPPY_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root RUST_CLIPPY_RULES_PATH
Type: string

RUST_CLIPPY: Path where to find linter configuration file

root RUST_FILTER_REGEX_EXCLUDE
Type: string

root RUST_FILTER_REGEX_INCLUDE
Type: string

root R_FILTER_REGEX_EXCLUDE
Type: string

root R_FILTER_REGEX_INCLUDE
Type: string

root R_LINTR_ARGUMENTS
Type: array of string or string

R_LINTR: User custom arguments to add in linter CLI call

Each item of this array must be:

root R_LINTR_ARGUMENTS items
Type: string

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

Must be one of:

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

root R_LINTR_CONFIG_FILE
Type: string Default: ".lintr"

R_LINTR: User custom config file name if different from default

root R_LINTR_DISABLE_ERRORS
Type: boolean Default: false

root R_LINTR_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root R_LINTR_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root R_LINTR_FILE_EXTENSIONS items
Type: string

root R_LINTR_FILE_NAME
Type: string Default: ".lintr"

R_LINTR: User custom config file name if different from default

root R_LINTR_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root R_LINTR_FILE_NAMES_REGEX items
Type: string

Examples:

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

root R_LINTR_FILTER_REGEX_EXCLUDE
Type: string

root R_LINTR_FILTER_REGEX_INCLUDE
Type: string

root R_LINTR_POST_COMMANDS
Type: array

Each item of this array must be:

root R_LINTR_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root R_LINTR_PRE_COMMANDS
Type: array

Each item of this array must be:

root R_LINTR_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root R_LINTR_RULES_PATH
Type: string

R_LINTR: Path where to find linter configuration file

root SALESFORCE_DIRECTORY
Type: string Default: "force-app"

root SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS
Type: array of string or string

SALESFORCESFDXSCANNER_APEX: User custom arguments to add in linter CLI call

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS items
Type: string

root SALESFORCE_SFDX_SCANNER_APEX_CONFIG_FILE
Type: string Default: "apex-pmd-ruleset.xml"

SALESFORCESFDXSCANNER_APEX: User custom config file name if different from default

root SALESFORCE_SFDX_SCANNER_APEX_DIRECTORY
Type: string Default: "force-app"

root SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS
Type: boolean Default: false

root SALESFORCE_SFDX_SCANNER_APEX_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_FILE_EXTENSIONS items
Type: string

root SALESFORCE_SFDX_SCANNER_APEX_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS
Type: array

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS
Type: array

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SALESFORCE_SFDX_SCANNER_APEX_RULES_PATH
Type: string

SALESFORCESFDXSCANNER_APEX: Path where to find linter configuration file

root SALESFORCE_SFDX_SCANNER_ARGUMENTS
Type: array of string or string

SALESFORCESFDXSCANNER: User custom arguments to add in linter CLI call

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_ARGUMENTS items
Type: string

root SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS
Type: array of string or string

SALESFORCESFDXSCANNER_AURA: User custom arguments to add in linter CLI call

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS items
Type: string

root SALESFORCE_SFDX_SCANNER_AURA_CONFIG_FILE
Type: string Default: "--eslintconfig"

SALESFORCESFDXSCANNER_AURA: User custom config file name if different from default

root SALESFORCE_SFDX_SCANNER_AURA_DIRECTORY
Type: string Default: "force-app"

root SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS
Type: boolean Default: false

root SALESFORCE_SFDX_SCANNER_AURA_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_FILE_EXTENSIONS items
Type: string

root SALESFORCE_SFDX_SCANNER_AURA_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS
Type: array

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS
Type: array

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SALESFORCE_SFDX_SCANNER_AURA_RULES_PATH
Type: string

SALESFORCESFDXSCANNER_AURA: Path where to find linter configuration file

root SALESFORCE_SFDX_SCANNER_DIRECTORY
Type: string Default: "force-app"

root SALESFORCE_SFDX_SCANNER_DISABLE_ERRORS
Type: boolean Default: false

root SALESFORCE_SFDX_SCANNER_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_FILE_EXTENSIONS items
Type: string

root SALESFORCE_SFDX_SCANNER_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS
Type: array of string or string

SALESFORCESFDXSCANNER_LWC: User custom arguments to add in linter CLI call

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS items
Type: string

root SALESFORCE_SFDX_SCANNER_LWC_CONFIG_FILE
Type: string Default: "--eslintconfig"

SALESFORCESFDXSCANNER_LWC: User custom config file name if different from default

root SALESFORCE_SFDX_SCANNER_LWC_DIRECTORY
Type: string Default: "force-app"

root SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS
Type: boolean Default: false

root SALESFORCE_SFDX_SCANNER_LWC_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_FILE_EXTENSIONS items
Type: string

root SALESFORCE_SFDX_SCANNER_LWC_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS
Type: array

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS
Type: array

Each item of this array must be:

root SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SALESFORCE_SFDX_SCANNER_LWC_RULES_PATH
Type: string

SALESFORCESFDXSCANNER_LWC: Path where to find linter configuration file

root SCALA_FILTER_REGEX_EXCLUDE
Type: string

root SCALA_FILTER_REGEX_INCLUDE
Type: string

root SCALA_SCALAFIX_ARGUMENTS
Type: array of string or string

SCALA_SCALAFIX: User custom arguments to add in linter CLI call

Each item of this array must be:

root SCALA_SCALAFIX_ARGUMENTS items
Type: string

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

Must be one of:

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

root SCALA_SCALAFIX_CONFIG_FILE
Type: string Default: ".scalafix.conf"

SCALA_SCALAFIX: User custom config file name if different from default

root SCALA_SCALAFIX_DISABLE_ERRORS
Type: boolean Default: false

root SCALA_SCALAFIX_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root SCALA_SCALAFIX_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SCALA_SCALAFIX_FILE_EXTENSIONS items
Type: string

root SCALA_SCALAFIX_FILE_NAME
Type: string Default: ".scalafix.conf"

SCALA_SCALAFIX: User custom config file name if different from default

root SCALA_SCALAFIX_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SCALA_SCALAFIX_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SCALA_SCALAFIX_POST_COMMANDS
Type: array

Each item of this array must be:

root SCALA_SCALAFIX_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SCALA_SCALAFIX_PRE_COMMANDS
Type: array

Each item of this array must be:

root SCALA_SCALAFIX_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SCALA_SCALAFIX_RULES_PATH
Type: string

SCALA_SCALAFIX: Path where to find linter configuration file

root SHOW_ELAPSED_TIME
Type: boolean Default: false

Displays elapsed time for each linter in reports

root SHOW_SKIPPED_LINTERS
Type: boolean Default: true

Displays all linters that mega-linter could run but didn't

root SNAKEMAKE_LINT_ARGUMENTS
Type: array of string or string

SNAKEMAKE_LINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root SNAKEMAKE_LINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root SNAKEMAKE_LINT_DISABLE_ERRORS
Type: boolean Default: false

root SNAKEMAKE_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root SNAKEMAKE_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SNAKEMAKE_LINT_FILE_EXTENSIONS items
Type: string

root SNAKEMAKE_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SNAKEMAKE_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SNAKEMAKE_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root SNAKEMAKE_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SNAKEMAKE_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root SNAKEMAKE_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SNAKEMAKE_SNAKEFMT_ARGUMENTS
Type: array of string or string

SNAKEMAKE_SNAKEFMT: User custom arguments to add in linter CLI call

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_ARGUMENTS items
Type: string

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

Must be one of:

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

root SNAKEMAKE_SNAKEFMT_CONFIG_FILE
Type: string Default: ".snakefmt.toml"

SNAKEMAKE_SNAKEFMT: User custom config file name if different from default

root SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS
Type: boolean Default: false

root SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS items
Type: string

root SNAKEMAKE_SNAKEFMT_FILE_NAME
Type: string Default: ".snakefmt.toml"

SNAKEMAKE_SNAKEFMT: User custom config file name if different from default

root SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS
Type: array

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS
Type: array

Each item of this array must be:

root SNAKEMAKE_SNAKEFMT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SNAKEMAKE_SNAKEFMT_RULES_PATH
Type: string

SNAKEMAKE_SNAKEFMT: Path where to find linter configuration file

root SPELL_CSPELL_ARGUMENTS
Type: array of string or string

SPELL_CSPELL: User custom arguments to add in linter CLI call

Each item of this array must be:

root SPELL_CSPELL_ARGUMENTS items
Type: string

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

Must be one of:

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

root SPELL_CSPELL_CONFIG_FILE
Type: string Default: ".cspell.json"

SPELL_CSPELL: User custom config file name if different from default

root SPELL_CSPELL_DISABLE_ERRORS
Type: boolean Default: false

root SPELL_CSPELL_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root SPELL_CSPELL_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SPELL_CSPELL_FILE_EXTENSIONS items
Type: string

root SPELL_CSPELL_FILE_NAME
Type: string Default: ".cspell.json"

SPELL_CSPELL: User custom config file name if different from default

root SPELL_CSPELL_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SPELL_CSPELL_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SPELL_CSPELL_POST_COMMANDS
Type: array

Each item of this array must be:

root SPELL_CSPELL_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SPELL_CSPELL_PRE_COMMANDS
Type: array

Each item of this array must be:

root SPELL_CSPELL_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SPELL_CSPELL_RULES_PATH
Type: string

SPELL_CSPELL: Path where to find linter configuration file

root SPELL_FILTER_REGEX_EXCLUDE
Type: string

root SPELL_FILTER_REGEX_INCLUDE
Type: string

root SPELL_MISSPELL_ARGUMENTS
Type: array of string or string

SPELL_MISSPELL: User custom arguments to add in linter CLI call

Each item of this array must be:

root SPELL_MISSPELL_ARGUMENTS items
Type: string

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

Must be one of:

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

root SPELL_MISSPELL_DISABLE_ERRORS
Type: boolean Default: false

root SPELL_MISSPELL_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root SPELL_MISSPELL_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SPELL_MISSPELL_FILE_EXTENSIONS items
Type: string

root SPELL_MISSPELL_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SPELL_MISSPELL_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SPELL_MISSPELL_POST_COMMANDS
Type: array

Each item of this array must be:

root SPELL_MISSPELL_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SPELL_MISSPELL_PRE_COMMANDS
Type: array

Each item of this array must be:

root SPELL_MISSPELL_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SQL_FILTER_REGEX_EXCLUDE
Type: string

root SQL_FILTER_REGEX_INCLUDE
Type: string

root SQL_SQLFLUFF_ARGUMENTS
Type: array of string or string

SQL_SQLFLUFF: User custom arguments to add in linter CLI call

Each item of this array must be:

root SQL_SQLFLUFF_ARGUMENTS items
Type: string

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

Must be one of:

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

root SQL_SQLFLUFF_CONFIG_FILE
Type: string Default: ".sqlfluff"

SQL_SQLFLUFF: User custom config file name if different from default

root SQL_SQLFLUFF_DISABLE_ERRORS
Type: boolean Default: false

root SQL_SQLFLUFF_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root SQL_SQLFLUFF_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SQL_SQLFLUFF_FILE_EXTENSIONS items
Type: string

root SQL_SQLFLUFF_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SQL_SQLFLUFF_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SQL_SQLFLUFF_POST_COMMANDS
Type: array

Each item of this array must be:

root SQL_SQLFLUFF_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SQL_SQLFLUFF_PRE_COMMANDS
Type: array

Each item of this array must be:

root SQL_SQLFLUFF_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SQL_SQLFLUFF_RULES_PATH
Type: string

SQL_SQLFLUFF: Path where to find linter configuration file

root SQL_SQL_LINT_ARGUMENTS
Type: array of string or string

SQLSQLLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root SQL_SQL_LINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root SQL_SQL_LINT_CONFIG_FILE
Type: string Default: ".sql-config.json"

SQLSQLLINT: User custom config file name if different from default

root SQL_SQL_LINT_DISABLE_ERRORS
Type: boolean Default: false

root SQL_SQL_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root SQL_SQL_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SQL_SQL_LINT_FILE_EXTENSIONS items
Type: string

root SQL_SQL_LINT_FILE_NAME
Type: string Default: ".sql-config.json"

SQLSQLLINT: User custom config file name if different from default

root SQL_SQL_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SQL_SQL_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SQL_SQL_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root SQL_SQL_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SQL_SQL_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root SQL_SQL_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SQL_SQL_LINT_RULES_PATH
Type: string

SQLSQLLINT: Path where to find linter configuration file

root SQL_TSQLLINT_ARGUMENTS
Type: array of string or string

SQL_TSQLLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root SQL_TSQLLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root SQL_TSQLLINT_CONFIG_FILE
Type: string Default: ".tsqllintrc"

SQL_TSQLLINT: User custom config file name if different from default

root SQL_TSQLLINT_DISABLE_ERRORS
Type: boolean Default: false

root SQL_TSQLLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root SQL_TSQLLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SQL_TSQLLINT_FILE_EXTENSIONS items
Type: string

root SQL_TSQLLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SQL_TSQLLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SQL_TSQLLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root SQL_TSQLLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SQL_TSQLLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root SQL_TSQLLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SQL_TSQLLINT_RULES_PATH
Type: string

SQL_TSQLLINT: Path where to find linter configuration file

root SWIFT_FILTER_REGEX_EXCLUDE
Type: string

root SWIFT_FILTER_REGEX_INCLUDE
Type: string

root SWIFT_SWIFTLINT_ARGUMENTS
Type: array of string or string

SWIFT_SWIFTLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root SWIFT_SWIFTLINT_ARGUMENTS items
Type: string

root SWIFT_SWIFTLINT_CONFIG_FILE
Type: string Default: ".swiftlint.yml"

SWIFT_SWIFTLINT: User custom config file name if different from default

root SWIFT_SWIFTLINT_DISABLE_ERRORS
Type: boolean Default: false

root SWIFT_SWIFTLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root SWIFT_SWIFTLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root SWIFT_SWIFTLINT_FILE_EXTENSIONS items
Type: string

root SWIFT_SWIFTLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root SWIFT_SWIFTLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root SWIFT_SWIFTLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root SWIFT_SWIFTLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SWIFT_SWIFTLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root SWIFT_SWIFTLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root SWIFT_SWIFTLINT_RULES_PATH
Type: string

SWIFT_SWIFTLINT: Path where to find linter configuration file

root TAP_REPORTER
Type: boolean Default: false

General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter

root TAP_REPORTER_SUB_FOLDER
Type: string Default: "tap"

Sub-folder of reports folder containing TAP logs

root TEKTON_FILTER_REGEX_EXCLUDE
Type: string

root TEKTON_FILTER_REGEX_INCLUDE
Type: string

root TEKTON_TEKTON_LINT_ARGUMENTS
Type: array of string or string

TEKTONTEKTONLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root TEKTON_TEKTON_LINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root TEKTON_TEKTON_LINT_CONFIG_FILE
Type: string Default: ".tektonlintrc.yaml"

TEKTONTEKTONLINT: User custom config file name if different from default

root TEKTON_TEKTON_LINT_DISABLE_ERRORS
Type: boolean Default: false

root TEKTON_TEKTON_LINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root TEKTON_TEKTON_LINT_FILE_EXTENSIONS items
Type: string

root TEKTON_TEKTON_LINT_FILE_NAME
Type: string Default: ".tektonlintrc.yaml"

TEKTONTEKTONLINT: User custom config file name if different from default

root TEKTON_TEKTON_LINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root TEKTON_TEKTON_LINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root TEKTON_TEKTON_LINT_POST_COMMANDS
Type: array

Each item of this array must be:

root TEKTON_TEKTON_LINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TEKTON_TEKTON_LINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root TEKTON_TEKTON_LINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TEKTON_TEKTON_LINT_RULES_PATH
Type: string

TEKTONTEKTONLINT: Path where to find linter configuration file

root TERRAFORM_CHECKOV_ARGUMENTS
Type: array of string or string

TERRAFORM_CHECKOV: User custom arguments to add in linter CLI call

Each item of this array must be:

root TERRAFORM_CHECKOV_ARGUMENTS items
Type: string

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

Must be one of:

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

root TERRAFORM_CHECKOV_DISABLE_ERRORS
Type: boolean Default: false

root TERRAFORM_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root TERRAFORM_CHECKOV_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root TERRAFORM_CHECKOV_FILE_EXTENSIONS items
Type: string

root TERRAFORM_CHECKOV_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root TERRAFORM_CHECKOV_FILE_NAMES_REGEX items
Type: string

Examples:

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

root TERRAFORM_CHECKOV_POST_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_CHECKOV_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_CHECKOV_PRE_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_CHECKOV_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_KICS_ARGUMENTS
Type: array of string or string

TERRAFORM_KICS: User custom arguments to add in linter CLI call

Each item of this array must be:

root TERRAFORM_KICS_ARGUMENTS items
Type: string

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

Must be one of:

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

root TERRAFORM_KICS_DISABLE_ERRORS
Type: boolean Default: false

root TERRAFORM_KICS_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root TERRAFORM_KICS_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root TERRAFORM_KICS_FILE_EXTENSIONS items
Type: string

root TERRAFORM_KICS_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root TERRAFORM_KICS_FILE_NAMES_REGEX items
Type: string

Examples:

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

root TERRAFORM_KICS_POST_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_KICS_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_KICS_PRE_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_KICS_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_TERRAFORM_FMT_ARGUMENTS
Type: array of string or string

TERRAFORMTERRAFORMFMT: User custom arguments to add in linter CLI call

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_ARGUMENTS items
Type: string

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

Must be one of:

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

root TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS
Type: boolean Default: false

root TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS items
Type: string

root TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_TERRAGRUNT_ARGUMENTS
Type: array of string or string

TERRAFORM_TERRAGRUNT: User custom arguments to add in linter CLI call

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_ARGUMENTS items
Type: string

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

Must be one of:

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

root TERRAFORM_TERRAGRUNT_CONFIG_FILE
Type: string Default: "terragrunt.hcl"

TERRAFORM_TERRAGRUNT: User custom config file name if different from default

root TERRAFORM_TERRAGRUNT_DISABLE_ERRORS
Type: boolean Default: false

root TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS items
Type: string

root TERRAFORM_TERRAGRUNT_FILE_NAME
Type: string Default: "terragrunt.hcl"

TERRAFORM_TERRAGRUNT: User custom config file name if different from default

root TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root TERRAFORM_TERRAGRUNT_POST_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_TERRAGRUNT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_TERRAGRUNT_RULES_PATH
Type: string

TERRAFORM_TERRAGRUNT: Path where to find linter configuration file

root TERRAFORM_TERRASCAN_ARGUMENTS
Type: array of string or string

TERRAFORM_TERRASCAN: User custom arguments to add in linter CLI call

Each item of this array must be:

root TERRAFORM_TERRASCAN_ARGUMENTS items
Type: string

root TERRAFORM_TERRASCAN_CONFIG_FILE
Type: string Default: "terrascan-config.toml"

TERRAFORM_TERRASCAN: User custom config file name if different from default

root TERRAFORM_TERRASCAN_DISABLE_ERRORS
Type: boolean Default: false

root TERRAFORM_TERRASCAN_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root TERRAFORM_TERRASCAN_FILE_EXTENSIONS items
Type: string

root TERRAFORM_TERRASCAN_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root TERRAFORM_TERRASCAN_FILE_NAMES_REGEX items
Type: string

Examples:

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

root TERRAFORM_TERRASCAN_POST_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_TERRASCAN_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_TERRASCAN_PRE_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_TERRASCAN_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_TERRASCAN_RULES_PATH
Type: string

TERRAFORM_TERRASCAN: Path where to find linter configuration file

root TERRAFORM_TFLINT_ARGUMENTS
Type: array of string or string

TERRAFORM_TFLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root TERRAFORM_TFLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root TERRAFORM_TFLINT_CONFIG_FILE
Type: string Default: ".tflint.hcl"

TERRAFORM_TFLINT: User custom config file name if different from default

root TERRAFORM_TFLINT_DISABLE_ERRORS
Type: boolean Default: false

root TERRAFORM_TFLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root TERRAFORM_TFLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root TERRAFORM_TFLINT_FILE_EXTENSIONS items
Type: string

root TERRAFORM_TFLINT_FILE_NAME
Type: string Default: ".tflint.hcl"

TERRAFORM_TFLINT: User custom config file name if different from default

root TERRAFORM_TFLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root TERRAFORM_TFLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root TERRAFORM_TFLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_TFLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_TFLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root TERRAFORM_TFLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TERRAFORM_TFLINT_RULES_PATH
Type: string

TERRAFORM_TFLINT: Path where to find linter configuration file

root TEXT_REPORTER
Type: boolean Default: true

General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter

root TEXT_REPORTER_SUB_FOLDER
Type: string Default: "linters_logs"

Sub-folder of reports folder containing text logs

root TSX_ESLINT_ARGUMENTS
Type: array of string or string

TSX_ESLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root TSX_ESLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root TSX_ESLINT_CONFIG_FILE
Type: string Default: ".eslintrc.json"

TSX_ESLINT: User custom config file name if different from default

root TSX_ESLINT_DISABLE_ERRORS
Type: boolean Default: false

root TSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root TSX_ESLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root TSX_ESLINT_FILE_EXTENSIONS items
Type: string

root TSX_ESLINT_FILE_NAME
Type: string Default: ".eslintrc.json"

TSX_ESLINT: User custom config file name if different from default

root TSX_ESLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root TSX_ESLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root TSX_ESLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root TSX_ESLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TSX_ESLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root TSX_ESLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TSX_ESLINT_RULES_PATH
Type: string

TSX_ESLINT: Path where to find linter configuration file

root TSX_FILTER_REGEX_EXCLUDE
Type: string

root TSX_FILTER_REGEX_INCLUDE
Type: string

root TYPESCRIPT_DEFAULT_STYLE
Type: enum (of string)

Style of typescript formatting to apply

Must be one of:

  • "standard"
  • "prettier"

Examples:

"standard"
-
"prettier"
-

root TYPESCRIPT_ES_ARGUMENTS
Type: array of string or string

TYPESCRIPT_ES: User custom arguments to add in linter CLI call

Each item of this array must be:

root TYPESCRIPT_ES_ARGUMENTS items
Type: string

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

Must be one of:

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

root TYPESCRIPT_ES_CONFIG_FILE
Type: string Default: ".eslintrc.json"

TYPESCRIPT_ES: User custom config file name if different from default

root TYPESCRIPT_ES_DISABLE_ERRORS
Type: boolean Default: false

root TYPESCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root TYPESCRIPT_ES_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root TYPESCRIPT_ES_FILE_EXTENSIONS items
Type: string

root TYPESCRIPT_ES_FILE_NAME
Type: string Default: ".eslintrc.json"

TYPESCRIPT_ES: User custom config file name if different from default

root TYPESCRIPT_ES_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root TYPESCRIPT_ES_FILE_NAMES_REGEX items
Type: string

Examples:

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

root TYPESCRIPT_ES_POST_COMMANDS
Type: array

Each item of this array must be:

root TYPESCRIPT_ES_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TYPESCRIPT_ES_PRE_COMMANDS
Type: array

Each item of this array must be:

root TYPESCRIPT_ES_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TYPESCRIPT_ES_RULES_PATH
Type: string

TYPESCRIPT_ES: Path where to find linter configuration file

root TYPESCRIPT_PRETTIER_ARGUMENTS
Type: array of string or string

TYPESCRIPT_PRETTIER: User custom arguments to add in linter CLI call

Each item of this array must be:

root TYPESCRIPT_PRETTIER_ARGUMENTS items
Type: string

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

Must be one of:

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

root TYPESCRIPT_PRETTIER_CONFIG_FILE
Type: string Default: ".prettierrc.json"

TYPESCRIPT_PRETTIER: User custom config file name if different from default

root TYPESCRIPT_PRETTIER_DISABLE_ERRORS
Type: boolean Default: false

root TYPESCRIPT_PRETTIER_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root TYPESCRIPT_PRETTIER_FILE_EXTENSIONS items
Type: string

root TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX items
Type: string

Examples:

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

root TYPESCRIPT_PRETTIER_POST_COMMANDS
Type: array

Each item of this array must be:

root TYPESCRIPT_PRETTIER_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TYPESCRIPT_PRETTIER_PRE_COMMANDS
Type: array

Each item of this array must be:

root TYPESCRIPT_PRETTIER_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TYPESCRIPT_PRETTIER_RULES_PATH
Type: string

TYPESCRIPT_PRETTIER: Path where to find linter configuration file

root TYPESCRIPT_STANDARD_ARGUMENTS
Type: array of string or string

TYPESCRIPT_STANDARD: User custom arguments to add in linter CLI call

Each item of this array must be:

root TYPESCRIPT_STANDARD_ARGUMENTS items
Type: string

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

Must be one of:

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

root TYPESCRIPT_STANDARD_DISABLE_ERRORS
Type: boolean Default: false

root TYPESCRIPT_STANDARD_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root TYPESCRIPT_STANDARD_FILE_EXTENSIONS items
Type: string

root TYPESCRIPT_STANDARD_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root TYPESCRIPT_STANDARD_FILE_NAMES_REGEX items
Type: string

Examples:

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

root TYPESCRIPT_STANDARD_POST_COMMANDS
Type: array

Each item of this array must be:

root TYPESCRIPT_STANDARD_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root TYPESCRIPT_STANDARD_PRE_COMMANDS
Type: array

Each item of this array must be:

root TYPESCRIPT_STANDARD_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root UPDATED_SOURCES_REPORTER
Type: boolean

root UPDATED_SOURCES_REPORTER_DIR
Type: string

root VALIDATE_ALL_CODEBASE
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.

root VBDOTNET_DOTNET_FORMAT_ARGUMENTS
Type: array of string or string

VBDOTNETDOTNETFORMAT: User custom arguments to add in linter CLI call

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_ARGUMENTS items
Type: string

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

Must be one of:

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

root VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS
Type: boolean Default: false

root VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS items
Type: string

root VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS
Type: array

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS
Type: array

Each item of this array must be:

root VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root XML_FILTER_REGEX_EXCLUDE
Type: string

root XML_FILTER_REGEX_INCLUDE
Type: string

root XML_XMLLINT_ARGUMENTS
Type: array of string or string

XML_XMLLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root XML_XMLLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root XML_XMLLINT_DISABLE_ERRORS
Type: boolean Default: false

root XML_XMLLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root XML_XMLLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root XML_XMLLINT_FILE_EXTENSIONS items
Type: string

root XML_XMLLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root XML_XMLLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root XML_XMLLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root XML_XMLLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root XML_XMLLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root XML_XMLLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root YAML_FILTER_REGEX_EXCLUDE
Type: string

root YAML_FILTER_REGEX_INCLUDE
Type: string

root YAML_PRETTIER_ARGUMENTS
Type: array of string or string

YAML_PRETTIER: User custom arguments to add in linter CLI call

Each item of this array must be:

root YAML_PRETTIER_ARGUMENTS items
Type: string

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

Must be one of:

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

root YAML_PRETTIER_CONFIG_FILE
Type: string Default: ".prettierrc.json"

YAML_PRETTIER: User custom config file name if different from default

root YAML_PRETTIER_DISABLE_ERRORS
Type: boolean Default: false

root YAML_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root YAML_PRETTIER_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root YAML_PRETTIER_FILE_EXTENSIONS items
Type: string

root YAML_PRETTIER_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root YAML_PRETTIER_FILE_NAMES_REGEX items
Type: string

Examples:

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

root YAML_PRETTIER_POST_COMMANDS
Type: array

Each item of this array must be:

root YAML_PRETTIER_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root YAML_PRETTIER_PRE_COMMANDS
Type: array

Each item of this array must be:

root YAML_PRETTIER_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root YAML_PRETTIER_RULES_PATH
Type: string

YAML_PRETTIER: Path where to find linter configuration file

root YAML_V8R_ARGUMENTS
Type: array of string or string

YAML_V8R: User custom arguments to add in linter CLI call

Each item of this array must be:

root YAML_V8R_ARGUMENTS items
Type: string

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

Must be one of:

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

root YAML_V8R_DISABLE_ERRORS
Type: boolean Default: false

root YAML_V8R_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root YAML_V8R_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root YAML_V8R_FILE_EXTENSIONS items
Type: string

root YAML_V8R_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root YAML_V8R_FILE_NAMES_REGEX items
Type: string

Examples:

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

root YAML_V8R_POST_COMMANDS
Type: array

Each item of this array must be:

root YAML_V8R_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root YAML_V8R_PRE_COMMANDS
Type: array

Each item of this array must be:

root YAML_V8R_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root YAML_YAMLLINT_ARGUMENTS
Type: array of string or string

YAML_YAMLLINT: User custom arguments to add in linter CLI call

Each item of this array must be:

root YAML_YAMLLINT_ARGUMENTS items
Type: string

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

Must be one of:

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

root YAML_YAMLLINT_CONFIG_FILE
Type: string Default: ".yamllint.yml"

YAML_YAMLLINT: User custom config file name if different from default

root YAML_YAMLLINT_DISABLE_ERRORS
Type: boolean Default: false

root YAML_YAMLLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0

root YAML_YAMLLINT_FILE_EXTENSIONS
Type: array of string

Each item of this array must be:

root YAML_YAMLLINT_FILE_EXTENSIONS items
Type: string

root YAML_YAMLLINT_FILE_NAME
Type: string Default: ".yaml-lint.yml"

YAML_YAMLLINT: User custom config file name if different from default

root YAML_YAMLLINT_FILE_NAMES_REGEX
Type: array of string

Each item of this array must be:

root YAML_YAMLLINT_FILE_NAMES_REGEX items
Type: string

Examples:

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

root YAML_YAMLLINT_POST_COMMANDS
Type: array

Each item of this array must be:

root YAML_YAMLLINT_POST_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root YAML_YAMLLINT_PRE_COMMANDS
Type: array

Each item of this array must be:

root YAML_YAMLLINT_PRE_COMMANDS command_info
Type: object

Command information

Same definition as command_info

Example:

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

root YAML_YAMLLINT_RULES_PATH
Type: string

YAML_YAMLLINT: Path where to find linter configuration file
\ No newline at end of file + + + + + + + + + + + + + + Schema Docs + + + +
Type: object
+

MegaLinter configuration file

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_ARGUMENTS
Type: array of string or string
+

ACTION_ACTIONLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ACTION_ACTIONLINT_ARGUMENTS + + + + ACTION_ACTIONLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_CONFIG_FILE
Type: string Default: "actionlint.yml"
+

ACTION_ACTIONLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_DIRECTORY
Type: string Default: ".github/workflows"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ACTION_ACTIONLINT_FILE_EXTENSIONS + + + + ACTION_ACTIONLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ACTION_ACTIONLINT_FILE_NAMES_REGEX + + + + ACTION_ACTIONLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ACTION_ACTIONLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ACTION_ACTIONLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + ACTION_ACTIONLINT_RULES_PATH
Type: string
+

ACTION_ACTIONLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ACTION_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + 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.

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ADDITIONAL_EXCLUDED_DIRECTORIES + + + + ADDITIONAL_EXCLUDED_DIRECTORIES items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "test"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_ARGUMENTS
Type: array of string or string
+

ANSIBLEANSIBLELINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ANSIBLE_ANSIBLE_LINT_ARGUMENTS + + + + ANSIBLE_ANSIBLE_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_CONFIG_FILE
Type: string Default: ".ansible-lint"
+

ANSIBLEANSIBLELINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_DIRECTORY
Type: string Default: "ansible"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS + + + + ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_FILE_NAME
Type: string Default: ".ansible-lint.yml"
+

ANSIBLEANSIBLELINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX + + + + ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ANSIBLE_ANSIBLE_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_ANSIBLE_LINT_RULES_PATH
Type: string
+

ANSIBLEANSIBLELINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_DIRECTORY
Type: string Default: "ansible"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ANSIBLE_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + APPLY_FIXES
Type: array or string Default: "none"
+

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

+ + + + + + +
+
Examples:
+
"all"
+
+
"none"
+
+
[
+    "JAVASCRIPT_ES",
+    "MARKDOWN_MARKDOWNLINT"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_ARGUMENTS
Type: array of string or string
+

ARMARMTTK: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ARM_ARM_TTK_ARGUMENTS + + + + ARM_ARM_TTK_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_CONFIG_FILE
Type: string Default: ".arm-ttk.psd1"
+

ARMARMTTK: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ARM_ARM_TTK_FILE_EXTENSIONS + + + + ARM_ARM_TTK_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_FILE_NAME
Type: string Default: ".arm-ttk.psd1"
+

ARMARMTTK: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ARM_ARM_TTK_FILE_NAMES_REGEX + + + + ARM_ARM_TTK_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ARM_ARM_TTK_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ARM_ARM_TTK_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + ARM_ARM_TTK_RULES_PATH
Type: string
+

ARMARMTTK: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ARM_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + AZURE_COMMENT_REPORTER
Type: boolean Default: true
+

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

+ + + + + + + +
+
+
+
+ +
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_ARGUMENTS
Type: array of string or string
+

BASH_EXEC: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_EXEC_ARGUMENTS + + + + BASH_EXEC_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_EXEC_FILE_EXTENSIONS + + + + BASH_EXEC_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_EXEC_FILE_NAMES_REGEX + + + + BASH_EXEC_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_EXEC_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_EXEC_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_EXEC_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + BASH_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_ARGUMENTS
Type: array of string or string
+

BASH_SHELLCHECK: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_SHELLCHECK_ARGUMENTS + + + + BASH_SHELLCHECK_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_SHELLCHECK_FILE_EXTENSIONS + + + + BASH_SHELLCHECK_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_SHELLCHECK_FILE_NAMES_REGEX + + + + BASH_SHELLCHECK_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_SHELLCHECK_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_SHELLCHECK_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHELLCHECK_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_ARGUMENTS
Type: array of string or string
+

BASH_SHFMT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_SHFMT_ARGUMENTS + + + + BASH_SHFMT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_SHFMT_FILE_EXTENSIONS + + + + BASH_SHFMT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_SHFMT_FILE_NAMES_REGEX + + + + BASH_SHFMT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_SHFMT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BASH_SHFMT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BASH_SHFMT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_ARGUMENTS
Type: array of string or string
+

BICEPBICEPLINTER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BICEP_BICEP_LINTER_ARGUMENTS + + + + BICEP_BICEP_LINTER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BICEP_BICEP_LINTER_FILE_EXTENSIONS + + + + BICEP_BICEP_LINTER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BICEP_BICEP_LINTER_FILE_NAMES_REGEX + + + + BICEP_BICEP_LINTER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BICEP_BICEP_LINTER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + BICEP_BICEP_LINTER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_BICEP_LINTER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + BICEP_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + BICEP_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLEAR_REPORT_FOLDER
Type: boolean Default: false
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_ARGUMENTS
Type: array of string or string
+

CLOJURECLJKONDO: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CLOJURE_CLJ_KONDO_ARGUMENTS + + + + CLOJURE_CLJ_KONDO_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

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

CLOJURECLJKONDO: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CLOJURE_CLJ_KONDO_FILE_EXTENSIONS + + + + CLOJURE_CLJ_KONDO_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

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

CLOJURECLJKONDO: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX + + + + CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CLOJURE_CLJ_KONDO_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CLOJURE_CLJ_KONDO_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CLOJURE_CLJ_KONDO_RULES_PATH
Type: string
+

CLOJURECLJKONDO: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOJURE_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_ARGUMENTS
Type: array of string or string
+

CLOUDFORMATIONCFNLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CLOUDFORMATION_CFN_LINT_ARGUMENTS + + + + CLOUDFORMATION_CFN_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_CONFIG_FILE
Type: string Default: ".cfnlintrc.yml"
+

CLOUDFORMATIONCFNLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS + + + + CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_FILE_NAME
Type: string Default: ".cfnlintrc.yml"
+

CLOUDFORMATIONCFNLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX + + + + CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CLOUDFORMATION_CFN_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CLOUDFORMATION_CFN_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_CFN_LINT_RULES_PATH
Type: string
+

CLOUDFORMATIONCFNLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CLOUDFORMATION_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_ARGUMENTS
Type: array of string or string
+

COFFEE_COFFEELINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + COFFEE_COFFEELINT_ARGUMENTS + + + + COFFEE_COFFEELINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_CONFIG_FILE
Type: string Default: ".coffee-lint.json"
+

COFFEE_COFFEELINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + COFFEE_COFFEELINT_FILE_EXTENSIONS + + + + COFFEE_COFFEELINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_FILE_NAME
Type: string Default: ".coffee-lint.json"
+

COFFEE_COFFEELINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + COFFEE_COFFEELINT_FILE_NAMES_REGEX + + + + COFFEE_COFFEELINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + COFFEE_COFFEELINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + COFFEE_COFFEELINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + COFFEE_COFFEELINT_RULES_PATH
Type: string
+

COFFEE_COFFEELINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COFFEE_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CONFIG_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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CONFIG_REPORTER_SUB_FOLDER
Type: string Default: "IDE-config"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CONSOLE_REPORTER
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CONSOLE_REPORTER_SECTIONS
Type: boolean Default: true
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_ARGUMENTS
Type: array of string or string
+

COPYPASTE_JSCPD: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + COPYPASTE_JSCPD_ARGUMENTS + + + + COPYPASTE_JSCPD_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_CONFIG_FILE
Type: string Default: ".jscpd.json"
+

COPYPASTE_JSCPD: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_FILE_NAME
Type: string Default: ".jscpd.json"
+

COPYPASTE_JSCPD: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + COPYPASTE_JSCPD_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + COPYPASTE_JSCPD_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + COPYPASTE_JSCPD_RULES_PATH
Type: string
+

COPYPASTE_JSCPD: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_ARGUMENTS
Type: array of string or string
+

CPP_CPPLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CPP_CPPLINT_ARGUMENTS + + + + CPP_CPPLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CPP_CPPLINT_FILE_EXTENSIONS + + + + CPP_CPPLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CPP_CPPLINT_FILE_NAMES_REGEX + + + + CPP_CPPLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CPP_CPPLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CPP_CPPLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_CPPLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CPP_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CPP_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_ARGUMENTS
Type: array of string or string
+

CREDENTIALS_SECRETLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CREDENTIALS_SECRETLINT_ARGUMENTS + + + + CREDENTIALS_SECRETLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_CONFIG_FILE
Type: string Default: ".secretlintrc.json"
+

CREDENTIALS_SECRETLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CREDENTIALS_SECRETLINT_FILE_EXTENSIONS + + + + CREDENTIALS_SECRETLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CREDENTIALS_SECRETLINT_FILE_NAMES_REGEX + + + + CREDENTIALS_SECRETLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CREDENTIALS_SECRETLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CREDENTIALS_SECRETLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CREDENTIALS_SECRETLINT_RULES_PATH
Type: string
+

CREDENTIALS_SECRETLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_ARGUMENTS
Type: array of string or string
+

CSHARP_CSHARPIER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSHARP_CSHARPIER_ARGUMENTS + + + + CSHARP_CSHARPIER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSHARP_CSHARPIER_FILE_EXTENSIONS + + + + CSHARP_CSHARPIER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSHARP_CSHARPIER_FILE_NAMES_REGEX + + + + CSHARP_CSHARPIER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSHARP_CSHARPIER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSHARP_CSHARPIER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_CSHARPIER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_ARGUMENTS
Type: array of string or string
+

CSHARPDOTNETFORMAT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSHARP_DOTNET_FORMAT_ARGUMENTS + + + + CSHARP_DOTNET_FORMAT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS + + + + CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX + + + + CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSHARP_DOTNET_FORMAT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSHARP_DOTNET_FORMAT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_DOTNET_FORMAT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CSHARP_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSHARP_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_ARGUMENTS
Type: array of string or string
+

CSSSCSSLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSS_SCSS_LINT_ARGUMENTS + + + + CSS_SCSS_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_CONFIG_FILE
Type: string Default: ".scss-lint.yml"
+

CSSSCSSLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSS_SCSS_LINT_FILE_EXTENSIONS + + + + CSS_SCSS_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_FILE_NAME
Type: string Default: ".scss-lint.yml"
+

CSSSCSSLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSS_SCSS_LINT_FILE_NAMES_REGEX + + + + CSS_SCSS_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSS_SCSS_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSS_SCSS_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CSS_SCSS_LINT_RULES_PATH
Type: string
+

CSSSCSSLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_ARGUMENTS
Type: array of string or string
+

CSS_STYLELINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSS_STYLELINT_ARGUMENTS + + + + CSS_STYLELINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_CONFIG_FILE
Type: string Default: ".stylelintrc.json"
+

CSS_STYLELINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSS_STYLELINT_FILE_EXTENSIONS + + + + CSS_STYLELINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_FILE_NAME
Type: string Default: ".stylelintrc.json"
+

CSS_STYLELINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSS_STYLELINT_FILE_NAMES_REGEX + + + + CSS_STYLELINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSS_STYLELINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + CSS_STYLELINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + CSS_STYLELINT_RULES_PATH
Type: string
+

CSS_STYLELINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_ARGUMENTS
Type: array of string or string
+

C_CPPLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + C_CPPLINT_ARGUMENTS + + + + C_CPPLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + C_CPPLINT_FILE_EXTENSIONS + + + + C_CPPLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + C_CPPLINT_FILE_NAMES_REGEX + + + + C_CPPLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + C_CPPLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + C_CPPLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_CPPLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + C_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + C_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_ARGUMENTS
Type: array of string or string
+

DART_DARTANALYZER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DART_DARTANALYZER_ARGUMENTS + + + + DART_DARTANALYZER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_CONFIG_FILE
Type: string Default: "analysis_options.yml"
+

DART_DARTANALYZER: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DART_DARTANALYZER_FILE_EXTENSIONS + + + + DART_DARTANALYZER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_FILE_NAME
Type: string Default: "analysis_options.yml"
+

DART_DARTANALYZER: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DART_DARTANALYZER_FILE_NAMES_REGEX + + + + DART_DARTANALYZER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DART_DARTANALYZER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DART_DARTANALYZER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + DART_DARTANALYZER_RULES_PATH
Type: string
+

DART_DARTANALYZER: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DART_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DEFAULT_BRANCH
Type: string Default: "HEAD"
+

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

+ + + + + + +
+
Examples:
+
"master"
+
+
"main"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DEFAULT_WORKSPACE
Type: string Default: "/tmp/lint"
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DISABLE
Type: array
+

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

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DISABLE + + + + enum_descriptor_keys
Type: enum (of string)
+ + +
+

Must be one of:

+
  • "ACTION"
  • "ANSIBLE"
  • "ARM"
  • "BASH"
  • "BICEP"
  • "C"
  • "CLOJURE"
  • "CLOUDFORMATION"
  • "COFFEE"
  • "COPYPASTE"
  • "CPP"
  • "CSHARP"
  • "CSS"
  • "DART"
  • "DOCKERFILE"
  • "EDITORCONFIG"
  • "ENV"
  • "GHERKIN"
  • "GO"
  • "GRAPHQL"
  • "GROOVY"
  • "HTML"
  • "JAVA"
  • "JAVASCRIPT"
  • "JSON"
  • "JSX"
  • "KOTLIN"
  • "KUBERNETES"
  • "LATEX"
  • "LUA"
  • "MAKEFILE"
  • "MARKDOWN"
  • "OPENAPI"
  • "PERL"
  • "PHP"
  • "POWERSHELL"
  • "PROTOBUF"
  • "PUPPET"
  • "PYTHON"
  • "R"
  • "RAKU"
  • "REPOSITORY"
  • "RST"
  • "RUBY"
  • "RUST"
  • "SALESFORCE"
  • "SCALA"
  • "SNAKEMAKE"
  • "SPELL"
  • "SQL"
  • "SWIFT"
  • "TEKTON"
  • "TERRAFORM"
  • "TSX"
  • "TYPESCRIPT"
  • "VBDOTNET"
  • "XML"
  • "YAML"
  • "CREDENTIALS"
  • "GIT"
+
+ + + + + + +
+

+
Example:
+
[
+    "BASH",
+    "HTML"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DISABLE_ERRORS
Type: boolean Default: false
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DISABLE_ERRORS_LINTERS
Type: array
+

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

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DISABLE_ERRORS_LINTERS + + + + enum_linter_keys
Type: enum (of string)
+ + +
+

Must be one of:

+
  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "C_CPPLINT"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CPPLINT"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_CSHARPIER"
  • "CSS_STYLELINT"
  • "CSS_SCSS_LINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_STANDARD"
  • "JAVASCRIPT_PRETTIER"
  • "JSON_JSONLINT"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_V8R"
  • "JSON_PRETTIER"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSX_ESLINT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_KUBEVAL"
  • "KUBERNETES_KUBECONFORM"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_PHPCS"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "PHP_PHPLINT"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_PYLINT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_BANDIT"
  • "PYTHON_MYPY"
  • "PYTHON_PYRIGHT"
  • "R_LINTR"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "RST_RST_LINT"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_MISSPELL"
  • "SPELL_CSPELL"
  • "SPELL_PROSELINT"
  • "SQL_SQL_LINT"
  • "SQL_SQLFLUFF"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_TFLINT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_STANDARD"
  • "TYPESCRIPT_PRETTIER"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_YAMLLINT"
  • "YAML_V8R"
  • "CREDENTIALS_SECRETLINT"
  • "DOCKERFILE_DOCKERFILELINT"
  • "GIT_GIT_DIFF"
  • "PHP_BUILTIN"
+
+ + + + + + +
+

+
Example:
+
[
+    "BASH_BASH_SHFMT",
+    "JAVASCRIPT_STANDARD"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DISABLE_LINTERS
Type: array
+

If DISABLE_LINTERS is set, the listed linters will be skipped

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DISABLE_LINTERS + + + + enum_linter_keys
Type: enum (of string)
+ + +
+

Must be one of:

+
  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "C_CPPLINT"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CPPLINT"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_CSHARPIER"
  • "CSS_STYLELINT"
  • "CSS_SCSS_LINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_STANDARD"
  • "JAVASCRIPT_PRETTIER"
  • "JSON_JSONLINT"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_V8R"
  • "JSON_PRETTIER"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSX_ESLINT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_KUBEVAL"
  • "KUBERNETES_KUBECONFORM"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_PHPCS"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "PHP_PHPLINT"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_PYLINT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_BANDIT"
  • "PYTHON_MYPY"
  • "PYTHON_PYRIGHT"
  • "R_LINTR"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "RST_RST_LINT"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_MISSPELL"
  • "SPELL_CSPELL"
  • "SPELL_PROSELINT"
  • "SQL_SQL_LINT"
  • "SQL_SQLFLUFF"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_TFLINT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_STANDARD"
  • "TYPESCRIPT_PRETTIER"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_YAMLLINT"
  • "YAML_V8R"
  • "CREDENTIALS_SECRETLINT"
  • "DOCKERFILE_DOCKERFILELINT"
  • "GIT_GIT_DIFF"
  • "PHP_BUILTIN"
+
+ + + + + + +
+

+
Example:
+
[
+    "BASH_BASH_SHFMT",
+    "JAVASCRIPT_STANDARD"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_ARGUMENTS
Type: array of string or string
+

DOCKERFILE_DOCKERFILELINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DOCKERFILE_DOCKERFILELINT_ARGUMENTS + + + + DOCKERFILE_DOCKERFILELINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_CONFIG_FILE
Type: string Default: ".dockerfilelintrc"
+

DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DOCKERFILE_DOCKERFILELINT_FILE_EXTENSIONS + + + + DOCKERFILE_DOCKERFILELINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_FILE_NAME
Type: string Default: ".dockerfilelintrc"
+

DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DOCKERFILE_DOCKERFILELINT_FILE_NAMES_REGEX + + + + DOCKERFILE_DOCKERFILELINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DOCKERFILE_DOCKERFILELINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_DOCKERFILELINT_RULES_PATH
Type: string
+

DOCKERFILE_DOCKERFILELINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_ARGUMENTS
Type: array of string or string
+

DOCKERFILE_HADOLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DOCKERFILE_HADOLINT_ARGUMENTS + + + + DOCKERFILE_HADOLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_CONFIG_FILE
Type: string Default: ".hadolint.yaml"
+

DOCKERFILE_HADOLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DOCKERFILE_HADOLINT_FILE_EXTENSIONS + + + + DOCKERFILE_HADOLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_FILE_NAME
Type: string Default: ".hadolint.yml"
+

DOCKERFILE_HADOLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DOCKERFILE_HADOLINT_FILE_NAMES_REGEX + + + + DOCKERFILE_HADOLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DOCKERFILE_HADOLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + DOCKERFILE_HADOLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + DOCKERFILE_HADOLINT_RULES_PATH
Type: string
+

DOCKERFILE_HADOLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS
Type: array of string or string
+

EDITORCONFIGEDITORCONFIGCHECKER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE
Type: string Default: ".ecrc"
+

EDITORCONFIGEDITORCONFIGCHECKER: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAME
Type: string Default: ".ecrc"
+

EDITORCONFIGEDITORCONFIGCHECKER: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_EDITORCONFIG_CHECKER_RULES_PATH
Type: string
+

EDITORCONFIGEDITORCONFIGCHECKER: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EDITORCONFIG_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EMAIL_REPORTER
Type: boolean Default: true
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EMAIL_REPORTER_EMAIL
Type: string
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EMAIL_REPORTER_SENDER
Type: string Default: "megalinter@gmail.com"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EMAIL_REPORTER_SEND_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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EMAIL_REPORTER_SMTP_HOST
Type: string Default: "smtp.gmail.com"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EMAIL_REPORTER_SMTP_PASSWORD
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EMAIL_REPORTER_SMTP_PORT
Type: number Default: "465"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EMAIL_REPORTER_SMTP_USERNAME
Type: string Default: "megalinter@gmail.com"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENABLE
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

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ENABLE + + + + enum_descriptor_keys
Type: enum (of string)
+ + +
+

Must be one of:

+
  • "ACTION"
  • "ANSIBLE"
  • "ARM"
  • "BASH"
  • "BICEP"
  • "C"
  • "CLOJURE"
  • "CLOUDFORMATION"
  • "COFFEE"
  • "COPYPASTE"
  • "CPP"
  • "CSHARP"
  • "CSS"
  • "DART"
  • "DOCKERFILE"
  • "EDITORCONFIG"
  • "ENV"
  • "GHERKIN"
  • "GO"
  • "GRAPHQL"
  • "GROOVY"
  • "HTML"
  • "JAVA"
  • "JAVASCRIPT"
  • "JSON"
  • "JSX"
  • "KOTLIN"
  • "KUBERNETES"
  • "LATEX"
  • "LUA"
  • "MAKEFILE"
  • "MARKDOWN"
  • "OPENAPI"
  • "PERL"
  • "PHP"
  • "POWERSHELL"
  • "PROTOBUF"
  • "PUPPET"
  • "PYTHON"
  • "R"
  • "RAKU"
  • "REPOSITORY"
  • "RST"
  • "RUBY"
  • "RUST"
  • "SALESFORCE"
  • "SCALA"
  • "SNAKEMAKE"
  • "SPELL"
  • "SQL"
  • "SWIFT"
  • "TEKTON"
  • "TERRAFORM"
  • "TSX"
  • "TYPESCRIPT"
  • "VBDOTNET"
  • "XML"
  • "YAML"
  • "CREDENTIALS"
  • "GIT"
+
+ + + + + + +
+

+
Example:
+
[
+    "BASH",
+    "HTML",
+    "JAVASCRIPT"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENABLE_LINTERS
Type: array
+

If ENABLE_LINTERS is set, only listed linters will be processed

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ENABLE_LINTERS + + + + enum_linter_keys
Type: enum (of string)
+ + +
+

Must be one of:

+
  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "C_CPPLINT"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CPPLINT"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_CSHARPIER"
  • "CSS_STYLELINT"
  • "CSS_SCSS_LINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_STANDARD"
  • "JAVASCRIPT_PRETTIER"
  • "JSON_JSONLINT"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_V8R"
  • "JSON_PRETTIER"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSX_ESLINT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_KUBEVAL"
  • "KUBERNETES_KUBECONFORM"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_PHPCS"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "PHP_PHPLINT"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_PYLINT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_BANDIT"
  • "PYTHON_MYPY"
  • "PYTHON_PYRIGHT"
  • "R_LINTR"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "RST_RST_LINT"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_MISSPELL"
  • "SPELL_CSPELL"
  • "SPELL_PROSELINT"
  • "SQL_SQL_LINT"
  • "SQL_SQLFLUFF"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_TFLINT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_STANDARD"
  • "TYPESCRIPT_PRETTIER"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_YAMLLINT"
  • "YAML_V8R"
  • "CREDENTIALS_SECRETLINT"
  • "DOCKERFILE_DOCKERFILELINT"
  • "GIT_GIT_DIFF"
  • "PHP_BUILTIN"
+
+ + + + + + +
+

+
Example:
+
[
+    "JAVASCRIPT_ES",
+    "PYTHON_PYLINT"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_ARGUMENTS
Type: array of string or string
+

ENVDOTENVLINTER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ENV_DOTENV_LINTER_ARGUMENTS + + + + ENV_DOTENV_LINTER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ENV_DOTENV_LINTER_FILE_EXTENSIONS + + + + ENV_DOTENV_LINTER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ENV_DOTENV_LINTER_FILE_NAMES_REGEX + + + + ENV_DOTENV_LINTER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ENV_DOTENV_LINTER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + ENV_DOTENV_LINTER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_DOTENV_LINTER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + ENV_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ENV_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + ERROR_ON_MISSING_EXEC_BIT
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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EXCLUDED_DIRECTORIES
Type: array of string
+

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

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + EXCLUDED_DIRECTORIES + + + + EXCLUDED_DIRECTORIES items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    ".github",
+    "node_modules"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + EXTENDS
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

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + EXTENDS + + + + EXTENDS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + FAIL_IF_MISSING_LINTER_IN_FLAVOR
Type: boolean Default: false
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + 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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + FILEIO_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)

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + FILEIO_REPORTER_SEND_SUCCESS
Type: boolean Default: false
+

Skip posting to file.io if linting is in success

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + FILTER_REGEX_EXCLUDE
Type: string
+

Regular expression defining which files will be excluded from linting

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

+ +

+
+ +
+
+ +
root + + + + FILTER_REGEX_INCLUDE
Type: string
+

Regular expression defining which files will be processed by linters

+ + + + + + +
+
Example:
+
"(src/)"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + FLAVOR_SUGGESTIONS
Type: boolean Default: true
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + FORMATTERS_DISABLE_ERRORS
Type: boolean Default: true
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_ARGUMENTS
Type: array of string or string
+

GHERKINGHERKINLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GHERKIN_GHERKIN_LINT_ARGUMENTS + + + + GHERKIN_GHERKIN_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_CONFIG_FILE
Type: string Default: ".gherkin-lintrc"
+

GHERKINGHERKINLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS + + + + GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_FILE_NAME
Type: string Default: ".gherkin-lintrc"
+

GHERKINGHERKINLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX + + + + GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GHERKIN_GHERKIN_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GHERKIN_GHERKIN_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GHERKIN_GHERKIN_LINT_RULES_PATH
Type: string
+

GHERKINGHERKINLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GITHUB_API_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"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GITHUB_COMMENT_REPORTER
Type: boolean Default: true
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GITHUB_SERVER_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/"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GITHUB_STATUS_REPORTER
Type: boolean Default: true
+

Posts a status on the pull request for each processed linter

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + 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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GITLAB_ACCESS_TOKEN_MEGALINTER
Type: string Default: true
+

Gitlab access token with API access (can be user or project Access token)

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GITLAB_CERTIFICATE_PATH
Type: string Default: true
+

Path to SSL certificate if necessary

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GITLAB_COMMENT_REPORTER
Type: boolean Default: true
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GITLAB_CUSTOM_CERTIFICATE
Type: string Default: true
+

Store your SSL certificate string value in a CI env variable named GITLABCUSTOMCERTIFICATE if you want it to be copied by MegaLinter in a local certificate file that will be used by python gitlab lib

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_ARGUMENTS
Type: array of string or string
+

GITGITDIFF: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GIT_GIT_DIFF_ARGUMENTS + + + + GIT_GIT_DIFF_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GIT_GIT_DIFF_FILE_EXTENSIONS + + + + GIT_GIT_DIFF_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GIT_GIT_DIFF_FILE_NAMES_REGEX + + + + GIT_GIT_DIFF_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GIT_GIT_DIFF_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GIT_GIT_DIFF_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GIT_GIT_DIFF_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GO_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_ARGUMENTS
Type: array of string or string
+

GOGOLANGCILINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GO_GOLANGCI_LINT_ARGUMENTS + + + + GO_GOLANGCI_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_CONFIG_FILE
Type: string Default: ".golangci.yml"
+

GOGOLANGCILINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GO_GOLANGCI_LINT_FILE_EXTENSIONS + + + + GO_GOLANGCI_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_FILE_NAME
Type: string Default: ".golangci.yml"
+

GOGOLANGCILINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GO_GOLANGCI_LINT_FILE_NAMES_REGEX + + + + GO_GOLANGCI_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GO_GOLANGCI_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GO_GOLANGCI_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GO_GOLANGCI_LINT_RULES_PATH
Type: string
+

GOGOLANGCILINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_ARGUMENTS
Type: array of string or string
+

GO_REVIVE: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GO_REVIVE_ARGUMENTS + + + + GO_REVIVE_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_CONFIG_FILE
Type: string Default: "revive.toml"
+

GO_REVIVE: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GO_REVIVE_FILE_EXTENSIONS + + + + GO_REVIVE_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GO_REVIVE_FILE_NAMES_REGEX + + + + GO_REVIVE_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GO_REVIVE_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GO_REVIVE_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GO_REVIVE_RULES_PATH
Type: string
+

GO_REVIVE: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS
Type: array of string or string
+

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_CONFIG_FILE
Type: string Default: ".graphql-schema-linterrc"
+

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAME
Type: string Default: ".graphql-schema-linterrc"
+

GRAPHQLGRAPHQLSCHEMA_LINTER: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GRAPHQL_GRAPHQL_SCHEMA_LINTER_RULES_PATH
Type: string
+

GRAPHQLGRAPHQLSCHEMA_LINTER: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_ARGUMENTS
Type: array of string or string
+

GROOVYNPMGROOVY_LINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GROOVY_NPM_GROOVY_LINT_ARGUMENTS + + + + GROOVY_NPM_GROOVY_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_CONFIG_FILE
Type: string Default: ".groovylintrc.json"
+

GROOVYNPMGROOVY_LINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS + + + + GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_FILE_NAME
Type: string Default: ".groovylintrc.json"
+

GROOVYNPMGROOVY_LINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX + + + + GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GROOVY_NPM_GROOVY_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + GROOVY_NPM_GROOVY_LINT_RULES_PATH
Type: string
+

GROOVYNPMGROOVY_LINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_ARGUMENTS
Type: array of string or string
+

HTML_DJLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + HTML_DJLINT_ARGUMENTS + + + + HTML_DJLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + HTML_DJLINT_FILE_EXTENSIONS + + + + HTML_DJLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + HTML_DJLINT_FILE_NAMES_REGEX + + + + HTML_DJLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + HTML_DJLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + HTML_DJLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_DJLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + HTML_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_ARGUMENTS
Type: array of string or string
+

HTML_HTMLHINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + HTML_HTMLHINT_ARGUMENTS + + + + HTML_HTMLHINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_CONFIG_FILE
Type: string Default: ".htmlhintrc"
+

HTML_HTMLHINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + HTML_HTMLHINT_FILE_EXTENSIONS + + + + HTML_HTMLHINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_FILE_NAME
Type: string Default: ".htmlhintrc"
+

HTML_HTMLHINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + HTML_HTMLHINT_FILE_NAMES_REGEX + + + + HTML_HTMLHINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + HTML_HTMLHINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + HTML_HTMLHINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + HTML_HTMLHINT_RULES_PATH
Type: string
+

HTML_HTMLHINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + IGNORE_GENERATED_FILES
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + IGNORE_GITIGNORED_FILES
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_DEFAULT_STYLE
Type: enum (of string)
+

Style of javascript formatting to apply

+
+

Must be one of:

+
  • "standard"
  • "prettier"
+
+ + + + + +
+
Examples:
+
"standard"
+
+
"prettier"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_ARGUMENTS
Type: array of string or string
+

JAVASCRIPT_ES: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_ES_ARGUMENTS + + + + JAVASCRIPT_ES_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_CONFIG_FILE
Type: string Default: ".eslintrc.json"
+

JAVASCRIPT_ES: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_ES_FILE_EXTENSIONS + + + + JAVASCRIPT_ES_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_FILE_NAME
Type: string Default: ".eslintrc.json"
+

JAVASCRIPT_ES: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_ES_FILE_NAMES_REGEX + + + + JAVASCRIPT_ES_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_ES_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_ES_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_ES_RULES_PATH
Type: string
+

JAVASCRIPT_ES: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_ARGUMENTS
Type: array of string or string
+

JAVASCRIPT_PRETTIER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_PRETTIER_ARGUMENTS + + + + JAVASCRIPT_PRETTIER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_CONFIG_FILE
Type: string Default: ".prettierrc.json"
+

JAVASCRIPT_PRETTIER: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_PRETTIER_FILE_EXTENSIONS + + + + JAVASCRIPT_PRETTIER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX + + + + JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_PRETTIER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_PRETTIER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_PRETTIER_RULES_PATH
Type: string
+

JAVASCRIPT_PRETTIER: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_ARGUMENTS
Type: array of string or string
+

JAVASCRIPT_STANDARD: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_STANDARD_ARGUMENTS + + + + JAVASCRIPT_STANDARD_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_STANDARD_FILE_EXTENSIONS + + + + JAVASCRIPT_STANDARD_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_STANDARD_FILE_NAMES_REGEX + + + + JAVASCRIPT_STANDARD_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_STANDARD_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVASCRIPT_STANDARD_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVASCRIPT_STANDARD_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_ARGUMENTS
Type: array of string or string
+

JAVA_CHECKSTYLE: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVA_CHECKSTYLE_ARGUMENTS + + + + JAVA_CHECKSTYLE_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_CONFIG_FILE
Type: string Default: "sun_checks.xml"
+

JAVA_CHECKSTYLE: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVA_CHECKSTYLE_FILE_EXTENSIONS + + + + JAVA_CHECKSTYLE_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_FILE_NAME
Type: string Default: "sun_checks.xml"
+

JAVA_CHECKSTYLE: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVA_CHECKSTYLE_FILE_NAMES_REGEX + + + + JAVA_CHECKSTYLE_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVA_CHECKSTYLE_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVA_CHECKSTYLE_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JAVA_CHECKSTYLE_RULES_PATH
Type: string
+

JAVA_CHECKSTYLE: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_ARGUMENTS
Type: array of string or string
+

JAVA_PMD: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVA_PMD_ARGUMENTS + + + + JAVA_PMD_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_CONFIG_FILE
Type: string Default: "java-pmd-ruleset.xml"
+

JAVA_PMD: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVA_PMD_FILE_EXTENSIONS + + + + JAVA_PMD_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVA_PMD_FILE_NAMES_REGEX + + + + JAVA_PMD_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVA_PMD_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JAVA_PMD_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JAVA_PMD_RULES_PATH
Type: string
+

JAVA_PMD: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS
Type: array of string or string
+

JSONESLINTPLUGIN_JSONC: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS + + + + JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_CONFIG_FILE
Type: string Default: ".eslintrc-json.json"
+

JSONESLINTPLUGIN_JSONC: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS + + + + JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_FILE_NAME
Type: string Default: ".eslintrc.json"
+

JSONESLINTPLUGIN_JSONC: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX + + + + JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_ESLINT_PLUGIN_JSONC_RULES_PATH
Type: string
+

JSONESLINTPLUGIN_JSONC: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_ARGUMENTS
Type: array of string or string
+

JSON_JSONLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_JSONLINT_ARGUMENTS + + + + JSON_JSONLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_CONFIG_FILE
Type: string Default: ".jsonlintrc"
+

JSON_JSONLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_JSONLINT_FILE_EXTENSIONS + + + + JSON_JSONLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_JSONLINT_FILE_NAMES_REGEX + + + + JSON_JSONLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_JSONLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_JSONLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_JSONLINT_RULES_PATH
Type: string
+

JSON_JSONLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_ARGUMENTS
Type: array of string or string
+

JSONNPMPACKAGEJSONLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_ARGUMENTS + + + + JSON_NPM_PACKAGE_JSON_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_CONFIG_FILE
Type: string Default: ".npmpackagejsonlintrc.json"
+

JSONNPMPACKAGEJSONLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_FILE_EXTENSIONS + + + + JSON_NPM_PACKAGE_JSON_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_FILE_NAMES_REGEX + + + + JSON_NPM_PACKAGE_JSON_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_NPM_PACKAGE_JSON_LINT_RULES_PATH
Type: string
+

JSONNPMPACKAGEJSONLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_ARGUMENTS
Type: array of string or string
+

JSON_PRETTIER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_PRETTIER_ARGUMENTS + + + + JSON_PRETTIER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_CONFIG_FILE
Type: string Default: ".prettierrc.json"
+

JSON_PRETTIER: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_PRETTIER_FILE_EXTENSIONS + + + + JSON_PRETTIER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_PRETTIER_FILE_NAMES_REGEX + + + + JSON_PRETTIER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_PRETTIER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_PRETTIER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_PRETTIER_RULES_PATH
Type: string
+

JSON_PRETTIER: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_REPORTER
Type: boolean Default: false
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + 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"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_ARGUMENTS
Type: array of string or string
+

JSON_V8R: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_V8R_ARGUMENTS + + + + JSON_V8R_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_V8R_FILE_EXTENSIONS + + + + JSON_V8R_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_V8R_FILE_NAMES_REGEX + + + + JSON_V8R_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_V8R_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSON_V8R_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSON_V8R_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_ARGUMENTS
Type: array of string or string
+

JSX_ESLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSX_ESLINT_ARGUMENTS + + + + JSX_ESLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_CONFIG_FILE
Type: string Default: ".eslintrc.json"
+

JSX_ESLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSX_ESLINT_FILE_EXTENSIONS + + + + JSX_ESLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_FILE_NAME
Type: string Default: ".eslintrc.json"
+

JSX_ESLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSX_ESLINT_FILE_NAMES_REGEX + + + + JSX_ESLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSX_ESLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + JSX_ESLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + JSX_ESLINT_RULES_PATH
Type: string
+

JSX_ESLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + JSX_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_ARGUMENTS
Type: array of string or string
+

KOTLIN_KTLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KOTLIN_KTLINT_ARGUMENTS + + + + KOTLIN_KTLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KOTLIN_KTLINT_FILE_EXTENSIONS + + + + KOTLIN_KTLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KOTLIN_KTLINT_FILE_NAMES_REGEX + + + + KOTLIN_KTLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KOTLIN_KTLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KOTLIN_KTLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KOTLIN_KTLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_DIRECTORY
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_ARGUMENTS
Type: array of string or string
+

KUBERNETES_KUBECONFORM: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KUBERNETES_KUBECONFORM_ARGUMENTS + + + + KUBERNETES_KUBECONFORM_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_DIRECTORY
Type: string Default: "kubernetes"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KUBERNETES_KUBECONFORM_FILE_EXTENSIONS + + + + KUBERNETES_KUBECONFORM_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KUBERNETES_KUBECONFORM_FILE_NAMES_REGEX + + + + KUBERNETES_KUBECONFORM_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KUBERNETES_KUBECONFORM_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KUBERNETES_KUBECONFORM_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBECONFORM_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_ARGUMENTS
Type: array of string or string
+

KUBERNETES_KUBEVAL: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KUBERNETES_KUBEVAL_ARGUMENTS + + + + KUBERNETES_KUBEVAL_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_DIRECTORY
Type: string Default: "kubernetes"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KUBERNETES_KUBEVAL_FILE_EXTENSIONS + + + + KUBERNETES_KUBEVAL_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KUBERNETES_KUBEVAL_FILE_NAMES_REGEX + + + + KUBERNETES_KUBEVAL_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KUBERNETES_KUBEVAL_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + KUBERNETES_KUBEVAL_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + KUBERNETES_KUBEVAL_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_ARGUMENTS
Type: array of string or string
+

LATEX_CHKTEX: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + LATEX_CHKTEX_ARGUMENTS + + + + LATEX_CHKTEX_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_CONFIG_FILE
Type: string Default: ".chktexrc"
+

LATEX_CHKTEX: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + LATEX_CHKTEX_FILE_EXTENSIONS + + + + LATEX_CHKTEX_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_FILE_NAME
Type: string Default: ".chktexrc"
+

LATEX_CHKTEX: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + LATEX_CHKTEX_FILE_NAMES_REGEX + + + + LATEX_CHKTEX_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + LATEX_CHKTEX_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + LATEX_CHKTEX_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + LATEX_CHKTEX_RULES_PATH
Type: string
+

LATEX_CHKTEX: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LATEX_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + 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"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LOG_FILE
Type: string Default: "mega-linter.log"
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + 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"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_ARGUMENTS
Type: array of string or string
+

LUA_LUACHECK: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + LUA_LUACHECK_ARGUMENTS + + + + LUA_LUACHECK_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_CONFIG_FILE
Type: string Default: ".luacheckrc"
+

LUA_LUACHECK: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + LUA_LUACHECK_FILE_EXTENSIONS + + + + LUA_LUACHECK_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_FILE_NAME
Type: string Default: ".luacheckrc"
+

LUA_LUACHECK: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + LUA_LUACHECK_FILE_NAMES_REGEX + + + + LUA_LUACHECK_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + LUA_LUACHECK_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + LUA_LUACHECK_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + LUA_LUACHECK_RULES_PATH
Type: string
+

LUA_LUACHECK: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_ARGUMENTS
Type: array of string or string
+

MAKEFILE_CHECKMAKE: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MAKEFILE_CHECKMAKE_ARGUMENTS + + + + MAKEFILE_CHECKMAKE_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_CONFIG_FILE
Type: string Default: ".checkmake.ini"
+

MAKEFILE_CHECKMAKE: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MAKEFILE_CHECKMAKE_FILE_EXTENSIONS + + + + MAKEFILE_CHECKMAKE_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MAKEFILE_CHECKMAKE_FILE_NAMES_REGEX + + + + MAKEFILE_CHECKMAKE_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MAKEFILE_CHECKMAKE_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MAKEFILE_CHECKMAKE_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_CHECKMAKE_RULES_PATH
Type: string
+

MAKEFILE_CHECKMAKE: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MAKEFILE_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_DEFAULT_STYLE
Type: enum (of string)
+

Style of markdown formatting to apply

+
+

Must be one of:

+
  • "markdownlint"
  • "remark-lint"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_ARGUMENTS
Type: array of string or string
+

MARKDOWN_MARKDOWNLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWNLINT_ARGUMENTS + + + + MARKDOWN_MARKDOWNLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_CONFIG_FILE
Type: string Default: ".markdownlint.json"
+

MARKDOWN_MARKDOWNLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS + + + + MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_FILE_NAME
Type: string Default: ".markdownlint.json"
+

MARKDOWN_MARKDOWNLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX + + + + MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWNLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWNLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWNLINT_RULES_PATH
Type: string
+

MARKDOWN_MARKDOWNLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+ + + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS
Type: array of string or string
+

MARKDOWNMARKDOWNTABLE_FORMATTER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_ARGUMENTS
Type: array of string
+

MARKDOWNMARKDOWNTABLE_PRETTIFY: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_ARGUMENTS + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_EXTENSIONS + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_NAMES_REGEX + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_ARGUMENTS
Type: array of string or string
+

MARKDOWNREMARKLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_REMARK_LINT_ARGUMENTS + + + + MARKDOWN_REMARK_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_CONFIG_FILE
Type: string Default: ".remarkrc"
+

MARKDOWNREMARKLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_REMARK_LINT_FILE_EXTENSIONS + + + + MARKDOWN_REMARK_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX + + + + MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_REMARK_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MARKDOWN_REMARK_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + MARKDOWN_REMARK_LINT_RULES_PATH
Type: string
+

MARKDOWNREMARKLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MEGALINTER_FILES_TO_LINT
Type: array of string
+

Comma-separated list of files to analyze. Using this variable will bypass other file listing methods

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + MEGALINTER_FILES_TO_LINT + + + + MEGALINTER_FILES_TO_LINT items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + MULTI_STATUS
Type: boolean Default: true
+

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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_ARGUMENTS
Type: array of string or string
+

OPENAPI_SPECTRAL: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + OPENAPI_SPECTRAL_ARGUMENTS + + + + OPENAPI_SPECTRAL_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_CONFIG_FILE
Type: string Default: ".openapirc.yml"
+

OPENAPI_SPECTRAL: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + OPENAPI_SPECTRAL_FILE_EXTENSIONS + + + + OPENAPI_SPECTRAL_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_FILE_NAME
Type: string Default: ".openapirc.yml"
+

OPENAPI_SPECTRAL: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + OPENAPI_SPECTRAL_FILE_NAMES_REGEX + + + + OPENAPI_SPECTRAL_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + OPENAPI_SPECTRAL_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + OPENAPI_SPECTRAL_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + OPENAPI_SPECTRAL_RULES_PATH
Type: string
+

OPENAPI_SPECTRAL: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OUTPUT_DETAIL
Type: enum (of string)
+

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

+
+

Must be one of:

+
  • "simple"
  • "detailed"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + OUTPUT_FORMAT
Type: enum (of string)
+

(DEPRECATED) Output format: text or tap

+
+

Must be one of:

+
  • "text"
  • "tap"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PARALLEL
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

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_ARGUMENTS
Type: array of string or string
+

PERL_PERLCRITIC: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PERL_PERLCRITIC_ARGUMENTS + + + + PERL_PERLCRITIC_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PERL_PERLCRITIC_FILE_EXTENSIONS + + + + PERL_PERLCRITIC_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PERL_PERLCRITIC_FILE_NAMES_REGEX + + + + PERL_PERLCRITIC_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PERL_PERLCRITIC_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PERL_PERLCRITIC_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PERL_PERLCRITIC_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_ARGUMENTS
Type: array of string or string
+

PHP_BUILTIN: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_BUILTIN_ARGUMENTS + + + + PHP_BUILTIN_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_CLI_EXECUTABLE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_BUILTIN_FILE_EXTENSIONS + + + + PHP_BUILTIN_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_BUILTIN_FILE_NAMES_REGEX + + + + PHP_BUILTIN_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_BUILTIN_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_BUILTIN_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_BUILTIN_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_ARGUMENTS
Type: array of string or string
+

PHP_PHPCS: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPCS_ARGUMENTS + + + + PHP_PHPCS_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_CONFIG_FILE
Type: string Default: "phpcs.xml"
+

PHP_PHPCS: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPCS_FILE_EXTENSIONS + + + + PHP_PHPCS_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_FILE_NAME
Type: string Default: "phpcs.xml"
+

PHP_PHPCS: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPCS_FILE_NAMES_REGEX + + + + PHP_PHPCS_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPCS_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPCS_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPCS_RULES_PATH
Type: string
+

PHP_PHPCS: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_ARGUMENTS
Type: array of string or string
+

PHP_PHPLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPLINT_ARGUMENTS + + + + PHP_PHPLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_CONFIG_FILE
Type: string Default: ".phplint.yml"
+

PHP_PHPLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPLINT_FILE_EXTENSIONS + + + + PHP_PHPLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_FILE_NAME
Type: string Default: ".phplint.yml"
+

PHP_PHPLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPLINT_FILE_NAMES_REGEX + + + + PHP_PHPLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPLINT_RULES_PATH
Type: string
+

PHP_PHPLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_ARGUMENTS
Type: array of string or string
+

PHP_PHPSTAN: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPSTAN_ARGUMENTS + + + + PHP_PHPSTAN_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_CONFIG_FILE
Type: string Default: "phpstan.neon.dist"
+

PHP_PHPSTAN: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPSTAN_FILE_EXTENSIONS + + + + PHP_PHPSTAN_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_FILE_NAME
Type: string Default: "phpstan.neon"
+

PHP_PHPSTAN: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPSTAN_FILE_NAMES_REGEX + + + + PHP_PHPSTAN_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPSTAN_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PHPSTAN_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PHPSTAN_RULES_PATH
Type: string
+

PHP_PHPSTAN: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_ARGUMENTS
Type: array of string or string
+

PHP_PSALM: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PSALM_ARGUMENTS + + + + PHP_PSALM_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_CONFIG_FILE
Type: string Default: "psalm.xml"
+

PHP_PSALM: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PSALM_FILE_EXTENSIONS + + + + PHP_PSALM_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_FILE_NAME
Type: string Default: "psalm.xml"
+

PHP_PSALM: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PSALM_FILE_NAMES_REGEX + + + + PHP_PSALM_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PSALM_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PHP_PSALM_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PHP_PSALM_RULES_PATH
Type: string
+

PHP_PSALM: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PLUGINS
Type: array of string
+

List of MegaLinter plugins. URL must follow format https:///mega-linter-plugin-/**.mega-linter-descriptor.yml

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PLUGINS + + + + PLUGINS items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "https://raw.githubusercontent.com/cookiejar/megalinter-plugin-cookiejar/master/cookietemplate.mega-linter-descriptor.yml"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POST_COMMANDS
Type: array Default: []
+

Custom bash commands to run after linters

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + POST_GITHUB_COMMENT
Type: boolean Default: true
+

(DEPRECATED, use GITHUBCOMMENTREPORTER) Posts MegaLinter results summary in the comments of the related pull request (if existing)

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POST_GITLAB_COMMENT
Type: boolean Default: true
+

(DEPRECATED, use GITHUBCOMMENTREPORTER) Posts MegaLinter results summary in the comments of the related merge request (if existing)

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_ARGUMENTS
Type: array of string or string
+

POWERSHELL_POWERSHELL: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + POWERSHELL_POWERSHELL_ARGUMENTS + + + + POWERSHELL_POWERSHELL_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_CONFIG_FILE
Type: string Default: ".powershell-psscriptanalyzer.psd1"
+

POWERSHELL_POWERSHELL: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + POWERSHELL_POWERSHELL_FILE_EXTENSIONS + + + + POWERSHELL_POWERSHELL_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FILE_NAME
Type: string Default: ".powershell-psscriptanalyzer.psd1"
+

POWERSHELL_POWERSHELL: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + POWERSHELL_POWERSHELL_FILE_NAMES_REGEX + + + + POWERSHELL_POWERSHELL_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_ARGUMENTS
Type: array of string or string
+

POWERSHELLPOWERSHELLFORMATTER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_ARGUMENTS + + + + POWERSHELL_POWERSHELL_FORMATTER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_CONFIG_FILE
Type: string Default: ".powershell-formatter.psd1"
+

POWERSHELLPOWERSHELLFORMATTER: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_FILE_EXTENSIONS + + + + POWERSHELL_POWERSHELL_FORMATTER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_FILE_NAMES_REGEX + + + + POWERSHELL_POWERSHELL_FORMATTER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_FORMATTER_RULES_PATH
Type: string
+

POWERSHELLPOWERSHELLFORMATTER: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + POWERSHELL_POWERSHELL_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + POWERSHELL_POWERSHELL_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + POWERSHELL_POWERSHELL_RULES_PATH
Type: string
+

POWERSHELL_POWERSHELL: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PRE_COMMANDS
Type: array Default: []
+

Custom bash commands to run before linters

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm install java-caller",
+        "continue_if_failed": false,
+        "cwd": "root"
+    },
+    {
+        "command": "echo \"pre-run command has been called\"",
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ + +
+
+
+
+
+

+ +

+
+ + +
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_ARGUMENTS
Type: array of string or string
+

PROTOBUF_PROTOLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PROTOBUF_PROTOLINT_ARGUMENTS + + + + PROTOBUF_PROTOLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_CONFIG_FILE
Type: string Default: ".protolintrc.yml"
+

PROTOBUF_PROTOLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PROTOBUF_PROTOLINT_FILE_EXTENSIONS + + + + PROTOBUF_PROTOLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_FILE_NAME
Type: string Default: ".protolintrc.yml"
+

PROTOBUF_PROTOLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PROTOBUF_PROTOLINT_FILE_NAMES_REGEX + + + + PROTOBUF_PROTOLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PROTOBUF_PROTOLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PROTOBUF_PROTOLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PROTOBUF_PROTOLINT_RULES_PATH
Type: string
+

PROTOBUF_PROTOLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_ARGUMENTS
Type: array of string or string
+

PUPPETPUPPETLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PUPPET_PUPPET_LINT_ARGUMENTS + + + + PUPPET_PUPPET_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_CONFIG_FILE
Type: string Default: ".puppet-lint.rc"
+

PUPPETPUPPETLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PUPPET_PUPPET_LINT_FILE_EXTENSIONS + + + + PUPPET_PUPPET_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_FILE_NAME
Type: string Default: ".puppet-lint.rc"
+

PUPPETPUPPETLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PUPPET_PUPPET_LINT_FILE_NAMES_REGEX + + + + PUPPET_PUPPET_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PUPPET_PUPPET_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PUPPET_PUPPET_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PUPPET_PUPPET_LINT_RULES_PATH
Type: string
+

PUPPETPUPPETLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_ARGUMENTS
Type: array of string or string
+

PYTHON_BANDIT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_BANDIT_ARGUMENTS + + + + PYTHON_BANDIT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_CONFIG_FILE
Type: string Default: ".bandit.yml"
+

PYTHON_BANDIT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_BANDIT_FILE_EXTENSIONS + + + + PYTHON_BANDIT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_BANDIT_FILE_NAMES_REGEX + + + + PYTHON_BANDIT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_BANDIT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_BANDIT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_BANDIT_RULES_PATH
Type: string
+

PYTHON_BANDIT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_ARGUMENTS
Type: array of string or string
+

PYTHON_BLACK: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_BLACK_ARGUMENTS + + + + PYTHON_BLACK_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_CONFIG_FILE
Type: string Default: "pyproject.toml"
+

PYTHON_BLACK: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_BLACK_FILE_EXTENSIONS + + + + PYTHON_BLACK_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_FILE_NAME
Type: string Default: ".python-black"
+

PYTHON_BLACK: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_BLACK_FILE_NAMES_REGEX + + + + PYTHON_BLACK_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_BLACK_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_BLACK_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_BLACK_RULES_PATH
Type: string
+

PYTHON_BLACK: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_ARGUMENTS
Type: array of string or string
+

PYTHON_FLAKE8: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_FLAKE8_ARGUMENTS + + + + PYTHON_FLAKE8_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_CONFIG_FILE
Type: string Default: ".flake8"
+

PYTHON_FLAKE8: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_FLAKE8_FILE_EXTENSIONS + + + + PYTHON_FLAKE8_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_FILE_NAME
Type: string Default: ".flake8"
+

PYTHON_FLAKE8: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_FLAKE8_FILE_NAMES_REGEX + + + + PYTHON_FLAKE8_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_FLAKE8_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_FLAKE8_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_FLAKE8_RULES_PATH
Type: string
+

PYTHON_FLAKE8: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_ARGUMENTS
Type: array of string or string
+

PYTHON_ISORT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_ISORT_ARGUMENTS + + + + PYTHON_ISORT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_CONFIG_FILE
Type: string Default: ".isort.cfg"
+

PYTHON_ISORT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_ISORT_FILE_EXTENSIONS + + + + PYTHON_ISORT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_FILE_NAME
Type: string Default: ".isort.cfg"
+

PYTHON_ISORT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_ISORT_FILE_NAMES_REGEX + + + + PYTHON_ISORT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_ISORT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_ISORT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_ISORT_RULES_PATH
Type: string
+

PYTHON_ISORT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_ARGUMENTS
Type: array of string or string
+

PYTHON_MYPY: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_MYPY_ARGUMENTS + + + + PYTHON_MYPY_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_CONFIG_FILE
Type: string Default: ".mypy.ini"
+

PYTHON_MYPY: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_MYPY_FILE_EXTENSIONS + + + + PYTHON_MYPY_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_MYPY_FILE_NAMES_REGEX + + + + PYTHON_MYPY_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_MYPY_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_MYPY_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_MYPY_RULES_PATH
Type: string
+

PYTHON_MYPY: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_ARGUMENTS
Type: array of string or string
+

PYTHON_PYLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_PYLINT_ARGUMENTS + + + + PYTHON_PYLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_CONFIG_FILE
Type: string Default: ".pylintrc"
+

PYTHON_PYLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_PYLINT_FILE_EXTENSIONS + + + + PYTHON_PYLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_FILE_NAME
Type: string Default: ".python-lint"
+

PYTHON_PYLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_PYLINT_FILE_NAMES_REGEX + + + + PYTHON_PYLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_PYLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_PYLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYLINT_RULES_PATH
Type: string
+

PYTHON_PYLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_ARGUMENTS
Type: array of string or string
+

PYTHON_PYRIGHT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_PYRIGHT_ARGUMENTS + + + + PYTHON_PYRIGHT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_CONFIG_FILE
Type: string Default: "pyrightconfig.json"
+

PYTHON_PYRIGHT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_PYRIGHT_FILE_EXTENSIONS + + + + PYTHON_PYRIGHT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_PYRIGHT_FILE_NAMES_REGEX + + + + PYTHON_PYRIGHT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_PYRIGHT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + PYTHON_PYRIGHT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + PYTHON_PYRIGHT_RULES_PATH
Type: string
+

PYTHON_PYRIGHT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_ARGUMENTS
Type: array of string or string
+

RAKU_RAKU: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RAKU_RAKU_ARGUMENTS + + + + RAKU_RAKU_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_CONFIG_FILE
Type: string Default: "META6.json"
+

RAKU_RAKU: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RAKU_RAKU_FILE_EXTENSIONS + + + + RAKU_RAKU_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_FILE_NAME
Type: string Default: "META6.json"
+

RAKU_RAKU: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RAKU_RAKU_FILE_NAMES_REGEX + + + + RAKU_RAKU_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RAKU_RAKU_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RAKU_RAKU_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + RAKU_RAKU_RULES_PATH
Type: string
+

RAKU_RAKU: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + 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"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPORT_OUTPUT_FOLDER
Type: string Default: "report"
+

The location where the output reporting will be generated to

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_ARGUMENTS
Type: array of string or string
+

REPOSITORY_CHECKOV: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_CHECKOV_ARGUMENTS + + + + REPOSITORY_CHECKOV_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_CONFIG_FILE
Type: string Default: ".checkov.yml"
+

REPOSITORY_CHECKOV: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_CHECKOV_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_CHECKOV_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_CHECKOV_RULES_PATH
Type: string
+

REPOSITORY_CHECKOV: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_ARGUMENTS
Type: array of string or string
+

REPOSITORY_DEVSKIM: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_DEVSKIM_ARGUMENTS + + + + REPOSITORY_DEVSKIM_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_DEVSKIM_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_DEVSKIM_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DEVSKIM_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_ARGUMENTS
Type: array of string or string
+

REPOSITORY_DUSTILOCK: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_DUSTILOCK_ARGUMENTS + + + + REPOSITORY_DUSTILOCK_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_DUSTILOCK_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_DUSTILOCK_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_DUSTILOCK_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_ARGUMENTS
Type: array of string or string
+

REPOSITORY_GITLEAKS: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_GITLEAKS_ARGUMENTS + + + + REPOSITORY_GITLEAKS_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_CONFIG_FILE
Type: string Default: ".gitleaks.toml"
+

REPOSITORY_GITLEAKS: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_GITLEAKS_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_GITLEAKS_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GITLEAKS_RULES_PATH
Type: string
+

REPOSITORY_GITLEAKS: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_ARGUMENTS
Type: array of string or string
+

REPOSITORYGITDIFF: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_GIT_DIFF_ARGUMENTS + + + + REPOSITORY_GIT_DIFF_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_GIT_DIFF_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_GIT_DIFF_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GIT_DIFF_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_ARGUMENTS
Type: array of string or string
+

REPOSITORY_GOODCHECK: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_GOODCHECK_ARGUMENTS + + + + REPOSITORY_GOODCHECK_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_CONFIG_FILE
Type: string Default: "goodcheck.yml"
+

REPOSITORY_GOODCHECK: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_GOODCHECK_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_GOODCHECK_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_GOODCHECK_RULES_PATH
Type: string
+

REPOSITORY_GOODCHECK: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_ARGUMENTS
Type: array of string or string
+

REPOSITORY_SECRETLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_SECRETLINT_ARGUMENTS + + + + REPOSITORY_SECRETLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_CONFIG_FILE
Type: string Default: ".secretlintrc.json"
+

REPOSITORY_SECRETLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_SECRETLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_SECRETLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SECRETLINT_RULES_PATH
Type: string
+

REPOSITORY_SECRETLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_ARGUMENTS
Type: array of string or string
+

REPOSITORY_SEMGREP: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_SEMGREP_ARGUMENTS + + + + REPOSITORY_SEMGREP_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_SEMGREP_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_SEMGREP_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SEMGREP_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_ARGUMENTS
Type: array of string or string
+

REPOSITORY_SYFT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_SYFT_ARGUMENTS + + + + REPOSITORY_SYFT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_CONFIG_FILE
Type: string Default: ".syft.yaml"
+

REPOSITORY_SYFT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_SYFT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_SYFT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_SYFT_RULES_PATH
Type: string
+

REPOSITORY_SYFT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_ARGUMENTS
Type: array of string or string
+

REPOSITORY_TRIVY: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_TRIVY_ARGUMENTS + + + + REPOSITORY_TRIVY_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_CONFIG_FILE
Type: string Default: "trivy.yaml"
+

REPOSITORY_TRIVY: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_TRIVY_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + REPOSITORY_TRIVY_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + REPOSITORY_TRIVY_RULES_PATH
Type: string
+

REPOSITORY_TRIVY: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_ARGUMENTS
Type: array of string or string
+

RST_RSTCHECK: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RSTCHECK_ARGUMENTS + + + + RST_RSTCHECK_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_CONFIG_FILE
Type: string Default: ".rstcheck.cfg"
+

RST_RSTCHECK: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RSTCHECK_FILE_EXTENSIONS + + + + RST_RSTCHECK_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_FILE_NAME
Type: string Default: ".rstcheck.cfg"
+

RST_RSTCHECK: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RSTCHECK_FILE_NAMES_REGEX + + + + RST_RSTCHECK_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RSTCHECK_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RSTCHECK_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + RST_RSTCHECK_RULES_PATH
Type: string
+

RST_RSTCHECK: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_ARGUMENTS
Type: array of string or string
+

RST_RSTFMT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RSTFMT_ARGUMENTS + + + + RST_RSTFMT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RSTFMT_FILE_EXTENSIONS + + + + RST_RSTFMT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RSTFMT_FILE_NAMES_REGEX + + + + RST_RSTFMT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RSTFMT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RSTFMT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RSTFMT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_ARGUMENTS
Type: array of string or string
+

RSTRSTLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RST_LINT_ARGUMENTS + + + + RST_RST_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RST_LINT_FILE_EXTENSIONS + + + + RST_RST_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RST_LINT_FILE_NAMES_REGEX + + + + RST_RST_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RST_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RST_RST_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RST_RST_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + RUBY_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_ARGUMENTS
Type: array of string or string
+

RUBY_RUBOCOP: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RUBY_RUBOCOP_ARGUMENTS + + + + RUBY_RUBOCOP_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_CONFIG_FILE
Type: string Default: ".ruby-lint.yml"
+

RUBY_RUBOCOP: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RUBY_RUBOCOP_FILE_EXTENSIONS + + + + RUBY_RUBOCOP_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_FILE_NAME
Type: string Default: ".ruby-lint.yml"
+

RUBY_RUBOCOP: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RUBY_RUBOCOP_FILE_NAMES_REGEX + + + + RUBY_RUBOCOP_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

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

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RUBY_RUBOCOP_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RUBY_RUBOCOP_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

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

+ +

+
+ +
+
+ +
root + + + + RUBY_RUBOCOP_RULES_PATH
Type: string
+

RUBY_RUBOCOP: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_ARGUMENTS
Type: array of string or string
+

RUST_CLIPPY: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RUST_CLIPPY_ARGUMENTS + + + + RUST_CLIPPY_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_CONFIG_FILE
Type: string Default: ".clippy.toml"
+

RUST_CLIPPY: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RUST_CLIPPY_FILE_EXTENSIONS + + + + RUST_CLIPPY_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_FILE_NAME
Type: string Default: ".clippy.toml"
+

RUST_CLIPPY: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RUST_CLIPPY_FILE_NAMES_REGEX + + + + RUST_CLIPPY_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RUST_CLIPPY_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + RUST_CLIPPY_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_CLIPPY_RULES_PATH
Type: string
+

RUST_CLIPPY: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + RUST_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_ARGUMENTS
Type: array of string or string
+

R_LINTR: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + R_LINTR_ARGUMENTS + + + + R_LINTR_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_CONFIG_FILE
Type: string Default: ".lintr"
+

R_LINTR: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + R_LINTR_FILE_EXTENSIONS + + + + R_LINTR_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_FILE_NAME
Type: string Default: ".lintr"
+

R_LINTR: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + R_LINTR_FILE_NAMES_REGEX + + + + R_LINTR_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + R_LINTR_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + R_LINTR_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + R_LINTR_RULES_PATH
Type: string
+

R_LINTR: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_DIRECTORY
Type: string Default: "force-app"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS
Type: array of string or string
+

SALESFORCESFDXSCANNER_APEX: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS + + + + SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_CONFIG_FILE
Type: string Default: "apex-pmd-ruleset.xml"
+

SALESFORCESFDXSCANNER_APEX: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_DIRECTORY
Type: string Default: "force-app"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_APEX_RULES_PATH
Type: string
+

SALESFORCESFDXSCANNER_APEX: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_ARGUMENTS
Type: array of string or string
+

SALESFORCESFDXSCANNER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_ARGUMENTS + + + + SALESFORCE_SFDX_SCANNER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS
Type: array of string or string
+

SALESFORCESFDXSCANNER_AURA: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS + + + + SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_CONFIG_FILE
Type: string Default: "--eslintconfig"
+

SALESFORCESFDXSCANNER_AURA: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_DIRECTORY
Type: string Default: "force-app"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_AURA_RULES_PATH
Type: string
+

SALESFORCESFDXSCANNER_AURA: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_DIRECTORY
Type: string Default: "force-app"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_FILE_EXTENSIONS + + + + SALESFORCE_SFDX_SCANNER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_FILE_NAMES_REGEX + + + + SALESFORCE_SFDX_SCANNER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS
Type: array of string or string
+

SALESFORCESFDXSCANNER_LWC: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS + + + + SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_CONFIG_FILE
Type: string Default: "--eslintconfig"
+

SALESFORCESFDXSCANNER_LWC: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_DIRECTORY
Type: string Default: "force-app"
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SALESFORCE_SFDX_SCANNER_LWC_RULES_PATH
Type: string
+

SALESFORCESFDXSCANNER_LWC: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SARIF_REPORTER
Type: boolean Default: false
+

Generate SARIF reports that can be used to display issues directly in GitHub UI

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SARIF_REPORTER_FILE_NAME
Type: string Default: "mega-linter-report.sarif"
+

Override SARIF output file name

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SARIF_REPORTER_LINTERS
Type: array
+

If SARIFREPORTERLINTERS is set, only the linters in the list will output SARIF

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SARIF_REPORTER_LINTERS + + + + enum_linter_keys
Type: enum (of string)
+ + +
+

Must be one of:

+
  • "ACTION_ACTIONLINT"
  • "ANSIBLE_ANSIBLE_LINT"
  • "ARM_ARM_TTK"
  • "BASH_EXEC"
  • "BASH_SHELLCHECK"
  • "BASH_SHFMT"
  • "BICEP_BICEP_LINTER"
  • "C_CPPLINT"
  • "CLOJURE_CLJ_KONDO"
  • "CLOUDFORMATION_CFN_LINT"
  • "COFFEE_COFFEELINT"
  • "COPYPASTE_JSCPD"
  • "CPP_CPPLINT"
  • "CSHARP_DOTNET_FORMAT"
  • "CSHARP_CSHARPIER"
  • "CSS_STYLELINT"
  • "CSS_SCSS_LINT"
  • "DART_DARTANALYZER"
  • "DOCKERFILE_HADOLINT"
  • "EDITORCONFIG_EDITORCONFIG_CHECKER"
  • "ENV_DOTENV_LINTER"
  • "GHERKIN_GHERKIN_LINT"
  • "GO_GOLANGCI_LINT"
  • "GO_REVIVE"
  • "GRAPHQL_GRAPHQL_SCHEMA_LINTER"
  • "GROOVY_NPM_GROOVY_LINT"
  • "HTML_DJLINT"
  • "HTML_HTMLHINT"
  • "JAVA_CHECKSTYLE"
  • "JAVA_PMD"
  • "JAVASCRIPT_ES"
  • "JAVASCRIPT_STANDARD"
  • "JAVASCRIPT_PRETTIER"
  • "JSON_JSONLINT"
  • "JSON_ESLINT_PLUGIN_JSONC"
  • "JSON_V8R"
  • "JSON_PRETTIER"
  • "JSON_NPM_PACKAGE_JSON_LINT"
  • "JSX_ESLINT"
  • "KOTLIN_KTLINT"
  • "KUBERNETES_KUBEVAL"
  • "KUBERNETES_KUBECONFORM"
  • "LATEX_CHKTEX"
  • "LUA_LUACHECK"
  • "MAKEFILE_CHECKMAKE"
  • "MARKDOWN_MARKDOWNLINT"
  • "MARKDOWN_REMARK_LINT"
  • "MARKDOWN_MARKDOWN_LINK_CHECK"
  • "MARKDOWN_MARKDOWN_TABLE_FORMATTER"
  • "OPENAPI_SPECTRAL"
  • "PERL_PERLCRITIC"
  • "PHP_PHPCS"
  • "PHP_PHPSTAN"
  • "PHP_PSALM"
  • "PHP_PHPLINT"
  • "POWERSHELL_POWERSHELL"
  • "POWERSHELL_POWERSHELL_FORMATTER"
  • "PROTOBUF_PROTOLINT"
  • "PUPPET_PUPPET_LINT"
  • "PYTHON_PYLINT"
  • "PYTHON_BLACK"
  • "PYTHON_FLAKE8"
  • "PYTHON_ISORT"
  • "PYTHON_BANDIT"
  • "PYTHON_MYPY"
  • "PYTHON_PYRIGHT"
  • "R_LINTR"
  • "RAKU_RAKU"
  • "REPOSITORY_CHECKOV"
  • "REPOSITORY_DEVSKIM"
  • "REPOSITORY_DUSTILOCK"
  • "REPOSITORY_GIT_DIFF"
  • "REPOSITORY_GITLEAKS"
  • "REPOSITORY_GOODCHECK"
  • "REPOSITORY_SECRETLINT"
  • "REPOSITORY_SEMGREP"
  • "REPOSITORY_SYFT"
  • "REPOSITORY_TRIVY"
  • "RST_RST_LINT"
  • "RST_RSTCHECK"
  • "RST_RSTFMT"
  • "RUBY_RUBOCOP"
  • "RUST_CLIPPY"
  • "SALESFORCE_SFDX_SCANNER_APEX"
  • "SALESFORCE_SFDX_SCANNER_AURA"
  • "SALESFORCE_SFDX_SCANNER_LWC"
  • "SCALA_SCALAFIX"
  • "SNAKEMAKE_LINT"
  • "SNAKEMAKE_SNAKEFMT"
  • "SPELL_MISSPELL"
  • "SPELL_CSPELL"
  • "SPELL_PROSELINT"
  • "SQL_SQL_LINT"
  • "SQL_SQLFLUFF"
  • "SQL_TSQLLINT"
  • "SWIFT_SWIFTLINT"
  • "TEKTON_TEKTON_LINT"
  • "TERRAFORM_TFLINT"
  • "TERRAFORM_TERRASCAN"
  • "TERRAFORM_TERRAGRUNT"
  • "TERRAFORM_TERRAFORM_FMT"
  • "TERRAFORM_CHECKOV"
  • "TERRAFORM_KICS"
  • "TSX_ESLINT"
  • "TYPESCRIPT_ES"
  • "TYPESCRIPT_STANDARD"
  • "TYPESCRIPT_PRETTIER"
  • "VBDOTNET_DOTNET_FORMAT"
  • "XML_XMLLINT"
  • "YAML_PRETTIER"
  • "YAML_YAMLLINT"
  • "YAML_V8R"
  • "CREDENTIALS_SECRETLINT"
  • "DOCKERFILE_DOCKERFILELINT"
  • "GIT_GIT_DIFF"
  • "PHP_BUILTIN"
+
+ + + + + + +
+

+
Example:
+
[
+    "BASH_BASH_SHFMT",
+    "JAVASCRIPT_STANDARD"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_ARGUMENTS
Type: array of string or string
+

SCALA_SCALAFIX: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SCALA_SCALAFIX_ARGUMENTS + + + + SCALA_SCALAFIX_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_CONFIG_FILE
Type: string Default: ".scalafix.conf"
+

SCALA_SCALAFIX: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SCALA_SCALAFIX_FILE_EXTENSIONS + + + + SCALA_SCALAFIX_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_FILE_NAME
Type: string Default: ".scalafix.conf"
+

SCALA_SCALAFIX: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SCALA_SCALAFIX_FILE_NAMES_REGEX + + + + SCALA_SCALAFIX_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SCALA_SCALAFIX_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SCALA_SCALAFIX_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SCALA_SCALAFIX_RULES_PATH
Type: string
+

SCALA_SCALAFIX: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SHOW_ELAPSED_TIME
Type: boolean Default: false
+

Displays elapsed time for each linter in reports

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SHOW_SKIPPED_LINTERS
Type: boolean Default: true
+

Displays all linters that mega-linter could run but didn't

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SKIP_CLI_LINT_MODES
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

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SKIP_CLI_LINT_MODES + + + + SKIP_CLI_LINT_MODES items
Type: enum (of string)
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_ARGUMENTS
Type: array of string or string
+

SNAKEMAKE_LINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SNAKEMAKE_LINT_ARGUMENTS + + + + SNAKEMAKE_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SNAKEMAKE_LINT_FILE_EXTENSIONS + + + + SNAKEMAKE_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SNAKEMAKE_LINT_FILE_NAMES_REGEX + + + + SNAKEMAKE_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SNAKEMAKE_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SNAKEMAKE_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_ARGUMENTS
Type: array of string or string
+

SNAKEMAKE_SNAKEFMT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SNAKEMAKE_SNAKEFMT_ARGUMENTS + + + + SNAKEMAKE_SNAKEFMT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_CONFIG_FILE
Type: string Default: ".snakefmt.toml"
+

SNAKEMAKE_SNAKEFMT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS + + + + SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_FILE_NAME
Type: string Default: ".snakefmt.toml"
+

SNAKEMAKE_SNAKEFMT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX + + + + SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SNAKEMAKE_SNAKEFMT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SNAKEMAKE_SNAKEFMT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SNAKEMAKE_SNAKEFMT_RULES_PATH
Type: string
+

SNAKEMAKE_SNAKEFMT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_ANALYZE_FILE_NAMES
Type: boolean Default: false
+

If set to true, MegaLinter will also send file names to cspell for analysis.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_ARGUMENTS
Type: array of string or string
+

SPELL_CSPELL: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_CSPELL_ARGUMENTS + + + + SPELL_CSPELL_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_CONFIG_FILE
Type: string Default: ".cspell.json"
+

SPELL_CSPELL: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_CSPELL_FILE_EXTENSIONS + + + + SPELL_CSPELL_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_FILE_NAME
Type: string Default: ".cspell.json"
+

SPELL_CSPELL: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_CSPELL_FILE_NAMES_REGEX + + + + SPELL_CSPELL_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_CSPELL_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_CSPELL_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_CSPELL_RULES_PATH
Type: string
+

SPELL_CSPELL: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_ARGUMENTS
Type: array of string or string
+

SPELL_MISSPELL: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_MISSPELL_ARGUMENTS + + + + SPELL_MISSPELL_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_MISSPELL_FILE_EXTENSIONS + + + + SPELL_MISSPELL_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_MISSPELL_FILE_NAMES_REGEX + + + + SPELL_MISSPELL_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_MISSPELL_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_MISSPELL_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_MISSPELL_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_ARGUMENTS
Type: array of string or string
+

SPELL_PROSELINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_PROSELINT_ARGUMENTS + + + + SPELL_PROSELINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_CONFIG_FILE
Type: string Default: ".proselintrc"
+

SPELL_PROSELINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_PROSELINT_FILE_EXTENSIONS + + + + SPELL_PROSELINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_PROSELINT_FILE_NAMES_REGEX + + + + SPELL_PROSELINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_PROSELINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SPELL_PROSELINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SPELL_PROSELINT_RULES_PATH
Type: string
+

SPELL_PROSELINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_ARGUMENTS
Type: array of string or string
+

SQL_SQLFLUFF: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_SQLFLUFF_ARGUMENTS + + + + SQL_SQLFLUFF_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_CONFIG_FILE
Type: string Default: ".sqlfluff"
+

SQL_SQLFLUFF: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_SQLFLUFF_FILE_EXTENSIONS + + + + SQL_SQLFLUFF_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_SQLFLUFF_FILE_NAMES_REGEX + + + + SQL_SQLFLUFF_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_SQLFLUFF_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_SQLFLUFF_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQLFLUFF_RULES_PATH
Type: string
+

SQL_SQLFLUFF: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_ARGUMENTS
Type: array of string or string
+

SQLSQLLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_SQL_LINT_ARGUMENTS + + + + SQL_SQL_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_CONFIG_FILE
Type: string Default: ".sql-config.json"
+

SQLSQLLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_SQL_LINT_FILE_EXTENSIONS + + + + SQL_SQL_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_FILE_NAME
Type: string Default: ".sql-config.json"
+

SQLSQLLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_SQL_LINT_FILE_NAMES_REGEX + + + + SQL_SQL_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_SQL_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_SQL_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_SQL_LINT_RULES_PATH
Type: string
+

SQLSQLLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_ARGUMENTS
Type: array of string or string
+

SQL_TSQLLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_TSQLLINT_ARGUMENTS + + + + SQL_TSQLLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_CONFIG_FILE
Type: string Default: ".tsqllintrc"
+

SQL_TSQLLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_TSQLLINT_FILE_EXTENSIONS + + + + SQL_TSQLLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_TSQLLINT_FILE_NAMES_REGEX + + + + SQL_TSQLLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_TSQLLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SQL_TSQLLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SQL_TSQLLINT_RULES_PATH
Type: string
+

SQL_TSQLLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_ARGUMENTS
Type: array of string or string
+

SWIFT_SWIFTLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SWIFT_SWIFTLINT_ARGUMENTS + + + + SWIFT_SWIFTLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_CONFIG_FILE
Type: string Default: ".swiftlint.yml"
+

SWIFT_SWIFTLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SWIFT_SWIFTLINT_FILE_EXTENSIONS + + + + SWIFT_SWIFTLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SWIFT_SWIFTLINT_FILE_NAMES_REGEX + + + + SWIFT_SWIFTLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SWIFT_SWIFTLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + SWIFT_SWIFTLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + SWIFT_SWIFTLINT_RULES_PATH
Type: string
+

SWIFT_SWIFTLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TAP_REPORTER
Type: boolean Default: false
+

General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TAP_REPORTER_SUB_FOLDER
Type: string Default: "tap"
+

Sub-folder of reports folder containing TAP logs

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_ARGUMENTS
Type: array of string or string
+

TEKTONTEKTONLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TEKTON_TEKTON_LINT_ARGUMENTS + + + + TEKTON_TEKTON_LINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_CONFIG_FILE
Type: string Default: ".tektonlintrc.yaml"
+

TEKTONTEKTONLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TEKTON_TEKTON_LINT_FILE_EXTENSIONS + + + + TEKTON_TEKTON_LINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_FILE_NAME
Type: string Default: ".tektonlintrc.yaml"
+

TEKTONTEKTONLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TEKTON_TEKTON_LINT_FILE_NAMES_REGEX + + + + TEKTON_TEKTON_LINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TEKTON_TEKTON_LINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TEKTON_TEKTON_LINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEKTON_TEKTON_LINT_RULES_PATH
Type: string
+

TEKTONTEKTONLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_ARGUMENTS
Type: array of string or string
+

TERRAFORM_CHECKOV: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_CHECKOV_ARGUMENTS + + + + TERRAFORM_CHECKOV_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_CHECKOV_FILE_EXTENSIONS + + + + TERRAFORM_CHECKOV_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_CHECKOV_FILE_NAMES_REGEX + + + + TERRAFORM_CHECKOV_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_CHECKOV_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_CHECKOV_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_CHECKOV_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_ARGUMENTS
Type: array of string or string
+

TERRAFORM_KICS: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_KICS_ARGUMENTS + + + + TERRAFORM_KICS_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_KICS_FILE_EXTENSIONS + + + + TERRAFORM_KICS_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_KICS_FILE_NAMES_REGEX + + + + TERRAFORM_KICS_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_KICS_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_KICS_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_KICS_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_ARGUMENTS
Type: array of string or string
+

TERRAFORMTERRAFORMFMT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRAFORM_FMT_ARGUMENTS + + + + TERRAFORM_TERRAFORM_FMT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS + + + + TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX + + + + TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRAFORM_FMT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_ARGUMENTS
Type: array of string or string
+

TERRAFORM_TERRAGRUNT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRAGRUNT_ARGUMENTS + + + + TERRAFORM_TERRAGRUNT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_CONFIG_FILE
Type: string Default: "terragrunt.hcl"
+

TERRAFORM_TERRAGRUNT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS + + + + TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_FILE_NAME
Type: string Default: "terragrunt.hcl"
+

TERRAFORM_TERRAGRUNT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX + + + + TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRAGRUNT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRAGRUNT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRAGRUNT_RULES_PATH
Type: string
+

TERRAFORM_TERRAGRUNT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_ARGUMENTS
Type: array of string or string
+

TERRAFORM_TERRASCAN: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRASCAN_ARGUMENTS + + + + TERRAFORM_TERRASCAN_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_CONFIG_FILE
Type: string Default: "terrascan-config.toml"
+

TERRAFORM_TERRASCAN: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRASCAN_FILE_EXTENSIONS + + + + TERRAFORM_TERRASCAN_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRASCAN_FILE_NAMES_REGEX + + + + TERRAFORM_TERRASCAN_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRASCAN_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TERRASCAN_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TERRASCAN_RULES_PATH
Type: string
+

TERRAFORM_TERRASCAN: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_ARGUMENTS
Type: array of string or string
+

TERRAFORM_TFLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TFLINT_ARGUMENTS + + + + TERRAFORM_TFLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_CONFIG_FILE
Type: string Default: ".tflint.hcl"
+

TERRAFORM_TFLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TFLINT_FILE_EXTENSIONS + + + + TERRAFORM_TFLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_FILE_NAME
Type: string Default: ".tflint.hcl"
+

TERRAFORM_TFLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TFLINT_FILE_NAMES_REGEX + + + + TERRAFORM_TFLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TFLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TERRAFORM_TFLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TERRAFORM_TFLINT_RULES_PATH
Type: string
+

TERRAFORM_TFLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEXT_REPORTER
Type: boolean Default: true
+

General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TEXT_REPORTER_SUB_FOLDER
Type: string Default: "linters_logs"
+

Sub-folder of reports folder containing text logs

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_ARGUMENTS
Type: array of string or string
+

TSX_ESLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TSX_ESLINT_ARGUMENTS + + + + TSX_ESLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_CONFIG_FILE
Type: string Default: ".eslintrc.json"
+

TSX_ESLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TSX_ESLINT_FILE_EXTENSIONS + + + + TSX_ESLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_FILE_NAME
Type: string Default: ".eslintrc.json"
+

TSX_ESLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TSX_ESLINT_FILE_NAMES_REGEX + + + + TSX_ESLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TSX_ESLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TSX_ESLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_ESLINT_RULES_PATH
Type: string
+

TSX_ESLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TSX_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_DEFAULT_STYLE
Type: enum (of string)
+

Style of typescript formatting to apply

+
+

Must be one of:

+
  • "standard"
  • "prettier"
+
+ + + + + +
+
Examples:
+
"standard"
+
+
"prettier"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_ARGUMENTS
Type: array of string or string
+

TYPESCRIPT_ES: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_ES_ARGUMENTS + + + + TYPESCRIPT_ES_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_CONFIG_FILE
Type: string Default: ".eslintrc.json"
+

TYPESCRIPT_ES: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_ES_FILE_EXTENSIONS + + + + TYPESCRIPT_ES_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_FILE_NAME
Type: string Default: ".eslintrc.json"
+

TYPESCRIPT_ES: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_ES_FILE_NAMES_REGEX + + + + TYPESCRIPT_ES_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_ES_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_ES_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_ES_RULES_PATH
Type: string
+

TYPESCRIPT_ES: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_ARGUMENTS
Type: array of string or string
+

TYPESCRIPT_PRETTIER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_PRETTIER_ARGUMENTS + + + + TYPESCRIPT_PRETTIER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_CONFIG_FILE
Type: string Default: ".prettierrc.json"
+

TYPESCRIPT_PRETTIER: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_PRETTIER_FILE_EXTENSIONS + + + + TYPESCRIPT_PRETTIER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX + + + + TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_PRETTIER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_PRETTIER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_PRETTIER_RULES_PATH
Type: string
+

TYPESCRIPT_PRETTIER: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_ARGUMENTS
Type: array of string or string
+

TYPESCRIPT_STANDARD: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_STANDARD_ARGUMENTS + + + + TYPESCRIPT_STANDARD_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_STANDARD_FILE_EXTENSIONS + + + + TYPESCRIPT_STANDARD_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_STANDARD_FILE_NAMES_REGEX + + + + TYPESCRIPT_STANDARD_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_STANDARD_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + TYPESCRIPT_STANDARD_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + TYPESCRIPT_STANDARD_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + UPDATED_SOURCES_REPORTER
Type: boolean
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + UPDATED_SOURCES_REPORTER_DIR
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VALIDATE_ALL_CODEBASE
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.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_ARGUMENTS
Type: array of string or string
+

VBDOTNETDOTNETFORMAT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + VBDOTNET_DOTNET_FORMAT_ARGUMENTS + + + + VBDOTNET_DOTNET_FORMAT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_CLI_LINT_MODE
Type: enum (of string) Default: "file"
+
+

Must be one of:

+
  • "file"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS + + + + VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX + + + + VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + VBDOTNET_DOTNET_FORMAT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + VBDOTNET_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_ARGUMENTS
Type: array of string or string
+

XML_XMLLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + XML_XMLLINT_ARGUMENTS + + + + XML_XMLLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + XML_XMLLINT_FILE_EXTENSIONS + + + + XML_XMLLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + XML_XMLLINT_FILE_NAMES_REGEX + + + + XML_XMLLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + XML_XMLLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + XML_XMLLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + XML_XMLLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_ARGUMENTS
Type: array of string or string
+

YAML_PRETTIER: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_PRETTIER_ARGUMENTS + + + + YAML_PRETTIER_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_CONFIG_FILE
Type: string Default: ".prettierrc.json"
+

YAML_PRETTIER: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_PRETTIER_FILE_EXTENSIONS + + + + YAML_PRETTIER_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_PRETTIER_FILE_NAMES_REGEX + + + + YAML_PRETTIER_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_PRETTIER_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_PRETTIER_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_PRETTIER_RULES_PATH
Type: string
+

YAML_PRETTIER: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_ARGUMENTS
Type: array of string or string
+

YAML_V8R: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_V8R_ARGUMENTS + + + + YAML_V8R_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_V8R_FILE_EXTENSIONS + + + + YAML_V8R_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_V8R_FILE_NAMES_REGEX + + + + YAML_V8R_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_V8R_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_V8R_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_V8R_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_ARGUMENTS
Type: array of string or string
+

YAML_YAMLLINT: User custom arguments to add in linter CLI call

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_YAMLLINT_ARGUMENTS + + + + YAML_YAMLLINT_ARGUMENTS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_CLI_LINT_MODE
Type: enum (of string) Default: "list_of_files"
+
+

Must be one of:

+
  • "file"
  • "list_of_files"
  • "project"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_CONFIG_FILE
Type: string Default: ".yamllint.yml"
+

YAML_YAMLLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_DISABLE_ERRORS
Type: boolean Default: false
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_DISABLE_ERRORS_IF_LESS_THAN
Type: number Default: 0
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_FILE_EXTENSIONS
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_YAMLLINT_FILE_EXTENSIONS + + + + YAML_YAMLLINT_FILE_EXTENSIONS items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_FILE_NAME
Type: string Default: ".yaml-lint.yml"
+

YAML_YAMLLINT: User custom config file name if different from default

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_FILE_NAMES_REGEX
Type: array of string
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_YAMLLINT_FILE_NAMES_REGEX + + + + YAML_YAMLLINT_FILE_NAMES_REGEX items
Type: string
+ + + + + + + +
+

+
Examples:
+
"Dockerfile(-.+)?"
+
+
"Jenkinsfile"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_FILTER_REGEX_EXCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_FILTER_REGEX_INCLUDE
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_POST_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_YAMLLINT_POST_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_POST_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_POST_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_POST_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_POST_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm run test",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_PRE_COMMANDS
Type: array
+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + YAML_YAMLLINT_PRE_COMMANDS + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_PRE_COMMANDS + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_PRE_COMMANDS + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_PRE_COMMANDS + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_PRE_COMMANDS + + + + Command + + + + venv
Type: string
+ + + + + + +
+
Examples:
+
"pylint"
+
+
"flake8"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + YAML_YAMLLINT_RULES_PATH
Type: string
+

YAML_YAMLLINT: Path where to find linter configuration file

+ + + + + + + +
+
+
+
+ + + \ No newline at end of file diff --git a/docs/json-schemas/descriptor.html b/docs/json-schemas/descriptor.html index 5f4319c029e..5ebe6533cb7 100644 --- a/docs/json-schemas/descriptor.html +++ b/docs/json-schemas/descriptor.html @@ -1,298 +1,7139 @@ - MegaLinter descriptor

MegaLinter descriptor

Type: object

Descriptor definition for MegaLinter

 No Additional Properties

root active_only_if_file_found
Type: array of string

Names of the config files to be found (at least one), else descriptor will be deactivated

Each item of this array must be:

root active_only_if_file_found items
Type: string

Example:

[
-    ".editorconfig",
-    ".eslintrc.json"
-]
-

root descriptor_flavors
Type: array Default: []

MegaLinter flavors matching this descriptor

Each item of this array must be:

root descriptor_flavors enum_flavors
Type: enum (of string)

Must be one of:

  • "all_flavors"
  • "all"
  • "ci_light"
  • "dart"
  • "documentation"
  • "dotnet"
  • "go"
  • "java"
  • "javascript"
  • "php"
  • "python"
  • "ruby"
  • "rust"
  • "salesforce"
  • "scala"
  • "swift"
  • "terraform"

Example:

[
-    "all_flavors",
-    "java",
-    "php"
-]
-

root descriptor_flavors_exclude
Type: array Default: []

MegaLinter flavors that must not contain this descriptor

Each item of this array must be:

root descriptor_flavors_exclude enum_flavors
Type: enum (of string)
Same definition as enum_flavors

Example:

[
-    "all_flavors",
-    "java",
-    "php"
-]
-

root descriptor_id
Type: string Default: ""

Uppercase unique identifier for the language, tooling format or identifier
Examples:

"PYTHON"
-
"XML"
-
"OPENAPI"
-

root descriptor_label
Type: string Default: ""

Label for descriptor documentation, if different from Id. Ex: C++ for CPP
Examples:

"C++"
-
"Visual Basic .NET"
-

root descriptor_type
Type: enum (of string) Default: ""

Descriptor type: language, format or tooling format

Must be one of:

  • "language"
  • "format"
  • "tooling_format"
  • "other"

Examples:

"language"
-
"format"
-
"tooling_format"
-
"other"
-

root file_contains_regex
Type: array of string Default: []

Regular expression list for filtering files by their content

Each item of this array must be:

root file_contains_regex items
Type: string

Example:

[
-    "AWSTemplateFormatVersion",
-    "(AWS|Alexa|Custom)::"
-]
-

root file_extensions
Type: array of string Default: []

File extension filters. Empty list excludes all files. Can be overridden at linter level

Each item of this array must be:

root file_extensions items
Type: string

Example:

[
-    ".py",
-    ""
-]
-

root file_names_not_ends_with
Type: array of string Default: []

List of strings to filter the files according to their end of file name

Each item of this array must be:

root file_names_not_ends_with items
Type: string

Example:

[
-    "vault.yml",
-    "galaxy.xml"
-]
-

root file_names_regex
Type: array of string Default: []

Regular expression list for filtering files by their base names using regex full match. Empty list includes all files. Can be overridden at linter level

Each item of this array must be:

root file_names_regex items
Type: string

Example:

[
-    "Dockerfile(-.+)?",
-    "Jenkinsfile"
-]
-

root files_sub_directory
Type: string

Set when a linter only lints a sub-directory
Example:

[
-    "ansible",
-    "kubernetes"
-]
-

root install
Type: object Default: {}

List of apk, dockerfile instructions, npm/pip/gem packages required to use the descriptor linters
Examples:

{
-    "apk": [
-        "openjdk11"
-    ]
-}
-
{
-    "dockerfile": [
-        "ENV JAVA_HOME=/usr/lib/jvm/java‑11‑openjdk",
-        "ENV PATH=\"$JAVA_HOME/bin:${PATH}\""
-    ]
-}
-
{
-    "npm": [
-        "sfdx-cli"
-    ]
-}
-

root install apk
Type: array of string

APK packages identifiers (with or without version)

Each item of this array must be:

root install apk items
Type: string

Example:

[
-    "openjdk8"
-]
-

root install dockerfile
Type: array of string

Will be automatically integrated in generated Dockerfile

Each item of this array must be:

root install dockerfile items
Type: string

Example:

[
-    "ENV JAVA_HOME=/usr/lib/jvm/java‑11‑openjdk",
-    "ENV PATH=\"$JAVA_HOME/bin:${PATH}\""
-]
-

root install gem
Type: array of string

GEM packages identifiers (with or without version)

Each item of this array must be:

root install gem items
Type: string

root install npm
Type: array of string

NPM packages identifiers (with or without version)

Each item of this array must be:

root install npm items
Type: string

Example:

[
-    "sfdx-cli"
-]
-

root install pip
Type: array of string

PIP packages identifiers (with or without version)

Each item of this array must be:

root install pip items
Type: string

root lint_all_files
Type: boolean Default: false

If set to true, this descriptor linters will always lint all files, undepending their name/extensions/content

root lint_all_other_linters_files
Type: boolean Default: false

If set to true, this descriptor linters will lint one by one all files collected by all other linters

root linters
Type: array of object

List of linter definitions associated to the descriptor

Each item of this array must be:

root linters Linter definition
Type: object

Parameters defining behaviour and installation of a linter

 No Additional Properties
Example:

{
-    "cli_config_extra_args": [
-        "--no-eslintrc",
-        "--no-ignore"
-    ],
-    "config_file_name": ".eslintrc.yml",
-    "examples": [
-        "eslint myfile.js",
-        "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"
-    ],
-    "install": {
-        "npm": [
-            "eslint",
-            "eslint-config-airbnb",
-            "eslint-config-prettier",
-            "eslint-plugin-jest",
-            "eslint-plugin-prettier",
-            "babel-eslint"
-        ]
-    },
-    "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png",
-    "linter_name": "eslint",
-    "linter_url": "https://eslint.org",
-    "name": "JAVASCRIPT_ES"
-}
-

root linters Linter definition activation_rules
Type: array of object Default: []

List of rules to check to activate linter

Each item of this array must be:

root linters Linter definition activation_rules items
Type: object

Example:

[
-    {
-        "default_value": "standard",
-        "expected_value": "prettier",
-        "type": "variable",
-        "variable": "JAVASCRIPT_DEFAULT_STYLE"
-    }
-]
-

root linters Linter definition active_only_if_file_found
Type: array of string

Names of the config files to be found (at least one), else descriptor will be deactivated

Each item of this array must be:

root linters Linter definition active_only_if_file_found items
Type: string

Example:

[
-    ".editorconfig",
-    ".eslintrc.json"
-]
-

root linters Linter definition class
Type: string

If MegaLinter core is not enough, use a custom class inheriting from Linter class
Examples:

"CSpellLinter"
-
"DotnetFormatLinter"
-
"RakuLinter"
-

root linters Linter definition cli_config_extra_args
Type: array of string Default: []

When a configuration file is used with the linter CLI, send these additional arguments

Each item of this array must be:

root linters Linter definition cli_config_extra_args items
Type: string

Example:

[
-    "--no-eslintrc",
-    "--no-ignore"
-]
-

root linters Linter definition cli_docker_args
Type: array of string Default: []

Arguments for docker run before image name

Each item of this array must be:

root linters Linter definition cli_docker_args items
Type: string

Example:

[
-    "-v",
-    "`pwd`:`pwd`",
-    "-w",
-    "`pwd`"
-]
-

root linters Linter definition cli_docker_image
Type: string

Example:

"norionomura/swiftlint"
-

root linters Linter definition cli_docker_image_version
Type: string Default: "latest"

Version of the docker image to use for linting
Example:

"0.42.0_swift-5.3.2"
-

root linters Linter definition cli_executable
Type: string

Override if different from linter_name

root linters Linter definition cli_executable_help
Type: string

Override if different from cli executable used for linting

root linters Linter definition cli_executable_version
Type: string

Override if different from cli executable used for linting

root linters Linter definition cli_help_extra_args
Type: array of string

When linter CLI is call for help, send these additional arguments

Each item of this array must be:

root linters Linter definition cli_help_extra_args items
Type: string

root linters Linter definition cli_help_extra_commands
Type: array of string

When linter CLI is call for help, send these additional commands

Each item of this array must be:

root linters Linter definition cli_help_extra_commands items
Type: string

root linters Linter definition cli_lint_errors_count
Type: enum (of string)

Defines how to count errors from log file. regexnumber, regexcount, regexsum, or totallines

Must be one of:

  • "regex_number"
  • "regex_count"
  • "regex_sum"
  • "total_lines"

Examples:

"regex_number"
-
"regex_count"
-
"regex_sum"
-
"total_lines"
-

root linters Linter definition cli_lint_errors_regex
Type: string

Regex allowing to extract the number of errors from linter output logs
Example:

"Issues found: (.*) in .* files"
-

root linters Linter definition cli_lint_extra_args
Type: array of string Default: []

When linter CLI is call for linting, send these additional arguments before config args

Each item of this array must be:

root linters Linter definition cli_lint_extra_args items
Type: string

root linters Linter definition cli_lint_extra_args_after
Type: array of string Default: []

When linter CLI is call for linting, send these additional arguments after config args

Each item of this array must be:

root linters Linter definition cli_lint_extra_args_after items
Type: string

root linters Linter definition cli_lint_fix_arg_name
Type: string

Examples:

"--fix"
-
"--format"
-

root linters Linter definition cli_lint_fix_remove_args
Type: array of string Default: []

When linter CLI is call for fixing, remove these arguments

Each item of this array must be:

root linters Linter definition cli_lint_fix_remove_args items
Type: string

Example:

[
-    "--check"
-]
-

root linters Linter definition cli_lint_mode
Type: enum (of string) Default: "file"

Defines how the linter is called: file, listoffiles, project

Must be one of:

  • "file"
  • "project"
  • "list_of_files"

root linters Linter definition cli_version_extra_args
Type: array of string

When linter CLI is call for version, send these additional arguments

Each item of this array must be:

root linters Linter definition cli_version_extra_args items
Type: string

root linters Linter definition config_file_name
Type: string

An explanation about the purpose of this instance.
Examples:

".eslintrc.yml"
-
".markdown-lint.yml"
-
".python-black"
-

root linters Linter definition descriptor_flavors
Type: array Default: []

MegaLinter flavors matching this linter

Each item of this array must be:

root linters Linter definition descriptor_flavors enum_flavors
Type: enum (of string)
Same definition as enum_flavors

Example:

[
-    "all_flavors",
-    "java",
-    "php"
-]
-

root linters Linter definition descriptor_flavors_exclude
Type: array Default: []

MegaLinter flavors that must not contain this descriptor

Each item of this array must be:

root linters Linter definition descriptor_flavors_exclude enum_flavors
Type: enum (of string)
Same definition as enum_flavors

Example:

[
-    "all_flavors",
-    "java",
-    "php"
-]
-

root linters Linter definition disabled
Type: boolean Default: false

Disable linter in MegaLinter next builds

root linters Linter definition downgraded_version
Type: boolean Default: false

Indicates that installation instructions does not use the latest release of the linter

root linters Linter definition examples
Type: array of string

Please add an example with and without configuration file in the command. They will appear in documentation

Each item of this array must be:

root linters Linter definition examples items
Type: string

Examples:

[
-    "golangci-lint run myfile.go",
-    "golangci-lint run -c .golangci.yml myfile.go"
-]
-
[
-    "eslint myfile.js",
-    "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"
-]
-

root linters Linter definition file_extensions
Type: array of string Default: []

File extension filters if different from the ones defined on parent descriptor

Each item of this array must be:

root linters Linter definition file_extensions items
Type: string

Example:

[
-    ".py",
-    ""
-]
-

root linters Linter definition file_names_not_ends_with
Type: array of string Default: []

List of strings to filter the files according to their end of file name

Each item of this array must be:

root linters Linter definition file_names_not_ends_with items
Type: string

Example:

[
-    "vault.yml",
-    "galaxy.xml"
-]
-

root linters Linter definition files_sub_directory
Type: string

Set when a linter only lints a sub-directory
Example:

[
-    "ansible",
-    "kubernetes"
-]
-

root linters Linter definition ide
Type: object

List of IDE supporting the linter

root linters Linter definition install
Type: object Default: {}

List of apk, dockerfile instructions, npm/pip/gem packages required to install the linter
Examples:

{
-    "dockerfile": [
-        "FROM accurics/terrascan:latest as terrascan",
-        "COPY --from=terrascan /go/bin/terrascan /usr/bin/",
-        "RUN terrascan init"
-    ]
-}
-
{
-    "npm": [
-        "eslint",
-        "eslint-config-airbnb",
-        "eslint-config-prettier",
-        "eslint-plugin-jest",
-        "eslint-plugin-prettier",
-        "babel-eslint"
-    ]
-}
-

root linters Linter definition install apk
Type: array of string

APK packages identifiers (with or without version)

Each item of this array must be:

root linters Linter definition install apk items
Type: string

Example:

[
-    "perl",
-    "perl-dev"
-]
-

root linters Linter definition install dockerfile
Type: array of string

Will be automatically integrated in generated Dockerfile

Each item of this array must be:

root linters Linter definition install dockerfile items
Type: string

Example:

[
-    "FROM accurics/terrascan:latest as terrascan",
-    "COPY --from=terrascan /go/bin/terrascan /usr/bin/",
-    "RUN terrascan init"
-]
-

root linters Linter definition install gem
Type: array of string

GEM packages identifiers (with or without version)

Each item of this array must be:

root linters Linter definition install gem items
Type: string

Example:

[
-    "rubocop:0.82.0",
-    "rubocop-github:0.16.0",
-    "rubocop-performance"
-]
-

root linters Linter definition install npm
Type: array of string

NPM packages identifiers (with or without version)

Each item of this array must be:

root linters Linter definition install npm items
Type: string

Example:

[
-    "eslint",
-    "eslint-config-airbnb@3.2.1"
-]
-

root linters Linter definition install pip
Type: array of string

PIP packages identifiers (with or without version)

Each item of this array must be:

root linters Linter definition install pip items
Type: string

Example:

[
-    "flake8"
-]
-

root linters Linter definition is_formatter
Type: boolean Default: false

If the linter is just a formatter, set to true so errors will count as warnings

root linters Linter definition lint_all_files
Type: boolean Default: false

If set to true, this linter will always lint all files, undepending their name/extensions/content

root linters Linter definition linter_banner_image_url
Type: string

URL of an image used to build header of linter Markdown documentation
Example:

"https://github.com/stylelint/stylelint/raw/master/identity/stylelint-icon-and-text-white.png"
-

root linters Linter definition linter_help_cache
Type: string

If the linter is unable to return help content, hardcode it here

root linters Linter definition linter_image_url
Type: string

URL of an image used in linter Markdown documentation
Example:

"https://raku.org/camelia-logo.png"
-

root linters Linter definition linter_megalinter_ref_url
Type: string

URL to linter documentation referring to MegaLinter

root linters Linter definition linter_name
Type: string

Name of the linter (same as cli command if possible)
Example:

"eslint"
-

root linters Linter definition linter_repo
Type: string

URL of the linter repository home page
Example:

"https://github.com/eslint/eslint"
-

root linters Linter definition linter_rules_configuration_url
Type: string

URL to linter documentation explaining how to configure the linter

root linters Linter definition linter_rules_inline_disable_url
Type: string

URL to linter documentation explaining how to disable rules directly with comments in files

root linters Linter definition linter_rules_url
Type: string

URL to linter documentation listing all the rules that can be detected

root linters Linter definition linter_spdx_license
Type: string

spdx license id of the linter

root linters Linter definition linter_text
Type: string

root linters Linter definition linter_url
Type: string

URL of the linter home page
Example:

"https://eslint.org"
-

root linters Linter definition linter_version_cache
Type: string

If the linter is unable to return a version number, hardcode it here

root linters Linter definition name
Type: string

When several linters in a descriptor, set a different name that will be used for configuration
Example:

"JAVASCRIPT_ES"
-

root linters Linter definition post_commands
Type: array Default: []

Custom bash commands to run after linter

Each item of this array must be:

root linters Linter definition post_commands command_info
Type: object

Command information

root linters Linter definition post_commands Command command
Type: string

Examples:

"npm run test"
-
"echo \"This is a custom command\""
-

root linters Linter definition post_commands Command continue_if_failed
Type: boolean Default: true

root linters Linter definition post_commands Command cwd
Type: enum (of string)

Must be one of:

  • "root"
  • "workspace"

Examples:

"root"
-
"workspace"
-

Example:

[
-    {
-        "command": "npm install java-caller",
-        "continue_if_failed": false,
-        "cwd": "root"
-    },
-    {
-        "command": "echo \"linter post-run command has been called\"",
-        "cwd": "workspace"
-    }
-]
-

root linters Linter definition pre_commands
Type: array Default: []

Custom bash commands to run before linter

Each item of this array must be:

root linters Linter definition pre_commands command_info
Type: object

Command information

Same definition as command_info

Example:

[
-    {
-        "command": "tflint --init",
-        "continue_if_failed": false,
-        "cwd": "root"
-    },
-    {
-        "command": "echo \"linter pre-run command has been called\"",
-        "cwd": "workspace"
-    }
-]
-

root linters Linter definition test_folder
Type: string

Test folder containing good and bad files, if different from parent descriptor test_folder
Example:

[
-    "bash_shfmt",
-    "terraform_terrascan"
-]
-

root linters Linter definition test_variables
Type: object

List of variables to set before running tests
Example:

{
-    "JAVASCRIPT_DEFAULT_STYLE": "prettier"
-}
-

root linters Linter definition variables
Type: array

Try to not use this property except if you really have no choice
Example:

{
-    "default_value": "false",
-    "description": "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 arror instead",
-    "name": "ERROR_ON_MISSING_EXEC_BIT"
-}
-

root linters Linter definition version_extract_regex
Type: string

If default regex to extract version from linter -v call, override it here
Example:

"(?<=npm-groovy-lint version )\\d+(\\.\\d+)+"
-

Example:

[
-    {
-        "cli_config_extra_args": [
-            "--no-eslintrc",
-            "--no-ignore"
-        ],
-        "config_file_name": ".eslintrc.yml",
-        "examples": [
-            "eslint myfile.js",
-            "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"
-        ],
-        "install": {
-            "npm": [
-                "eslint",
-                "eslint-config-airbnb",
-                "eslint-config-prettier",
-                "eslint-plugin-jest",
-                "eslint-plugin-prettier",
-                "babel-eslint"
-            ]
-        },
-        "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png",
-        "linter_name": "eslint",
-        "linter_url": "https://eslint.org",
-        "name": "JAVASCRIPT_ES"
-    },
-    {
-        "examples": [
-            "standard myfile.js"
-        ],
-        "install": {
-            "npm": [
-                "standard"
-            ]
-        },
-        "linter_banner_image_url": "https://github.com/standard/standard/raw/master/sticker.png",
-        "linter_name": "standard",
-        "linter_url": "https://github.com/standard/standard",
-        "name": "JAVASCRIPT_STANDARD"
-    }
-]
-

root processing_order
Type: number Default: 0

If descriptor linters may be slow, put a negative processing order. If it is fast, put a positive one. If you don't know, do not set
Example:

[
-    -9,
-    0,
-    9
-]
-

root test_folder
Type: string

Test folder containing good and bad files. Default: lowercase(descriptor_id)
Example:

[
-    "bash_shfmt",
-    "terraform_terrascan"
-]
-
\ No newline at end of file + + + + + + + + + + + + + + + + MegaLinter descriptor + +

MegaLinter descriptor

+ +
Type: object
+

Descriptor definition for MegaLinter

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + active_only_if_file_found
Type: array of string
+

Names of the config files to be found (at least one), else descriptor will be deactivated

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + active_only_if_file_found + + + + active_only_if_file_found items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    ".editorconfig",
+    ".eslintrc.json"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + descriptor_flavors
Type: array Default: []
+

MegaLinter flavors matching this descriptor

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + descriptor_flavors + + + + enum_flavors
Type: enum (of string)
+ + +
+

Must be one of:

+
  • "all_flavors"
  • "all"
  • "ci_light"
  • "cupcake"
  • "documentation"
  • "dotnet"
  • "go"
  • "java"
  • "javascript"
  • "php"
  • "python"
  • "ruby"
  • "rust"
  • "salesforce"
  • "security"
  • "swift"
  • "terraform"
+
+ + + + + + +
+

+
Example:
+
[
+    "all_flavors",
+    "java",
+    "php"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + descriptor_flavors_exclude
Type: array Default: []
+

MegaLinter flavors that must not contain this descriptor

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + descriptor_flavors_exclude + + + + enum_flavors
Type: enum (of string)
+ + +
+

Must be one of:

+
  • "all_flavors"
  • "all"
  • "ci_light"
  • "cupcake"
  • "documentation"
  • "dotnet"
  • "go"
  • "java"
  • "javascript"
  • "php"
  • "python"
  • "ruby"
  • "rust"
  • "salesforce"
  • "security"
  • "swift"
  • "terraform"
+
+ + + + + + +
+

+
Example:
+
[
+    "all_flavors",
+    "java",
+    "php"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + descriptor_id
Type: string Default: ""
+

Uppercase unique identifier for the language, tooling format or identifier

+ + + + + + +
+
Examples:
+
"PYTHON"
+
+
"XML"
+
+
"OPENAPI"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + descriptor_label
Type: string Default: ""
+

Label for descriptor documentation, if different from Id. Ex: C++ for CPP

+ + + + + + +
+
Examples:
+
"C++"
+
+
"Visual Basic .NET"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + descriptor_type
Type: enum (of string) Default: ""
+

Descriptor type: language, format or tooling format

+
+

Must be one of:

+
  • "language"
  • "format"
  • "tooling_format"
  • "other"
+
+ + + + + +
+
Examples:
+
"language"
+
+
"format"
+
+
"tooling_format"
+
+
"other"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + file_contains_regex
Type: array of string Default: []
+

Regular expression list for filtering files by their content

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + file_contains_regex + + + + file_contains_regex items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "AWSTemplateFormatVersion",
+    "(AWS|Alexa|Custom)::"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + file_contains_regex_extensions
Type: array of string Default: []
+

If filecontainsregex is set, use this property to filter extensions of the files that will be checked

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + file_contains_regex_extensions + + + + file_contains_regex_extensions items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "",
+    ".json"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + file_extensions
Type: array of string Default: []
+

File extension filters. Empty list excludes all files. Can be overridden at linter level

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + file_extensions + + + + file_extensions items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    ".py",
+    ""
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + file_names_not_ends_with
Type: array of string Default: []
+

List of strings to filter the files according to their end of file name

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + file_names_not_ends_with + + + + file_names_not_ends_with items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "vault.yml",
+    "galaxy.xml"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + file_names_regex
Type: array of string Default: []
+

Regular expression list for filtering files by their base names using regex full match. Empty list includes all files. Can be overridden at linter level

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + file_names_regex + + + + file_names_regex items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "Dockerfile(-.+)?",
+    "Jenkinsfile"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + files_sub_directory
Type: string
+

Set when a linter only lints a sub-directory

+ + + + + + +
+
Example:
+
[
+    "ansible",
+    "kubernetes"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + install
Type: object Default: {}
+

List of apk, dockerfile instructions, npm/pip/gem packages required to use the descriptor linters

+ + + + + + +
+
Examples:
+
{
+    "apk": [
+        "openjdk11"
+    ]
+}
+
+
{
+    "dockerfile": [
+        "ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk",
+        "ENV PATH=\"$JAVA_HOME/bin:${PATH}\""
+    ]
+}
+
+
{
+    "npm": [
+        "sfdx-cli"
+    ]
+}
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + install + + + + apk
Type: array of string
+

APK packages identifiers (with or without version)

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + install + + + + apk + + + + apk items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "openjdk11"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + install + + + + cargo
Type: array of string
+

Cargo packages identifiers (with or without version)

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + install + + + + cargo + + + + cargo items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + install + + + + dockerfile
Type: array of string
+

Will be automatically integrated in generated Dockerfile

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + install + + + + dockerfile + + + + dockerfile items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk",
+    "ENV PATH=\"$JAVA_HOME/bin:${PATH}\""
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + install + + + + gem
Type: array of string
+

GEM packages identifiers (with or without version)

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + install + + + + gem + + + + gem items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + install + + + + npm
Type: array of string
+

NPM packages identifiers (with or without version)

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + install + + + + npm + + + + npm items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "sfdx-cli"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + install + + + + pip
Type: array of string
+

PIP packages identifiers (with or without version)

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + install + + + + pip + + + + pip items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + lint_all_files
Type: boolean Default: false
+

If set to true, this descriptor linters will always lint all files, undepending their name/extensions/content

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + lint_all_other_linters_files
Type: boolean Default: false
+

If set to true, this descriptor linters will lint one by one all files collected by all other linters

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters
Type: array of object
+

List of linter definitions associated to the descriptor

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition
Type: object
+

Parameters defining behaviour and installation of a linter

+ No Additional Properties + + + + + +
+
Example:
+
{
+    "cli_config_extra_args": [
+        "--no-eslintrc",
+        "--no-ignore"
+    ],
+    "config_file_name": ".eslintrc.yml",
+    "examples": [
+        "eslint myfile.js",
+        "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"
+    ],
+    "install": {
+        "npm": [
+            "eslint",
+            "eslint-config-airbnb",
+            "eslint-config-prettier",
+            "eslint-plugin-jest",
+            "eslint-plugin-prettier",
+            "babel-eslint"
+        ]
+    },
+    "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png",
+    "linter_name": "eslint",
+    "linter_url": "https://eslint.org",
+    "name": "JAVASCRIPT_ES"
+}
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + activation_rules
Type: array of object Default: []
+

List of rules to check to activate linter

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + activation_rules + + + + activation_rules items
Type: object
+ + + + + + + +
+

+
Example:
+
[
+    {
+        "default_value": "standard",
+        "expected_value": "prettier",
+        "type": "variable",
+        "variable": "JAVASCRIPT_DEFAULT_STYLE"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + active_only_if_file_found
Type: array of string
+

Names of the config files to be found (at least one), else descriptor will be deactivated

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + active_only_if_file_found + + + + active_only_if_file_found items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    ".editorconfig",
+    ".eslintrc.json"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + can_output_sarif
Type: boolean Default: false
+

Shows if the linter is capable of output SARIF report within MegaLinter

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + class
Type: string
+

If MegaLinter core is not enough, use a custom class inheriting from Linter class

+ + + + + + +
+
Examples:
+
"CSpellLinter"
+
+
"DotnetFormatLinter"
+
+
"RakuLinter"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_config_arg_name
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_config_default_value
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_config_extra_args
Type: array of string Default: []
+

When a configuration file is used with the linter CLI, send these additional arguments

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + cli_config_extra_args + + + + cli_config_extra_args items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "--no-eslintrc",
+    "--no-ignore"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_docker_args
Type: array of string Default: []
+

Arguments for docker run before image name

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + cli_docker_args + + + + cli_docker_args items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "-v",
+    "`pwd`:`pwd`",
+    "-w",
+    "`pwd`"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_docker_image
Type: string
+ + + + + + +
+
Example:
+
"norionomura/swiftlint"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_docker_image_version
Type: string Default: "latest"
+

Version of the docker image to use for linting

+ + + + + + +
+
Example:
+
"0.42.0_swift-5.3.2"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_executable
Type: string
+

Override if different from linter_name

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_executable_help
Type: string
+

Override if different from cli executable used for linting

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_executable_version
Type: string
+

Override if different from cli executable used for linting

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_help_arg_name
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_help_extra_args
Type: array of string
+

When linter CLI is call for help, send these additional arguments

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + cli_help_extra_args + + + + cli_help_extra_args items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_help_extra_commands
Type: array of string
+

When linter CLI is call for help, send these additional commands

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + cli_help_extra_commands + + + + cli_help_extra_commands items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_lint_errors_count
Type: enum (of string)
+

Defines how to count errors from log file. regexnumber, regexcount, regexsum, or totallines

+
+

Must be one of:

+
  • "regex_number"
  • "regex_count"
  • "regex_sum"
  • "total_lines"
+
+ + + + + +
+
Examples:
+
"regex_number"
+
+
"regex_count"
+
+
"regex_sum"
+
+
"total_lines"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_lint_errors_regex
Type: string
+

Regex allowing to extract the number of errors from linter output logs

+ + + + + + +
+
Example:
+
"Issues found: (.*) in .* files"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_lint_extra_args
Type: array of string Default: []
+

When linter CLI is call for linting, send these additional arguments before config args

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + cli_lint_extra_args + + + + cli_lint_extra_args items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_lint_extra_args_after
Type: array of string Default: []
+

When linter CLI is call for linting, send these additional arguments after config args

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + cli_lint_extra_args_after + + + + cli_lint_extra_args_after items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_lint_fix_arg_name
Type: string
+ + + + + + +
+
Examples:
+
"--fix"
+
+
"--format"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_lint_fix_remove_args
Type: array of string Default: []
+

When linter CLI is call for fixing, remove these arguments

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + cli_lint_fix_remove_args + + + + cli_lint_fix_remove_args items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "--check"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_lint_ignore_arg_name
Type: string
+

If the linter can use an ignore file, input here the related argument

+ + + + + + +
+
Examples:
+
"--secretlintignore"
+
+
"--ignore-path"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_lint_mode
Type: enum (of string) Default: "file"
+

Defines how the linter is called: file, listoffiles, project

+
+

Must be one of:

+
  • "file"
  • "project"
  • "list_of_files"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_sarif_args
Type: array of string Default: []
+

Arguments to generate SARIF output

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + cli_sarif_args + + + + cli_sarif_args items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "--format",
+    "sarif",
+    "--output",
+    "{{SARIF_OUTPUT_FILE}}"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_version_arg_name
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + cli_version_extra_args
Type: array of string
+

When linter CLI is call for version, send these additional arguments

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + cli_version_extra_args + + + + cli_version_extra_args items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + config_file_name
Type: string
+

An explanation about the purpose of this instance.

+ + + + + + +
+
Examples:
+
".eslintrc.yml"
+
+
".markdown-lint.yml"
+
+
".python-black"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + deprecated
Type: boolean Default: false
+

Shows if the linter is deprecated.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + deprecated_description
Type: string Default: ""
+

Displays information on why it is deprecated and whether an alternative is available.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + descriptor_flavors
Type: array Default: []
+

MegaLinter flavors matching this linter

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + descriptor_flavors + + + + enum_flavors
Type: enum (of string)
+ + +
+

Must be one of:

+
  • "all_flavors"
  • "all"
  • "ci_light"
  • "cupcake"
  • "documentation"
  • "dotnet"
  • "go"
  • "java"
  • "javascript"
  • "php"
  • "python"
  • "ruby"
  • "rust"
  • "salesforce"
  • "security"
  • "swift"
  • "terraform"
+
+ + + + + + +
+

+
Example:
+
[
+    "all_flavors",
+    "java",
+    "php"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + descriptor_flavors_exclude
Type: array Default: []
+

MegaLinter flavors that must not contain this descriptor

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + descriptor_flavors_exclude + + + + enum_flavors
Type: enum (of string)
+ + +
+

Must be one of:

+
  • "all_flavors"
  • "all"
  • "ci_light"
  • "cupcake"
  • "documentation"
  • "dotnet"
  • "go"
  • "java"
  • "javascript"
  • "php"
  • "python"
  • "ruby"
  • "rust"
  • "salesforce"
  • "security"
  • "swift"
  • "terraform"
+
+ + + + + + +
+

+
Example:
+
[
+    "all_flavors",
+    "java",
+    "php"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + disabled
Type: boolean Default: false
+

Disable linter in MegaLinter next builds

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + downgraded_version
Type: boolean Default: false
+

Indicates that installation instructions does not use the latest release of the linter

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + examples
Type: array of string
+

Please add an example with and without configuration file in the command. They will appear in documentation

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + examples + + + + examples items
Type: string
+ + + + + + + +
+

+
Examples:
+
[
+    "golangci-lint run myfile.go",
+    "golangci-lint run -c .golangci.yml myfile.go"
+]
+
+
[
+    "eslint myfile.js",
+    "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + file_extensions
Type: array of string Default: []
+

File extension filters if different from the ones defined on parent descriptor

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + file_extensions + + + + file_extensions items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    ".py",
+    ""
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + file_names_not_ends_with
Type: array of string Default: []
+

List of strings to filter the files according to their end of file name

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + file_names_not_ends_with + + + + file_names_not_ends_with items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "vault.yml",
+    "galaxy.xml"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + file_names_regex
Type: array of string Default: []
+

Regular expression list for filtering files by their base names using regex full match. Empty list includes all files. Can be overridden at linter level

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + file_names_regex + + + + file_names_regex items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "Dockerfile(-.+)?",
+    "Jenkinsfile"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + files_sub_directory
Type: string
+

Set when a linter only lints a sub-directory

+ + + + + + +
+
Example:
+
[
+    "ansible",
+    "kubernetes"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + help_command_return_code
Type: number
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + ide
Type: object
+

List of IDE supporting the linter

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + ignore_file_name
Type: string
+

An explanation about the purpose of this instance.

+ + + + + + +
+
Examples:
+
".eslintignore"
+
+
".secretlintignore"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + ignore_for_flavor_suggestions
Type: boolean Default: false
+

If this property is set to true, this linter will be ignored for flavor suggestions

+ + + + + + +
+
Examples:
+
".eslintignore"
+
+
".secretlintignore"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + install
Type: object Default: {}
+

List of apk, dockerfile instructions, npm/pip/gem packages required to install the linter

+ + + + + + +
+
Examples:
+
{
+    "dockerfile": [
+        "FROM accurics/terrascan:latest as terrascan",
+        "COPY --from=terrascan /go/bin/terrascan /usr/bin/",
+        "RUN terrascan init"
+    ]
+}
+
+
{
+    "npm": [
+        "eslint",
+        "eslint-config-airbnb",
+        "eslint-config-prettier",
+        "eslint-plugin-jest",
+        "eslint-plugin-prettier",
+        "babel-eslint"
+    ]
+}
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + install + + + + apk
Type: array of string
+

APK packages identifiers (with or without version)

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + install + + + + apk + + + + apk items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "perl",
+    "perl-dev"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + install + + + + cargo
Type: array of string
+

Cargo packages identifiers (with or without version)

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + install + + + + cargo + + + + cargo items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "clippy",
+    "sarif-fmt"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + install + + + + dockerfile
Type: array of string
+

Will be automatically integrated in generated Dockerfile

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + install + + + + dockerfile + + + + dockerfile items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "FROM accurics/terrascan:latest as terrascan",
+    "COPY --from=terrascan /go/bin/terrascan /usr/bin/",
+    "RUN terrascan init"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + install + + + + gem
Type: array of string
+

GEM packages identifiers (with or without version)

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + install + + + + gem + + + + gem items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "rubocop:0.82.0",
+    "rubocop-github:0.16.0",
+    "rubocop-performance"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + install + + + + npm
Type: array of string
+

NPM packages identifiers (with or without version)

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + install + + + + npm + + + + npm items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "eslint",
+    "eslint-config-airbnb@3.2.1"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + install + + + + pip
Type: array of string
+

PIP packages identifiers (with or without version)

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + install + + + + pip + + + + pip items
Type: string
+ + + + + + + +
+

+
Example:
+
[
+    "flake8"
+]
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + is_formatter
Type: boolean Default: false
+

If the linter is just a formatter, set to true so errors will count as warnings

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + lint_all_files
Type: boolean Default: false
+

If set to true, this linter will always lint all files, undepending their name/extensions/content

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + lint_all_other_linters_files
Type: boolean Default: false
+

If set to true, this descriptor linters will lint one by one all files collected by all other linters

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_banner_image_url
Type: stringFormat: uri
+

URL of an image used to build header of linter Markdown documentation

+ + + + + + +
+
Example:
+
"https://github.com/stylelint/stylelint/raw/master/identity/stylelint-icon-and-text-white.png"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_help_cache
Type: string
+

If the linter is unable to return help content, hardcode it here

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_image_url
Type: stringFormat: uri
+

URL of an image used in linter Markdown documentation

+ + + + + + +
+
Example:
+
"https://raku.org/camelia-logo.png"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_megalinter_ref_url
Type: string
+

URL to linter documentation referring to MegaLinter

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_name
Type: string
+

Name of the linter (same as cli command if possible)

+ + + + + + +
+
Example:
+
"eslint"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_repo
Type: stringFormat: uri
+

URL of the linter repository home page

+ + + + + + +
+
Example:
+
"https://github.com/eslint/eslint"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_rules_configuration_url
Type: stringFormat: uri
+

URL to linter documentation explaining how to configure the linter

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_rules_ignore_config_url
Type: stringFormat: uri
+

URL to linter documentation explaining how to ignore files

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_rules_inline_disable_url
Type: stringFormat: uri
+

URL to linter documentation explaining how to disable rules directly with comments in files

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_rules_url
Type: stringFormat: uri
+

URL to linter documentation listing all the rules that can be detected

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_spdx_license
Type: string
+

spdx license id of the linter

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_speed
Type: enum (of integer)
+

Average speed of the linter (performances indicator). For 1 (very slow) to 5 (very fast)

+
+

Must be one of:

+
  • 1
  • 2
  • 3
  • 4
  • 5
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_text
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_url
Type: stringFormat: uri
+

URL of the linter home page

+ + + + + + +
+
Example:
+
"https://eslint.org"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + linter_version_cache
Type: string
+

If the linter is unable to return a version number, hardcode it here

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + name
Type: string
+

When several linters in a descriptor, set a different name that will be used for configuration

+ + + + + + +
+
Example:
+
"JAVASCRIPT_ES"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + post_commands
Type: array Default: []
+

Custom bash commands to run after linter

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + post_commands + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + post_commands + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + post_commands + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + post_commands + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "npm install java-caller",
+        "continue_if_failed": false,
+        "cwd": "root"
+    },
+    {
+        "command": "echo \"linter post-run command has been called\"",
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + pre_commands
Type: array Default: []
+

Custom bash commands to run before linter

+ + + + + + +

Each item of this array must be:

+
+
+ + +
root + + + + linters + + + + Linter definition + + + + pre_commands + + + + command_info
Type: object
+

Command information

+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + pre_commands + + + + Command + + + + command
Type: string
+ + + + + + +
+
Examples:
+
"npm run test"
+
+
"echo \"This is a custom command\""
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + pre_commands + + + + Command + + + + continue_if_failed
Type: boolean Default: true
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + pre_commands + + + + Command + + + + cwd
Type: enum (of string)
+
+

Must be one of:

+
  • "root"
  • "workspace"
+
+ + + + + +
+
Examples:
+
"root"
+
+
"workspace"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "command": "tflint --init",
+        "continue_if_failed": false,
+        "cwd": "root"
+    },
+    {
+        "command": "echo \"linter pre-run command has been called\"",
+        "cwd": "workspace"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + sarif_default_output_file
Type: string
+

Path to find default SARIF output file when generated by linter

+ + + + + + +
+
Example:
+
[
+    "./results.sarif"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + test_folder
Type: string
+

Test folder containing good and bad files, if different from parent descriptor test_folder

+ + + + + + +
+
Example:
+
[
+    "bash_shfmt",
+    "terraform_terrascan"
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + test_variables
Type: object
+

List of variables to set before running tests

+ + + + + + +
+
Example:
+
{
+    "JAVASCRIPT_DEFAULT_STYLE": "prettier"
+}
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + variables
Type: array
+

Try to not use this property except if you really have no choice

+ + + + + + +
+
Example:
+
{
+    "default_value": "false",
+    "description": "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",
+    "name": "ERROR_ON_MISSING_EXEC_BIT"
+}
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + version_command_return_code
Type: number
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + linters + + + + Linter definition + + + + version_extract_regex
Type: string
+

If default regex to extract version from linter -v call, override it here

+ + + + + + +
+
Example:
+
"(?<=npm-groovy-lint version )\\d+(\\.\\d+)+"
+
+
+
+
+
+
+
+

+
Example:
+
[
+    {
+        "cli_config_extra_args": [
+            "--no-eslintrc",
+            "--no-ignore"
+        ],
+        "config_file_name": ".eslintrc.yml",
+        "examples": [
+            "eslint myfile.js",
+            "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"
+        ],
+        "install": {
+            "npm": [
+                "eslint",
+                "eslint-config-airbnb",
+                "eslint-config-prettier",
+                "eslint-plugin-jest",
+                "eslint-plugin-prettier",
+                "babel-eslint"
+            ]
+        },
+        "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png",
+        "linter_name": "eslint",
+        "linter_url": "https://eslint.org",
+        "name": "JAVASCRIPT_ES"
+    },
+    {
+        "examples": [
+            "standard myfile.js"
+        ],
+        "install": {
+            "npm": [
+                "standard"
+            ]
+        },
+        "linter_banner_image_url": "https://github.com/standard/standard/raw/master/sticker.png",
+        "linter_name": "standard",
+        "linter_url": "https://github.com/standard/standard",
+        "name": "JAVASCRIPT_STANDARD"
+    }
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + processing_order
Type: number Default: 0
+

If descriptor linters may be slow, put a negative processing order. If it is fast, put a positive one. If you don't know, do not set

+ + + + + + +
+
Example:
+
[
+    -9,
+    0,
+    9
+]
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + test_folder
Type: string
+

Test folder containing good and bad files. Default: lowercase(descriptor_id)

+ + + + + + +
+
Example:
+
[
+    "bash_shfmt",
+    "terraform_terrascan"
+]
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/docs/json-schemas/schema_doc.min.js b/docs/json-schemas/schema_doc.min.js index 0d9c7882d8f..17eceaf59a3 100644 --- a/docs/json-schemas/schema_doc.min.js +++ b/docs/json-schemas/schema_doc.min.js @@ -1 +1 @@ -function flashElement(t){myElement=document.getElementById(t),myElement.classList.add("jsfh-animated-property"),setTimeout(function(){myElement.classList.remove("jsfh-animated-property")},1e3)}function setAnchor(t){history.pushState({},"",t)}function anchorOnLoad(){let t=window.location.hash.split("?")[0].split("&")[0];"#"===t[0]&&(t=t.substr(1)),t.length>0&&anchorLink(t)}function anchorLink(t){$("#"+t).parents().addBack().filter(".collapse:not(.show), .tab-pane, [role='tab']").each(function(t){if($(this).hasClass("collapse"))$(this).collapse("show");else if($(this).hasClass("tab-pane")){const t=$("a[href='#"+$(this).attr("id")+"']");t&&t.tab("show")}else"tab"===$(this).attr("role")&&$(this).tab("show")}),setTimeout(function(){let e=document.getElementById(t);e&&(e.scrollIntoView({block:"center",behavior:"smooth"}),setTimeout(function(){flashElement(t)},500))},1e3)}$(document).on("click",'a[href^="#"]',function(t){t.preventDefault(),history.pushState({},"",this.href)}); \ No newline at end of file +$(document).on("click",'a[href^="#"]',function(event){event.preventDefault();history.pushState({},"",this.href)});function flashElement(elementId){myElement=document.getElementById(elementId);myElement.classList.add("jsfh-animated-property");setTimeout(function(){myElement.classList.remove("jsfh-animated-property")},1e3)}function setAnchor(anchorLinkDestination){history.pushState({},"",anchorLinkDestination)}function anchorOnLoad(){let linkTarget=decodeURIComponent(window.location.hash.split("?")[0].split("&")[0]);if(linkTarget[0]==="#"){linkTarget=linkTarget.substr(1)}if(linkTarget.length>0){anchorLink(linkTarget)}}function anchorLink(linkTarget){const target=$("#"+linkTarget);target.parents().addBack().filter(".collapse:not(.show), .tab-pane, [role='tab']").each(function(index){if($(this).hasClass("collapse")){$(this).collapse("show")}else if($(this).hasClass("tab-pane")){const tabToShow=$("a[href='#"+$(this).attr("id")+"']");if(tabToShow){tabToShow.tab("show")}}else if($(this).attr("role")==="tab"){$(this).tab("show")}});setTimeout(function(){let targetElement=document.getElementById(linkTarget);if(targetElement){targetElement.scrollIntoView({block:"center",behavior:"smooth"});setTimeout(function(){flashElement(linkTarget)},500)}},1e3)} \ No newline at end of file From 18eba195236bdf907539fc4acbfcb3bccd41dec0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edouard=20Choini=C3=A8re?= <27212526+echoix@users.noreply.github.com> Date: Mon, 16 Jan 2023 22:00:48 -0500 Subject: [PATCH 2/3] Update CHANGELOG.md --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d1168079c5..795e4a1cf87 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,9 @@ Note: Can be used with `oxsecurity/megalinter@beta` in your GitHub Action mega-l - Change name of config file for powershell formatter to avoid collision with powershell linter config - Enhance find SARIF json in stdout output +- Documentation + - Configure jsonschema documentation formatting (see [Descriptor schema](https://megalinter.io/latest/json-schemas/descriptor.html), [Configuration schema](https://megalinter.io/latest/json-schemas/configuration.html)), by @echoix in [#2270](https://github.com/oxsecurity/megalinter/pull/2270) + - Linter versions upgrades - [prettier](https://prettier.io/) from 2.8.1 to **2.8.2** on 2023-01-07 - [dotnet-format](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-format) from 000 to **6.0.404** on 2023-01-07 From b086a7b1a9ecf1315c9acbb1161d444d9d7183fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edouard=20Choini=C3=A8re?= <27212526+echoix@users.noreply.github.com> Date: Mon, 16 Jan 2023 22:13:38 -0500 Subject: [PATCH 3/3] Add username of @echoix in cspell exclusions --- .github/linters/.cspell.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/linters/.cspell.json b/.github/linters/.cspell.json index 178b250b527..62f3151bd45 100644 --- a/.github/linters/.cspell.json +++ b/.github/linters/.cspell.json @@ -566,6 +566,7 @@ "dupl", "dustilock", "dzhu", + "echoix", "ecrc", "editorconfig", "ehlo", @@ -1361,4 +1362,4 @@ "\u0636clojure", "\u077bcbad" ] -} +} \ No newline at end of file