Super-Linter

This repository is for the GitHub Action to run a Super-Linter. It is a simple combination of various linters, written in bash, to help validate your source code.

The end goal of this tool:

• Prevent broken code from being uploaded to the default branch (Usually master)
• Help establish coding best practices across multiple languages
• Build guidelines for code layout and format
• Automate the process to help streamline code reviews

Table of Contents

• Super-Linter
  • Table of Contents
  • How it Works
  • Supported Linters
  • How to use
    • Example connecting GitHub Action Workflow
  • Environment variables
    • Template rules files
  • Disabling rules
  • Docker Hub
  • Run Super-Linter outside GitHub Actions
    • Local (troubleshooting/debugging/enhancements)
    • Azure
    • GitLab
    • Visual Studio Code
  • Limitations
  • How to contribute
    • License

How it Works

The super-linter finds issues and reports them to the console output. Fixes are suggested in the console output but not automatically fixed, and a status check will show up as failed on the pull request.

The design of the Super-Linter is currently to allow linting to occur in GitHub Actions as a part of continuous integration occurring on pull requests as the commits get pushed. It works best when commits are being pushed early and often to a branch with an open or draft pull request. There is some desire to move this closer to local development for faster feedback on linting errors but this is not yet supported.

Supported Linters

Developers on GitHub can call the GitHub Action to lint their code base with the following list of linters:

Language	Linter
Ansible	ansible-lint
Azure Resource Manager (ARM)	arm-ttk
AWS CloudFormation templates	cfn-lint
C#	dotnet-format
CSS	stylelint
Clojure	clj-kondo
CoffeeScript	coffeelint
Dart	dartanalyzer
Dockerfile	dockerfilelint / hadolint
EDITORCONFIG	editorconfig-checker
ENV	dotenv-linter
Golang	golangci-lint
Groovy	npm-groovy-lint
HTML	HTMLHint
Java	checkstyle
JavaScript	eslint / standard js
JSON	jsonlint
Kotlin	ktlint
LaTeX	ChkTex
Lua	luacheck
Markdown	markdownlint
OpenAPI	spectral
Perl	perlcritic
PHP	PHP built-in linter / PHP CodeSniffer / PHPStan / Psalm
PowerShell	PSScriptAnalyzer
Protocol Buffers	protolint
Python3	pylint / flake8 / black
R	lintr
Raku	Raku
Ruby	RuboCop
Shell	Shellcheck / [executable bit check] / shfmt
SQL	sql-lint
Terraform	tflint / terrascan
TypeScript	eslint / standard js
XML	LibXML
YAML	YamlLint

How to use

More in-depth tutorial available

To use this GitHub Action you will need to complete the following:

1. Create a new file in your repository called .github/workflows/linter.yml
2. Copy the example workflow from below into that new file, no extra configuration required
3. Commit that file to a new branch
4. Open up a pull request and observe the action working
5. Enjoy your more stable, and cleaner code base
6. Check out the Wiki for customization options

NOTE: If you pass the Environment variable GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} in your workflow, then the GitHub Super-Linter will mark the status of each individual linter run in the Checks section of a pull request. Without this you will only see the overall status of the full run. There is no need to set the GitHub Secret as it is automatically set by GitHub, it only needs to be passed to the action.

Example connecting GitHub Action Workflow

In your repository you should have a .github/workflows folder with GitHub Action similar to below:

• .github/workflows/linter.yml

This file should have the following code:

---
###########################
###########################
## Linter GitHub Actions ##
###########################
###########################
name: Lint Code Base

#
# Documentation:
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
#

#############################
# Start the job on all push #
#############################
on:
  push:
    branches-ignore: [master]
    # Remove the line above to run when pushing to master
  pull_request:
    branches: [master]

###############
# Set the Job #
###############
jobs:
  build:
    # Name the Job
    name: Lint Code Base
    # Set the agent to run on
    runs-on: ubuntu-latest

    ##################
    # Load all steps #
    ##################
    steps:
      ##########################
      # Checkout the code base #
      ##########################
      - name: Checkout Code
        uses: actions/checkout@v2

      ################################
      # Run Linter against code base #
      ################################
      - name: Lint Code Base
        uses: github/super-linter@v3
        env:
          VALIDATE_ALL_CODEBASE: false
          DEFAULT_BRANCH: master
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Environment variables

The super-linter allows you to pass the following ENV variables to be able to trigger different functionality.

Note: All the VALIDATE_[LANGUAGE] variables behave in a very specific way:

• If none of them are passed, then they all default to true.
• If any one of the variables are set to true, we default to leaving any unset variable to false (only validate those languages).
• If any one of the variables are set to false, we default to leaving any unset variable to true (only exclude those languages).
• If there are VALIDATE_[LANGUAGE] variables set to both true and false. It will fail.

This means that if you run the linter "out of the box", all languages will be checked. But if you wish to select or exclude specific linters, we give you full control to choose which linters are run, and won't run anything unexpected.

ENV VAR	Default Value	Notes
ACTIONS_RUNNER_DEBUG	false	Flag to enable additional information about the linter, versions, and additional output.
ANSIBLE_DIRECTORY	/ansible	Flag to set the root directory for Ansible file location(s).
CSS_FILE_NAME	.stylelintrc.json	Filename for Stylelint configuration (ex: .stylelintrc.yml, .stylelintrc.yaml)
DEFAULT_BRANCH	master	The name of the repository default branch.
DEFAULT_WORKSPACE	/tmp/lint	The location containing files to lint if you are running locally.
DISABLE_ERRORS	false	Flag to have the linter complete with exit code 0 even if errors were detected.
DOCKERFILE_HADOLINT_FILE_NAME	.hadolint.yml	Filename for hadolint configuration (ex: .hadolintlintrc.yaml)
FILTER_REGEX_EXCLUDE	none	Regular expression defining which files will be excluded from linting (ex: .*src/test.*)
FILTER_REGEX_INCLUDE	all	Regular expression defining which files will be processed by linters (ex: .*src/.*)
JAVASCRIPT_ES_CONFIG_FILE	.eslintrc.yml	Filename for eslint configuration (ex: .eslintrc.yml, .eslintrc.json)
LINTER_RULES_PATH	.github/linters	Directory for all linter configuration rules.
LOG_FILE	super-linter.log	The file name for outputting logs. All output is sent to the log file regardless of LOG_LEVEL.
LOG_LEVEL	VERBOSE	How much output the script will generate to the console. One of VERBOSE, DEBUG or TRACE.
MULTI_STATUS	true	A status API is made for each language that is linted to make visual parsing easier.
MARKDOWN_CONFIG_FILE	.markdown-lint.yml	Filename for Markdownlint configuration (ex: .markdown-lint.yml, .markdownlint.json, .markdownlint.yaml)
OUTPUT_FORMAT	none	The report format to be generated, besides the stdout one. Output format of tap is currently using v13 of the specification. Supported formats: tap
OUTPUT_FOLDER	super-linter.report	The location where the output reporting will be generated to. Output folder must not previously exist.
OUTPUT_DETAILS	simpler	What level of details to be reported. Supported formats: simpler or detailed.
PYTHON_PYLINT_CONFIG_FILE	.python-lint	Filename for pylint configuration (ex: .python-lint, .pylintrc)
PYTHON_FLAKE8_CONFIG_FILE	.flake8	Filename for flake8 configuration (ex: .flake8, tox.ini)
PYTHON_BLACK_CONFIG_FILE	.python-black	Filename for black configuration (ex: .isort.cfg, pyproject.toml)
RUBY_CONFIG_FILE	.ruby-lint.yml	Filename for rubocop configuration (ex: .ruby-lint.yml, .rubocop.yml)
TYPESCRIPT_ES_CONFIG_FILE	.eslintrc.yml	Filename for eslint configuration (ex: .eslintrc.yml, .eslintrc.json)
VALIDATE_ALL_CODEBASE	true	Will parse the entire repository and find all files to validate across all types. NOTE: When set to false, only new or edited files will be parsed for validation.
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_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_COFFEE	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 language.
VALIDATE_DART	true	Flag to enable or disable the linting process of the Dart language.
VALIDATE_DOCKERFILE	true	Flag to enable or disable the linting process of the Docker language.
VALIDATE_DOCKERFILE_HADOLINT	true	Flag to enable or disable the linting process of the Docker language.
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_GO	true	Flag to enable or disable the linting process of the Golang language.
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_JAVA	true	Flag to enable or disable the linting process of the language.
VALIDATE_JAVASCRIPT_ES	true	Flag to enable or disable the linting process of the Javascript language. (Utilizing: eslint)
VALIDATE_JAVASCRIPT_STANDARD	true	Flag to enable or disable the linting process of the Javascript language. (Utilizing: standard)
VALIDATE_JSON	true	Flag to enable or disable the linting process of the JSON language.
VALIDATE_JSX	true	Flag to enable or disable the linting process for jsx files (Utilizing: eslint)
VALIDATE_KOTLIN	true	Flag to enable or disable the linting process of the Kotlin language.
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_MD	true	Flag to enable or disable the linting process of the Markdown 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_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_PYLINT	true	Flag to enable or disable the linting process of the Python language. (Utilizing: pylint)
VALIDATE_PYTHON_FLAKE8	true	Flag to enable or disable the linting process of the Python language. (Utilizing: flake8)
VALIDATE_PYTHON_BLACK	true	Flag to enable or disable the linting process of the Python language. (Utilizing: black)
VALIDATE_POWERSHELL	true	Flag to enable or disable the linting process of the Powershell language.
VALIDATE_R	true	Flag to enable or disable the linting process of the R language.
VALIDATE_RAKU	true	Flag to enable or disable the linting process of the Raku language.
VALIDATE_RUBY	true	Flag to enable or disable the linting process of the Ruby language.
VALIDATE_SHELL_SHFMT	true	Flag to enable or disable the linting process of Shell scripts. (Utilizing: shfmt)
VALIDATE_STATES	true	Flag to enable or disable the linting process for AWS States Language.
VALIDATE_SQL	true	Flag to enable or disable the linting process of the SQL language.
VALIDATE_TERRAFORM	true	Flag to enable or disable the linting process of the Terraform language.
VALIDATE_TERRAFORM_TERRASCAN	true	Flag to enable or disable the linting process of the Terraform language for security related issues.
VALIDATE_TSX	true	Flag to enable or disable the linting process for tsx files (Utilizing: eslint)
VALIDATE_TYPESCRIPT_ES	true	Flag to enable or disable the linting process of the Typescript language. (Utilizing: eslint)
VALIDATE_TYPESCRIPT_STANDARD	true	Flag to enable or disable the linting process of the Typescript language. (Utilizing: standard)
VALIDATE_XML	true	Flag to enable or disable the linting process of the XML language.
VALIDATE_YAML	true	Flag to enable or disable the linting process of the YAML language.
YAML_CONFIG_FILE	.yaml-lint.yml	Filename for Yamllint configuration (ex: .yaml-lint.yml, .yamllint.yml)

Template rules files

You can use the GitHub Super-Linter with or without your own personal rules sets. This allows for greater flexibility for each individual code base. The Template rules all try to follow the standards we believe should be enabled at the basic level.

• Copy any or all template rules files from TEMPLATES/ into your repository in the location: .github/linters/ of your repository
  • If your repository does not have rules files, they will fall back to defaults in this repository's TEMPLATE folder

Disabling rules

If you need to disable certain rules and functionality, you can view Disable Rules

Filter linted files

If you need to lint only a folder or exclude some files from linting, you can use optional environment parameters FILTER_REGEX_INCLUDE and FILTER_REGEX_EXCLUDE

Examples :

• Lint only src folder: INCLUDED_FILES_REGEX=.*src/.*
• Do not lint files inside test folder: EXCLUDED_FILES_REGEX=.*test/.*
• Do not lint javascript files inside test folder: EXCLUDED_FILES_REGEX=.*test/.*.js

Docker Hub

The Docker container that is built from this repository is located at github/super-linter

Run Super-Linter outside GitHub Actions

Local (troubleshooting/debugging/enhancements)

If you find that you need to run super-linter locally, you can follow the documentation at Running super-linter locally

Check out the note in How it Works to understand more about the Super-Linter linting locally versus via continuous integration.

Azure

Check out this article

GitLab

Check out this snippet

Visual Studio Code

You can checkout this repository using Container Remote Development, and debug the linter using the Test Linter task.

We will also support GitHub Codespaces once it becomes available

Limitations

Below are a list of the known limitations for the GitHub Super-Linter:

• Due to being completely packaged at run time, you will not be able to update dependencies or change versions of the enclosed linters and binaries
• Additional details from package.json are not read by the GitHub Super-Linter
• Downloading additional codebases as dependencies from private repositories will fail due to lack of permissions

How to contribute

If you would like to help contribute to this GitHub Action, please see CONTRIBUTING

---

License

• MIT License