super-linter README

The project's README from github.com/super-linter/super-linter. As one markdown file: README.md.

Super-Linter

Super-linter is a ready-to-run collection of linters and code analyzers, to help validate and fix your source code.

The goal of super-linter is to help you establish best practices and consistent formatting across multiple programming languages, and ensure developers are adhering to those conventions.

Super-linter analyzes source code files using several tools, and reports the issues that those tools find as console output, and as GitHub Actions status checks. You can also run super-linter outside GitHub Actions.

Super-linter can also help you fix linting and formatting issues.

Super-linter is licensed under an MIT License.

Super-Linter

Here are some notable Super-linter features:

How to contribute

If you would like to help contribute to Super-linter, see CONTRIBUTING.

For a guide on how to set up your development environment and contribute to Super-linter, see the development guide.

Supported linters and formatters

Super-linter supports the following tools:

Language Linters Formatters
Ansible ansible-lint See YAML and Python formatters
Amazon States Language ASL Validator See JSON formatters
Astro Biome Biome
AWS CloudFormation templates AWS CloudFormation Linter (cfn-lint), Checkov, Trivy See YAML formatters
Azure Resource Manager (ARM) Azure Resource Manager Template Toolkit (arm-ttk), Checkov, Trivy See JSON formatters
C, C++ cpp-lint clang-format
C# See Dotnet solutions dotnet format whitespace command
CSS, SCSS, Sass stylelint, Biome Prettier, Biome
Clojure clj-kondo
CoffeeScript coffeelint
Commit messages commitlint
Copy/paste detection jscpd N/A
Dart dart analyze command
Dockerfile Haskell Dockerfile Linter (Hadolint), Checkov, Trivy
Dotnet (.NET) solutions (sln) dotnet format command: analyzers, style subcommands. dotnet format command: whitespace subcommand.
EditorConfig editorconfig-checker
.env dotenv-linter
Git merge conflict markers Git conflict markers presence in files N/A
GitHub Actions actionlint, zizmor See YAML formatters
Go golangci-lint
GoReleaser GoReleaser See YAML formatters
GraphQL Biome Prettier, Biome
GritQL Biome
Groovy npm-groovy-lint
Helm charts Checkov See YAML formatters
HTML HTMLHint Prettier, Biome
Java checkstyle google-java-format
JavaScript ESLint, Biome Prettier, Biome
JSON eslint-plugin-jsonc (configured for JSON) (ESLint default), eslint-plugin-json, Biome Prettier, Biome
JSONC, JSON5 eslint-plugin-jsonc, Biome Prettier, Biome
JSX, TSX eslint-plugin-jsx-a11y, eslint-plugin-react, Biome Prettier, Biome
Kubernetes Checkov, Trivy, kubeconform See YAML formatters
Kotlin ktlint
LaTeX ChkTex
Licenses Trivy N/A
Lua luacheck
Markdown markdownlint Prettier
Natural language textlint N/A
OpenAPI spectral See YAML formatters
Perl perlcritic
PHP PHP built-in linter, PHP CodeSniffer, PHPStan, Psalm
PowerShell PSScriptAnalyzer
Pre-commit pre-commit
Protocol Buffers (Protobuf) protolint
Python3 pylint, flake8, isort, ruff black
R lintr
Renovate renovate-config-validator See JSON formatters
Ruby RuboCop
Rust Clippy Rustfmt
Scala scalafmt
Software bill of materials (SBOM) Trivy N/A
Secrets GitLeaks, Trivy N/A
Shell ShellCheck, executable bit check shfmt
Snakemake snakemake --lint snakefmt
Spelling codespell N/A
SQL sqlfluff
Svelte Biome Biome
Terraform tflint, Checkov, Trivy terraform fmt
Terragrunt terragrunt N/A
TypeScript ESLint, Biome Prettier, Biome
Vue eslint-plugin-vue, Biome Prettier, Biome
Vulnerabilities Trivy N/A
XML LibXML
YAML YamlLint Prettier

Get started

More in-depth tutorial available

To run super-linter as a GitHub Action, you do the following:

  1. Create a new GitHub Actions workflow in your repository with the following content:

    ---
name: Lint

on: # yamllint disable-line rule:truthy
  push: null
  pull_request: null

permissions: {}

jobs:
  build:
    name: Lint
    runs-on: ubuntu-latest

    permissions:
      # contents permission to clone the repository
      contents: read
      packages: read
      # issues and pull-requests permissions to write results as pull
      # request comments. Omit them if you don't need summary comments
      issues: write
      pull-requests: write
      # To report GitHub Actions status checks. Omit if you don't need
      # to update commit status
      statuses: write

    steps:
      - name: Checkout code
        uses: actions/checkout@v6
        with:
          # super-linter needs the full git history to get the
          # list of files that changed across commits
          fetch-depth: 0
          persist-credentials: false

      - name: Super-linter
        uses: super-linter/[email protected] # x-release-please-version
        env:
          # To report GitHub Actions status checks
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  2. Commit that file to a new branch.

  3. Push the new commit to the remote repository.

  4. Create a new pull request to observe the results.

Upgrade to newer super-linter versions

For more information about upgrading super-linter to a new major version, see the upgrade guide.

Add Super-Linter badge in your repository readme

You can show Super-Linter status with a badge in your repository readme:

Example:

[![Super-Linter](https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE_NAME>/badge.svg)](https://github.com/marketplace/actions/super-linter)

For more information, see Adding a workflow status badge.

Super-linter variants

Super-Linter provides several variants:

Configure Super-linter

You can configure Super-linter using the following environment variables:

Environment variable Default Value Description
ANSIBLE_CONFIG_FILE .ansible-lint.yml Filename for Ansible-lint configuration (ex: .ansible-lint, .ansible-lint.yml)
ANSIBLE_DIRECTORY /ansible Flag to set the root directory for Ansible file location(s), relative to DEFAULT_WORKSPACE. Set to . to use the top-level of the DEFAULT_WORKSPACE.
BASH_EXEC_IGNORE_LIBRARIES false If set to true, shell files with no shebang line are ignored when checking if the executable bit is set.
BASH_FILE_NAME .shellcheckrc Filename for Shellcheck
BASH_SEVERITY Shellcheck default severity Specify the minimum severity of errors to consider in shellcheck. Valid values in order of severity are error, warning, info and style.
CHECKOV_FILE_NAME .checkov.yaml Configuration filename for Checkov.
CLANG_FORMAT_FILE_NAME .clang-format Configuration filename for clang-format.
CREATE_LOG_FILE false If set to true, it creates the log file. You can set the log filename using the LOG_FILE environment variable. This overrides any existing log files.
CSS_FILE_NAME stylelint.config.mjs Filename for Stylelint configuration
DEFAULT_BRANCH Default repository branch when running on GitHub Actions, master otherwise The name of the repository default branch. Don't set this variable when running on GitHub Actions, unless you want to compare changes against a branch that's not the GitHub repository default branch.
DEFAULT_WORKSPACE /tmp/lint The location containing files to lint if you are running locally. Defaults to GITHUB_WORKSPACE when running in GitHub Actions. There's no need to configure this variable when running on GitHub Actions.
DISABLE_ERRORS false Flag to have the linter complete with exit code 0 even if errors were detected.
DOCKERFILE_HADOLINT_FILE_NAME .hadolint.yaml Filename for hadolint configuration (ex: .hadolintlintrc.yaml)
EDITORCONFIG_FILE_NAME .editorconfig-checker.json Filename for editorconfig-checker configuration
ENABLE_COMMITLINT_EDIT_MODE false If set to true checks the commit message that is currently being edited with Commitlint. This is useful to run Super-linter in a commit-msg hook.
ENABLE_COMMITLINT_STRICT_MODE false If set to true, enables commitlint strict mode.
ENABLE_GITHUB_ACTIONS_GROUP_TITLE false if RUN_LOCAL=true, true otherwise Flag to enable GitHub Actions log grouping.
ENABLE_GITHUB_PULL_REQUEST_SUMMARY_COMMENT false if RUN_LOCAL=true, true otherwise If set to true, Super-linter will post a comment to the pull request that triggered the Super-linter workflow.
UPDATE_EXISTING_GITHUB_PULL_REQUEST_SUMMARY_COMMENT true If set to true, Super-linter will update an existing pull request summary comment instead of creating a new one on each run. Only applies when ENABLE_GITHUB_PULL_REQUEST_SUMMARY_COMMENT is set to true.
ENABLE_GITHUB_ACTIONS_STEP_SUMMARY false if RUN_LOCAL=true, true otherwise Flag to enable GitHub Actions job summary for the Super-linter action. For more information, see Summary outputs.
ENFORCE_COMMITLINT_CONFIGURATION_CHECK false If set to true and VALIDATE_GIT_COMMITLINT is set to true, Super-linter exits with an error if there's no commitlint configuration file. Otherwise, Super-linter emits a warning and forcefully sets VALIDATE_GIT_COMMITLINT to false.
EXPORT_GITHUB_TOKEN false If set to true, exports the GITHUB_TOKEN variable so that subprocesses can access it. It's useful when linters and formatters need to authenticate, and support loading credentials from GITHUB_TOKEN.
FAIL_ON_CONFLICTING_TOOLS_ENABLED false If set to true, Super-linter will exit with an error if potentially conflicting linters or formatters are enabled.
FAIL_ON_INVALID_GITHUB_ACTIONS_EVENT_CONFIGURATION false If set to true, Super-linter will exit with an error if the Super-linter configuration is not valid for specific GitHub Actions events.
FILTER_REGEX_EXCLUDE not set Regular expression defining which files will be excluded from linting (ex: .*src/test.*). Not setting this variable means to process all files.
FILTER_REGEX_INCLUDE not set Regular expression defining which files will be processed by linters (ex: .*src/.*). Not setting this variable means to process all files. FILTER_REGEX_INCLUDE is evaluated before FILTER_REGEX_EXCLUDE.
FIX_ANSIBLE false Option to enable fix mode for ANSIBLE.
FIX_BIOME_FORMAT false Option to enable fix mode for BIOME_FORMAT
FIX_BIOME_LINT false Option to enable fix mode for BIOME_LINT
FIX_CLANG_FORMAT false Option to enable fix mode for CLANG_FORMAT.
FIX_CSHARP false Option to enable fix mode for CSHARP.
FIX_CSS_PRETTIER false Flag to enable or disable the formatting of CSS, Sass, and SCSS files with Prettier.
FIX_CSS false Option to enable fix mode for CSS.
FIX_DOTNET_SLN_FORMAT_ANALYZERS false Option to enable or disable fix mode for Dotnet solutions.
FIX_DOTNET_SLN_FORMAT_STYLE false Option to enable or disable fix mode for Dotnet solutions.
FIX_DOTNET_SLN_FORMAT_WHITESPACE false Option to enable or disable fix mode for Dotnet solutions.
FIX_ENV false Option to enable fix mode for ENV.
FIX_GITHUB_ACTIONS_ZIZMOR false Option to enable fix mode for GITHUB_ACTIONS_ZIZMOR.
FIX_GO_MODULES false Option to enable fix mode for GO_MODULES.
FIX_GO false Option to enable fix mode for GO.
FIX_GOOGLE_JAVA_FORMAT false Option to enable fix mode for GOOGLE_JAVA_FORMAT.
FIX_GRAPHQL_PRETTIER false Flag to enable or disable the formatting of GraphQL files with Prettier.
FIX_GROOVY false Option to enable fix mode for GROOVY.
FIX_HTML_PRETTIER false Flag to enable or disable the formatting of HTML files with Prettier.
FIX_JAVASCRIPT_ES false Option to enable fix mode for JAVASCRIPT_ES.
FIX_JAVASCRIPT_PRETTIER false Flag to enable or disable the formatting of JavaScript files with Prettier.
FIX_JSON_PRETTIER false Flag to enable or disable the formatting of JSON files with Prettier.
FIX_JSON false Option to enable fix mode for JSON.
FIX_JSONC false Option to enable fix mode for JSONC.
FIX_JSONC_PRETTIER false Option to enable fix mode for JSONC and JSON5 files with Prettier.
FIX_JSX_PRETTIER false Option to enable fix mode for JSX files with Prettier.
FIX_JSX false Option to enable fix mode for JSX.
FIX_KOTLIN false Option to enable fix mode for KOTLIN.
FIX_MARKDOWN_PRETTIER false Option to enable fix mode for Markdown files with Prettier.
FIX_MARKDOWN false Option to enable fix mode for MARKDOWN.
FIX_NATURAL_LANGUAGE false Option to enable fix mode for NATURAL_LANGUAGE.
FIX_POWERSHELL false Option to enable fix mode for POWERSHELL.
FIX_PROTOBUF false Option to enable fix mode for PROTOBUF.
FIX_PYTHON_BLACK false Option to enable fix mode for PYTHON_BLACK.
FIX_PYTHON_ISORT false Option to enable fix mode for PYTHON_ISORT.
FIX_PYTHON_RUFF false Option to enable fix mode for PYTHON_RUFF.
FIX_PYTHON_RUFF_FORMAT false Option to enable fix mode for PYTHON_RUFF_FORMAT.
FIX_RUBY false Option to enable fix mode for RUBY.
FIX_RUST_2015 false Option to enable fix mode for RUST_2015.
FIX_RUST_2018 false Option to enable fix mode for RUST_2018.
FIX_RUST_2021 false Option to enable fix mode for RUST_2021.
FIX_RUST_2024 false Option to enable fix mode for RUST_2024.
FIX_RUST_CLIPPY false Option to enable fix mode for RUST_CLIPPY. When FIX_RUST_CLIPPY is true, Clippy is allowed to fix issues in the workspace even if there are unstaged and staged changes in the workspace.
FIX_SCALAFMT false Option to enable fix mode for SCALAFMT.
FIX_SHELL_SHFMT false Option to enable fix mode for SHELL_SHFMT.
FIX_SNAKEMAKE_SNAKEFMT false Option to enable fix mode for SNAKEMAKE_SNAKEFMT.
FIX_SPELL_CODESPELL false Option to enable fix mode for SPELL_CODESPELL.
FIX_SQLFLUFF false Option to enable fix mode for SQLFLUFF.
FIX_TERRAFORM_FMT false Option to enable fix mode for TERRAFORM_FMT.
FIX_TSX false Option to enable fix mode for TSX.
FIX_TYPESCRIPT_ES false Option to enable fix mode for TYPESCRIPT_ES.
FIX_TYPESCRIPT_PRETTIER false Flag to enable or disable the formatting of TypeScript files with Prettier.
FIX_VUE false Option to enable fix mode for VUE.
FIX_VUE_PRETTIER false Flag to enable or disable the formatting of Vue files with Prettier.
FIX_YAML_PRETTIER false Flag to enable or disable the formatting of YAML files with Prettier.
GITHUB_ACTIONS_CONFIG_FILE actionlint.yml Filename for Actionlint configuration (ex: actionlint.yml)
GITHUB_ACTIONS_COMMAND_ARGS null Additional arguments passed to actionlint command. Useful to ignore some errors
GITHUB_ACTIONS_ZIZMOR_CONFIG_FILE zizmor.yaml Filename for zizmor configuration file
GITHUB_CUSTOM_API_URL https://api.${GITHUB_DOMAIN} Specify a custom GitHub API URL in case GitHub Enterprise is used: e.g. https://github.myenterprise.com/api/v3
GITHUB_CUSTOM_SERVER_URL https://${GITHUB_DOMAIN}" Specify a custom GitHub server URL. Useful for GitHub Enterprise instances.
GITHUB_DOMAIN github.com Specify a custom GitHub domain in case GitHub Enterprise is used: e.g. github.myenterprise.com. GITHUB_DOMAIN is a convenience configuration variable to automatically build GITHUB_CUSTOM_API_URL and GITHUB_CUSTOM_SERVER_URL.
GITLEAKS_COMMAND_OPTIONS not set Additional options and arguments to pass to the command when running Gitleaks
GITLEAKS_CONFIG_FILE .gitleaks.toml Filename for GitLeaks configuration (ex: .gitleaks.toml)
GITLEAKS_LOG_LEVEL Gitleaks default log level Gitleaks log level. Defaults to the Gitleaks default log level.
GO_CONFIG_FILE .golangci.yml Filename for golangci-lint configuration (ex: .golangci.toml)
GROOVY_FAILON_LEVEL warning npm-groovy-lint failon level.
GROOVY_LOG_LEVEL info npm-groovy-lint log level.
IGNORE_GENERATED_FILES false If set to true, super-linter will ignore all the files with @generated marker but without @not-generated marker.
IGNORE_GITIGNORED_FILES false If set to true, super-linter will ignore all the files that are ignored by Git.
JAVA_COMMAND_ARGS not set Additional command options to pass to Checkstyle. For more information about the available options, see checkstyle command line usage.
JAVA_JVM_COMMAND_ARGS not set Additional command options to pass to the Java Virtual Machine (JVM) when running Checkstyle. For example, can be used to specify additional configuration parameters via Java properties, such as Suppression Filter files, for example: -Dorg.checkstyle.sun.suppressionfilter.config=path/to/suppressions.xml
JAVA_FILE_NAME sun_checks.xml Filename for Checkstyle configuration. Checkstyle embeds several configuration files, such as sun_checks.xml, google_checks.xml that you can use without providing your own configuration file.
JAVASCRIPT_ES_CONFIG_FILE eslint.config.mjs Filename for ESLint configuration
JSCPD_CONFIG_FILE .jscpd.json Filename for JSCPD configuration
KUBERNETES_KUBECONFORM_OPTIONS not set Additional arguments to pass to the command-line when running Kubeconform (Example: --ignore-missing-schemas)
LINTER_RULES_PATH .github/linters Directory for all linter configuration rules. For more information, see Configure Linters.
LOG_FILE super-linter.log The filename for outputting logs. Super-linter saves the log file to ${DEFAULT_WORKSPACE}/${LOG_FILE}.
LOG_LEVEL INFO How much output the script will generate to the console. One of ERROR, WARN, NOTICE, INFO, or DEBUG.
MARKDOWN_CONFIG_FILE .markdown-lint.yml Filename for Markdownlint configuration (ex: .markdown-lint.yml, .markdownlint.json, .markdownlint.yaml)
MARKDOWN_CUSTOM_RULE_GLOBS not set Comma-separated list of file globs matching custom Markdownlint rule files.
MULTI_STATUS true A status API is made for each language that is linted to make visual parsing easier.
NATURAL_LANGUAGE_CONFIG_FILE .textlintrc Filename for textlint configuration (ex: .textlintrc)
OS_PACKAGES_CONFIG_FILE_NAME os-packages.json Name of the file that holds the list of operating system (OS) packages to install, in JSON format. Relative to LINTER_RULES_PATH. For more information, see Install additional dependencies.
PERL_PERLCRITIC_OPTIONS null Additional arguments to pass to the command-line when running perlcritic (Example: --theme community)
POWERSHELL_CONFIG_FILE .powershell-psscriptanalyzer.psd1 Filename for PSScriptAnalyzer configuration
PHP_CONFIG_FILE php.ini Filename for PHP Configuration (ex: php.ini)
PHP_PHPCS_FILE_NAME phpcs.xml Filename for PHP CodeSniffer (ex: .phpcs.xml, .phpcs.xml.dist)
PHP_PHPSTAN_CONFIG_FILE phpstan.neon Filename for PHPStan Configuration (ex: phpstan.neon)
PRETTIER_COMMAND_OPTIONS not set Additional options and arguments to add to the command when running Prettier. These options will be added to all Prettier invocations, regardless of the LANGUAGE.
PRE_COMMIT_COMMAND_ARGS not set Additional arguments to pass to the pre-commit command.
PRE_COMMIT_CONFIG_FILE .pre-commit-config.yaml Filename for pre-commit configuration
PROTOBUF_CONFIG_FILE .protolintrc.yml Filename for protolint configuration (ex: .protolintrc.yml)
PYTHON_BLACK_CONFIG_FILE .python-black Filename for black configuration (ex: .isort.cfg, pyproject.toml)
PYTHON_FLAKE8_CONFIG_FILE .flake8 Filename for flake8 configuration (ex: .flake8, tox.ini)
PYTHON_ISORT_CONFIG_FILE .isort.cfg Filename for isort configuration (ex: .isort.cfg, pyproject.toml)
PYTHON_MYPY_CONFIG_FILE .mypy.ini Filename for mypy configuration (ex: .mypy.ini, setup.config)
PYTHON_PYLINT_CONFIG_FILE .python-lint Filename for pylint configuration (ex: .python-lint, .pylintrc)
PYTHON_RUFF_CONFIG_FILE .ruff.toml Filename for ruff configuration when linting files.
PYTHON_RUFF_FORMAT_CONFIG_FILE .ruff.toml Filename for ruff configuration when formatting files.
RENOVATE_SHAREABLE_CONFIG_PRESET_FILE_NAMES not set Comma-separated filenames for renovate shareable config preset (ex: default.json)
REMOVE_ANSI_COLOR_CODES_FROM_OUTPUT false If set to true, Super-linter removes ANSI color codes from linters stdout and stderr files, and from the Super-linter log file.
RUBY_CONFIG_FILE .ruby-lint.yml Filename for rubocop configuration (ex: .ruby-lint.yml, .rubocop.yml)
RUN_LOCAL false Set this to true when running outside GitHub Actions or when you want to disable getting environment information from the GitHub Actions environment. For more information about running Super-linter outside GitHub Actions, see Run Super-Linter outside GitHub Actions.
RUST_CLIPPY_COMMAND_OPTIONS not set Additional options and arguments to add to the command when running Clippy.
SAVE_SUPER_LINTER_OUTPUT false If set to true, Super-linter will save its output in the workspace. For more information, see Super-linter outputs.
SAVE_SUPER_LINTER_SUMMARY false If set to true, Super-linter will save a summary. For more information, see Summary outputs.
SCALAFMT_CONFIG_FILE .scalafmt.conf Filename for scalafmt configuration (ex: .scalafmt.conf)
SNAKEMAKE_SNAKEFMT_CONFIG_FILE .snakefmt.toml Filename for Snakemake configuration (ex: pyproject.toml, .snakefmt.toml)
SPELL_CODESPELL_CONFIG_FILE .codespellrc Filename for codespell configuration
SSL_CERT_SECRET none Certification Authority (CA) cert to add to the Super-Linter trust store. This is needed for users on self-hosted runners or need to inject the certificate (ex. ${{ secrets.SSL_CERT }})
SSH_KEY none SSH key that has access to your private repositories
SSH_SETUP_GITHUB false If set to true, adds the github.com SSH key to known_hosts. This is ignored if SSH_KEY is provided - i.e. the github.com SSH key is always added if SSH_KEY is provided
SSH_INSECURE_NO_VERIFY_GITHUB_KEY false INSECURE - If set to true, does not verify the fingerprint of the github.com SSH key before adding this. This is not recommended!
SQLFLUFF_CONFIG_FILE /.sqlfluff Filename for SQLFLUFF configuration (ex: /.sqlfluff, pyproject.toml)
STRIP_DEFAULT_WORKSPACE_FOR_REGEX false Set this to true to strip the value of DEFAULT_WORKSPACE from the list of files to check. For more information, see Include or exclude files from checks.
SUPER_LINTER_OUTPUT_DIRECTORY_NAME super-linter-output Name of the directory where super-linter saves its output.
SUPER_LINTER_SUMMARY_FILE_NAME super-linter-summary.md Name of the file where to save the summary output. For more information, see Summary outputs.
SUPPRESS_FILE_TYPE_WARN false If set to true, will hide warning messages about files without their proper extensions. Default is false
SUPPRESS_OUTPUT_ON_SUCCESS false If set to true, Super-linter will emit logs (and GitHub Actions log groups) only for linters and formatters that returned errors.
SUPPRESS_POSSUM false If set to true, will hide the ASCII possum at top of log output. Default is false
TERRAFORM_TFLINT_CONFIG_FILE .tflint.hcl Filename for tfLint configuration (ex: .tflint.hcl)
TRIVY_CONFIG_FILE trivy.yaml Filename for Trivy
TYPESCRIPT_ES_CONFIG_FILE eslint.config.mjs Filename for ESLint configuration
USE_FIND_ALGORITHM false Set this to true to make Super-linter scan the filesystem to get the list of files to check instead of relying on Git.
VALIDATE_ALL_CODEBASE true Set this to true to lint and format the entire workspace. Set this tofalse to lint and format new or changed files only. For more information, see VALIDATE_ALL_CODEBASE.
VALIDATE_ANSIBLE true Flag to enable or disable the linting process of the Ansible language.
VALIDATE_ARM true Flag to enable or disable the linting process of the ARM language.
VALIDATE_BASH true Flag to enable or disable the linting process of the Bash language.
VALIDATE_BASH_EXEC true Flag to enable or disable the linting process of the Bash language to validate if file is stored as executable.
VALIDATE_BIOME_FORMAT true Option to enable or disable the linting process with biome format.
VALIDATE_BIOME_LINT true Option to enable or disable the linting process with biome lint
VALIDATE_CPP true Flag to enable or disable the linting process of the C++ language.
VALIDATE_CHECKOV true Flag to enable or disable the linting process with Checkov
VALIDATE_CLANG_FORMAT true Flag to enable or disable the linting process of the C++/C language with clang-format.
VALIDATE_CLOJURE true Flag to enable or disable the linting process of the Clojure language.
VALIDATE_CLOUDFORMATION true Flag to enable or disable the linting process of the AWS Cloud Formation language.
VALIDATE_COFFEESCRIPT true Flag to enable or disable the linting process of the CoffeeScript language.
VALIDATE_CSHARP true Flag to enable or disable the linting process of the C# language.
VALIDATE_CSS true Flag to enable or disable the linting process of the CSS, Sass, and SCSS files.
VALIDATE_CSS_PRETTIER true Flag to enable or disable checking the formatting of CSS, Sass, and SCSS files with Prettier.
VALIDATE_DART true Flag to enable or disable the linting process of the Dart language.
VALIDATE_DOCKERFILE_HADOLINT true Flag to enable or disable the linting process of the Docker language.
VALIDATE_DOTNET_SLN_FORMAT_ANALYZERS true Option to enable or disable the linting process of Dotnet solutions.
VALIDATE_DOTNET_SLN_FORMAT_STYLE true Option to enable or disable the linting process of Dotnet solutions.
VALIDATE_DOTNET_SLN_FORMAT_WHITESPACE true Option to enable or disable the linting process of Dotnet solutions.
VALIDATE_EDITORCONFIG true Flag to enable or disable the linting process with the EditorConfig.
VALIDATE_ENV true Flag to enable or disable the linting process of the ENV language.
VALIDATE_GIT_COMMITLINT true Option to enable or disable the linting process of Git commits with commitlint. commitlint needs a configuration file to work. Also, see the ENFORCE_COMMITLINT_CONFIGURATION_CHECK and the ENABLE_COMMITLINT_STRICT_MODE variables.
VALIDATE_GIT_MERGE_CONFLICT_MARKERS true Option to enable or disable checking if files contain Git merge conflict markers.
VALIDATE_GITHUB_ACTIONS true Flag to enable or disable the linting process of the GitHub Actions.
VALIDATE_GITHUB_ACTIONS_ZIZMOR true Flag to enable or disable the linting process of GitHub Actions, Dependabot, GitHub Actions workflows configuration files using zizmor.
VALIDATE_GITLEAKS true Flag to enable or disable the linting process of the secrets.
VALIDATE_GO true Flag to enable or disable the linting process of the individual Go files. Set this to false if you want to lint Go modules. See the VALIDATE_GO_MODULES variable.
VALIDATE_GO_MODULES true Flag to enable or disable the linting process of Go modules. Super-linter considers a directory to be a Go module if it contains a file namedgo.mod.
VALIDATE_GO_RELEASER true Flag to enable or disable the linting process of the GoReleaser config file.
VALIDATE_GRAPHQL_PRETTIER true Flag to enable or disable checking the formatting of GraphQL files with Prettier.
VALIDATE_GOOGLE_JAVA_FORMAT true Flag to enable or disable the linting process of the Java language. (Utilizing: google-java-format)
VALIDATE_GROOVY true Flag to enable or disable the linting process of the language.
VALIDATE_HTML true Flag to enable or disable the linting process of the HTML language.
VALIDATE_HTML_PRETTIER true Flag to enable or disable checking the formatting of HTML files with Prettier.
VALIDATE_JAVA true Flag to enable or disable the linting process of the Java language. (Utilizing: checkstyle)
VALIDATE_JAVASCRIPT_ES true Flag to enable or disable the linting process of the JavaScript language. (Utilizing: ESLint)
VALIDATE_JAVASCRIPT_PRETTIER true Flag to enable or disable checking the formatting of JavaScript files with Prettier.
VALIDATE_JSCPD true Flag to enable or disable JSCPD.
VALIDATE_JSON true Flag to enable or disable the linting process of the JSON language.
VALIDATE_JSON_PRETTIER true Flag to enable or disable checking the formatting of JSON files with Prettier.
VALIDATE_JSONC true Flag to enable or disable the linting process of the JSONC and JSON5 languages.
VALIDATE_JSONC_PRETTIER true Flag to enable or disable checking the formatting of JSONC and JSON5 files with Prettier.
VALIDATE_JSX true Flag to enable or disable the linting process for jsx files (Utilizing: ESLint)
VALIDATE_JSX_PRETTIER true Flag to enable or disable checking the formatting of JSX files with Prettier.
VALIDATE_KOTLIN true Flag to enable or disable the linting process of the Kotlin language.
VALIDATE_KUBERNETES_KUBECONFORM true Flag to enable or disable linting Kubernetes files using Kubeconform.
VALIDATE_LATEX true Flag to enable or disable the linting process of the LaTeX language.
VALIDATE_LUA true Flag to enable or disable the linting process of the language.
VALIDATE_MARKDOWN true Flag to enable or disable the linting process of the Markdown language.
VALIDATE_MARKDOWN_PRETTIER true Flag to enable or disable checking the formatting of Markdown files with Prettier.
VALIDATE_NATURAL_LANGUAGE true Flag to enable or disable the linting process of the natural language.
VALIDATE_OPENAPI true Flag to enable or disable the linting process of the OpenAPI language.
VALIDATE_PERL true Flag to enable or disable the linting process of the Perl language.
VALIDATE_PHP true Flag to enable or disable the linting process of the PHP language. (Utilizing: PHP built-in linter) (keep for backward compatibility)
VALIDATE_PHP_BUILTIN true Flag to enable or disable the linting process of the PHP language. (Utilizing: PHP built-in linter)
VALIDATE_PHP_PHPCS true Flag to enable or disable the linting process of the PHP language. (Utilizing: PHP CodeSniffer)
VALIDATE_PHP_PHPSTAN true Flag to enable or disable the linting process of the PHP language. (Utilizing: PHPStan)
VALIDATE_PHP_PSALM true Flag to enable or disable the linting process of the PHP language. (Utilizing: PSalm)
VALIDATE_POWERSHELL true Flag to enable or disable the linting process of the PowerShell language.
VALIDATE_PRE_COMMIT true Flag to enable or disable running pre-commit.
VALIDATE_PROTOBUF true Flag to enable or disable the linting process of the Protobuf language.
VALIDATE_PYTHON true Flag to enable or disable the linting process of the Python language. (Utilizing: pylint) (keep for backward compatibility)
VALIDATE_PYTHON_BLACK true Flag to enable or disable the linting process of the Python language. (Utilizing: black)
VALIDATE_PYTHON_FLAKE8 true Flag to enable or disable the linting process of the Python language. (Utilizing: flake8)
VALIDATE_PYTHON_ISORT true Flag to enable or disable the linting process of the Python language. (Utilizing: isort)
VALIDATE_PYTHON_MYPY true Flag to enable or disable the linting process of the Python language. (Utilizing: mypy)
VALIDATE_PYTHON_PYLINT true Flag to enable or disable the linting process of the Python language. (Utilizing: pylint)
VALIDATE_PYTHON_RUFF true Flag to enable or disable linting files using Ruff
VALIDATE_PYTHON_RUFF_FORMAT true Flag to enable or disable formatting files using Ruff
VALIDATE_R true Flag to enable or disable the linting process of the R language.
VALIDATE_RENOVATE true Flag to enable or disable the linting process of the Renovate configuration files.
VALIDATE_RUBY true Flag to enable or disable the linting process of the Ruby language.
VALIDATE_RUST_2015 true Flag to enable or disable the linting process of the Rust language. (edition: 2015)
VALIDATE_RUST_2018 true Flag to enable or disable the linting process of Rust language. (edition: 2018)
VALIDATE_RUST_2021 true Flag to enable or disable the linting process of Rust language. (edition: 2021)
VALIDATE_RUST_2024 true Flag to enable or disable the linting process of Rust language. (edition: 2024)
VALIDATE_RUST_CLIPPY true Flag to enable or disable the clippy linting process of Rust language.
VALIDATE_SCALAFMT true Flag to enable or disable the linting process of Scala language. (Utilizing: scalafmt --test)
VALIDATE_SHELL_SHFMT true Flag to enable or disable the linting process of Shell scripts. (Utilizing: shfmt)
VALIDATE_SNAKEMAKE_LINT true Flag to enable or disable the linting process of Snakefiles. (Utilizing: snakemake --lint)
VALIDATE_SNAKEMAKE_SNAKEFMT true Flag to enable or disable the linting process of Snakefiles. (Utilizing: snakefmt)
VALIDATE_SPELL_CODESPELL true Flag to enable or disable the linting process of the spelling language. (Utilizing: codespell)
VALIDATE_STATES

super-linter (super-linter/super-linter)

Searching Database…

10.6K ·GitHub
Super-linter
Что это такое?Готовый к запуску набор линтеров и анализаторов кода, который проверяет исходный код, следит за соблюдением лучших практик и единообразным форматированием в десятках языков и сообщает о проблемах через вывод в консоль и проверки статуса в GitHub Actions.
Это один линтер или целый набор инструментов? И как он вообще запускается?Он объединяет десятки проверенных инструментов (ESLint, ShellCheck, pylint, Clippy, Checkov и другие) в один контейнерный набор. Запускать его можно как GitHub Action или отдельно; единственная зависимость — OCI-совместимая среда для контейнеров, например Docker.
Как добавить его в свой репозиторий?Создайте workflow в GitHub Actions, который вызывает super-linter/super-linter@[VERSION], закоммитьте файл в новую ветку, отправьте её и откройте pull request — результаты появятся как проверки статуса у этого PR.
А если запускать его вне GitHub Actions, что нужно установить?Только OCI-совместимую среду для контейнеров вроде Docker. Укажите DEFAULT_WORKSPACE на папку с файлами, которые нужно проверить, а поведение настраивается через переменные окружения.
Со всеми этими линтерами образ наверняка огромный — есть вариант полегче?Да, есть slim-вариант: super-linter/super-linter/slim@[VERSION] не включает Rustfmt, Rust Clippy, arm-ttk, PSScriptAnalyzer и команды dotnet, но сохраняет все остальные линтеры.
Чем это лучше, чем настроить каждый линтер самому?Здесь тщательно подобранный набор без дублирующихся проверок (меньше лишнего, быстрее сканирование, образ меньше), все включённые линтеры запускаются параллельно начиная с v6 — огромные репозитории сканируются за секунды — и есть тесты, покрывающие каждый входящий инструмент.
Насколько это зрелый и проверенный временем проект?Проект существует с 2019 года, распространяется по лицензии MIT, его поддерживают независимые разработчики без коммерческой поддержки. Он позиционирует себя как первый полностью контейнеризированный open-source набор для линтинга и самый популярный и разветвлённый проект в своей категории.
Насколько строгие проверки — можно ли настроить уровень серьёзности и использовать мои конфиги для каждого инструмента?Каждый инструмент читает свой обычный конфигурационный файл через переменную окружения, например BASH_FILENAME для файла .shellcheckrc у ShellCheck или CLANG_FORMAT_FILENAME для .clang-format, а переключатели вроде BASH_SEVERITY задают минимальный уровень серьёзности проблем, которые стоит учитывать.
What are similar projects?fallow, react-doctor, openqodex, hadolint, perch, procoder, starter-workflows, gitea
Which topics is it in?cicd, linter, code-quality, code-review, static-analysis, best-practices, github-actions, ci, cli-tool, shell, devops, security
Creator
super-linter
Size
48.7 MB
Stars
10.6K
Updated
CommitOct 03Releasev9.0.0Oct 01
Age
6y
Commits · 90 Days