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