malivix / megalinter Goto Github PK

MegaLinter is an Open-Source tool for CI/CD workflows that analyzes the consistency of your code, IAC, configuration, and scripts in your repository sources, to ensure all your projects sources are clean and formatted whatever IDE/toolbox is used by their developers, powered by OX security.

Supporting 51 languages, 23 formats, 21 tooling formats and ready to use out of the box, as a GitHub action or any CI system highly configurable and free for all uses.

Upgrade to MegaLinter v6 !

See Online Documentation Web Site which has a much easier user navigation than this README

Process

Console reporter

Github PR reporter

• MegaLinter
  • Table of Contents
  • Why MegaLinter
  • Quick Start
  • Supported Linters
    • Languages
    • Formats
    • Tooling formats
    • Other
  • Installation
    • Assisted installation
    • Upgrade to MegaLinter v6
    • Manual installation
    • GitHub Action
    • Azure Pipelines
    • GitLab CI
    • Jenkins
    • Concourse
      • Pipeline step
      • Use it as reusable task
    • Run MegaLinter locally
  • Configuration
    • Common variables
    • Activation and deactivation
    • Filter linted files
    • Apply fixes
    • Linter specific variables
    • Pre-commands
    • Post-commands
    • CLI lint mode
  • Reporters
  • Flavors
  • Badge
    • Markdown
    • reStructuredText
  • Plugins
    • Use plugins
      • Example
    • Plugins Catalog
    • Create plugins
      • Limitations
  • Articles
  • Frequently Asked Questions
  • How to contribute
  • Special thanks
    • Contributors
    • Sites referring to MegaLinter
      • Global
      • Linters
    • Open-source teams
    • Super-Linter team
  • License
  • MegaLinter vs Super-Linter
    • Performances
    • More languages and formats linted
    • Automatically apply formatting and fixes
    • Run locally
    • Reports
      • Capabilities
      • Additional Reporters
    • Enhanced Configuration
    • Enhanced Documentation
    • Plugins management
    • Simplify architecture and evolutive maintenance
    • Improve robustness & stability
  • V4 versus V5

Projects need to contain clean code, in order to avoid technical debt, that makes evolutive maintenance harder and time consuming.

By using code formatters and code linters, you ensure that your code base is easier to read and respects best practices, from the kick-off to each step of the project lifecycle

Not all developers have the good habit to use linters in their IDEs, making code reviews harder and longer to process

By using MegaLinter, you'll enjoy the following benefits for you and your team:

• At each pull request it will automatically analyze all updated code in all languages
• Reading error logs, developers learn best practices of the language they are using
• MegaLinter documentation provides the list of IDE plugins integrating each linter, so developers know which linter and plugins to install
• MegaLinter is ready out of the box after a quick setup
• Formatting and fixes can be automatically applied on the git branch or provided in reports
• This tool is 100% open-source and free for all uses (personal, professional, public and private repositories)
• MegaLinter can run on any CI tool and be run locally: no need to authorize an external application, and your code base never leaves your tooling ecosystem

• Run npx mega-linter-runner --install to generate configuration files (you need node.js to be installed)
• Commit, push, and create a pull request
• Watch !

Notes:

• This repo is a hard-fork of GitHub Super-Linter, rewritten in python to add lots of additional features
• If you are a Super-Linter user, you can transparently switch to MegaLinter and keep the same configuration (just replace github/super-linter@v3 by oxsecurity/megalinter@v4 in your GitHub Action YML file, like on this PR)
• If you want to use MegaLinter extra features (recommended), please take 5 minutes to use MegaLinter assisted installation
• For a hand-holdy example of getting started with mega-linter check out this blog post by Alec Johnson

All linters are integrated in the MegaLinter docker image, which is frequently upgraded with their latest versions

	Language	Linter	Configuration key	Additional
	BASH	bash-exec	BASH_EXEC
		shellcheck	BASH_SHELLCHECK
		shfmt	BASH_SHFMT
	C	cpplint	C_CPPLINT
	CLOJURE	clj-kondo	CLOJURE_CLJ_KONDO
	COFFEE	coffeelint	COFFEE_COFFEELINT
	C++ (CPP)	cpplint	CPP_CPPLINT
	C# (CSHARP)	dotnet-format	CSHARP_DOTNET_FORMAT
	DART	dartanalyzer	DART_DARTANALYZER
	GO	golangci-lint	GO_GOLANGCI_LINT
		revive	GO_REVIVE
	GROOVY	npm-groovy-lint	GROOVY_NPM_GROOVY_LINT
	JAVA	checkstyle	JAVA_CHECKSTYLE
		pmd	JAVA_PMD
	JAVASCRIPT	eslint	JAVASCRIPT_ES
		standard	JAVASCRIPT_STANDARD
		prettier	JAVASCRIPT_PRETTIER
	JSX	eslint	JSX_ESLINT
	KOTLIN	ktlint	KOTLIN_KTLINT
	LUA	luacheck	LUA_LUACHECK
	MAKEFILE	checkmake	MAKEFILE_CHECKMAKE
	PERL	perlcritic	PERL_PERLCRITIC
	PHP	phpcs	PHP_PHPCS
		phpstan	PHP_PHPSTAN
		psalm	PHP_PSALM
		phplint	PHP_PHPLINT
	POWERSHELL	powershell	POWERSHELL_POWERSHELL
	PYTHON	pylint	PYTHON_PYLINT
		black	PYTHON_BLACK
		flake8	PYTHON_FLAKE8
		isort	PYTHON_ISORT
		bandit	PYTHON_BANDIT
		mypy	PYTHON_MYPY
		pyright	PYTHON_PYRIGHT
	R	lintr	R_LINTR
	RAKU	raku	RAKU_RAKU
	RUBY	rubocop	RUBY_RUBOCOP
	RUST	clippy	RUST_CLIPPY
	SALESFORCE	sfdx-scanner-apex	SALESFORCE_SFDX_SCANNER_APEX
		sfdx-scanner-aura	SALESFORCE_SFDX_SCANNER_AURA
		sfdx-scanner-lwc	SALESFORCE_SFDX_SCANNER_LWC
	SCALA	scalafix	SCALA_SCALAFIX
	SQL	sql-lint	SQL_SQL_LINT
		sqlfluff	SQL_SQLFLUFF
		tsqllint	SQL_TSQLLINT
	SWIFT	swiftlint	SWIFT_SWIFTLINT
	TSX	eslint	TSX_ESLINT
	TYPESCRIPT	eslint	TYPESCRIPT_ES
		standard	TYPESCRIPT_STANDARD
		prettier	TYPESCRIPT_PRETTIER
	Visual Basic .NET (VBDOTNET)	dotnet-format	VBDOTNET_DOTNET_FORMAT

	Format	Linter	Configuration key	Additional
	CSS	stylelint	CSS_STYLELINT
		scss-lint	CSS_SCSS_LINT
	ENV	dotenv-linter	ENV_DOTENV_LINTER
	GRAPHQL	graphql-schema-linter	GRAPHQL_GRAPHQL_SCHEMA_LINTER
	HTML	djlint	HTML_DJLINT
		htmlhint	HTML_HTMLHINT
	JSON	jsonlint	JSON_JSONLINT
		eslint-plugin-jsonc	JSON_ESLINT_PLUGIN_JSONC
		v8r	JSON_V8R
		prettier	JSON_PRETTIER
	LATEX	chktex	LATEX_CHKTEX
	MARKDOWN	markdownlint	MARKDOWN_MARKDOWNLINT
		remark-lint	MARKDOWN_REMARK_LINT
		markdown-link-check	MARKDOWN_MARKDOWN_LINK_CHECK
		markdown-table-formatter	MARKDOWN_MARKDOWN_TABLE_FORMATTER
	PROTOBUF	protolint	PROTOBUF_PROTOLINT
	RST	rst-lint	RST_RST_LINT
		rstcheck	RST_RSTCHECK
		rstfmt	RST_RSTFMT
	XML	xmllint	XML_XMLLINT
	YAML	prettier	YAML_PRETTIER
		yamllint	YAML_YAMLLINT
		v8r	YAML_V8R

	Tooling format	Linter	Configuration key	Additional
	ACTION	actionlint	ACTION_ACTIONLINT
	ANSIBLE	ansible-lint	ANSIBLE_ANSIBLE_LINT
	ARM	arm-ttk	ARM_ARM_TTK
	BICEP	bicep_linter	BICEP_BICEP_LINTER
	CLOUDFORMATION	cfn-lint	CLOUDFORMATION_CFN_LINT
	DOCKERFILE	hadolint	DOCKERFILE_HADOLINT
	EDITORCONFIG	editorconfig-checker	EDITORCONFIG_EDITORCONFIG_CHECKER
	GHERKIN	gherkin-lint	GHERKIN_GHERKIN_LINT
	KUBERNETES	kubeval	KUBERNETES_KUBEVAL
		kubeconform	KUBERNETES_KUBECONFORM
	OPENAPI	spectral	OPENAPI_SPECTRAL
	PUPPET	puppet-lint	PUPPET_PUPPET_LINT
	SNAKEMAKE	snakemake	SNAKEMAKE_LINT
		snakefmt	SNAKEMAKE_SNAKEFMT
	TEKTON	tekton-lint	TEKTON_TEKTON_LINT
	TERRAFORM	tflint	TERRAFORM_TFLINT
		terrascan	TERRAFORM_TERRASCAN
		terragrunt	TERRAFORM_TERRAGRUNT
		terraform-fmt	TERRAFORM_TERRAFORM_FMT
		checkov	TERRAFORM_CHECKOV
		kics	TERRAFORM_KICS

	Code quality checker	Linter	Configuration key	Additional
	COPYPASTE	jscpd	COPYPASTE_JSCPD
	REPOSITORY	checkov	REPOSITORY_CHECKOV
		devskim	REPOSITORY_DEVSKIM
		dustilock	REPOSITORY_DUSTILOCK
		git_diff	REPOSITORY_GIT_DIFF
		gitleaks	REPOSITORY_GITLEAKS
		goodcheck	REPOSITORY_GOODCHECK
		secretlint	REPOSITORY_SECRETLINT
		semgrep	REPOSITORY_SEMGREP
		syft	REPOSITORY_SYFT
		trivy	REPOSITORY_TRIVY
	SPELL	misspell	SPELL_MISSPELL
		cspell	SPELL_CSPELL
		proselint	SPELL_PROSELINT

Just run npx mega-linter-runner --install at the root of your repository and answer questions, it will generate ready to use configuration files for MegaLinter :)

• Run npx mega-linter-runner --upgrade to automatically upgrade your configuration from v4 or v5 to v6 :)

The following instructions examples are using latest MegaLinter stable version (v6 , always corresponding to the latest release)

• Docker image: oxsecurity/megalinter:v6
• GitHub Action: oxsecurity/megalinter@v6

You can also use beta version (corresponding to the content of main branch)

• Docker image: oxsecurity/megalinter:beta
• GitHub Action: oxsecurity/megalinter@beta

1. Create a new file in your repository called .github/workflows/mega-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

NOTES:

• If you pass the Environment variable GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} in your workflow, then the MegaLinter 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.
• You can also use it outside of GitHub Actions (CircleCI, Azure Pipelines, Jenkins, GitLab, or even locally with a docker run) , and have status on Github Pull Request if GITHUB_TARGET_URL environment variable exists.

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

• .github/workflows/mega-linter.yml

---
# MegaLinter GitHub Action configuration file
# More info at https://megalinter.github.io
name: MegaLinter

on:
  # Trigger mega-linter at every push. Action will also be visible from Pull Requests to main
  push: # Comment this line to trigger action only on pull-requests (not recommended if you don't pay for GH Actions)
  pull_request:
    branches: [master, main]

env: # Comment env block if you do not want to apply fixes
  # Apply linter fixes configuration
  APPLY_FIXES: all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
  APPLY_FIXES_EVENT: pull_request # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
  APPLY_FIXES_MODE: commit # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)

concurrency:
  group: ${{ github.ref }}-${{ github.workflow }}
  cancel-in-progress: true

jobs:
  build:
    name: MegaLinter
    runs-on: ubuntu-latest
    steps:
      # Git Checkout
      - name: Checkout Code
        uses: actions/checkout@v3
        with:
          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
          fetch-depth: 0 # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performances

      # MegaLinter
      - name: MegaLinter
        id: ml
        # You can override MegaLinter flavor used to have faster performances
        # More info at https://megalinter.github.io/flavors/
        uses: oxsecurity/megalinter@v6
        env:
          # All available variables are described in documentation
          # https://megalinter.github.io/configuration/
          VALIDATE_ALL_CODEBASE: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} # Validates all source when push on main, else just the git diff with main. Override with true if you always want to lint all sources
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          # ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
          # DISABLE: COPYPASTE,SPELL # Uncomment to disable copy-paste and spell checks

      # Upload MegaLinter artifacts
      - name: Archive production artifacts
        if: ${{ success() }} || ${{ failure() }}
        uses: actions/upload-artifact@v3
        with:
          name: MegaLinter reports
          path: |
            megalinter-reports
            mega-linter.log

      # Create pull request if applicable (for now works only on PR from same repository, not from forks)
      - name: Create Pull Request with applied fixes
        id: cpr
        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
        uses: peter-evans/create-pull-request@v4
        with:
          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
          commit-message: "[MegaLinter] Apply linters automatic fixes"
          title: "[MegaLinter] Apply linters automatic fixes"
          labels: bot
      - name: Create PR output
        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
        run: |
          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"

      # Push new commit if applicable (for now works only on PR from same repository, not from forks)
      - name: Prepare commit
        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
        run: sudo chown -Rc $UID .git/
      - name: Commit and push applied linter fixes
        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
        uses: stefanzweifel/git-auto-commit-action@v4
        with:
          branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
          commit_message: "[MegaLinter] Apply linters fixes"

Create or update .gitlab-ci.yml file at the root of your repository

# MegaLinter GitLab CI job configuration file
# More info at https://megalinter.github.io/

mega-linter:
  stage: test
  # You can override MegaLinter flavor used to have faster performances
  # More info at https://megalinter.github.io/flavors/
  image: oxsecurity/megalinter:v6
  script: [ "true" ] # if script: ["true"] does not work, you may try ->  script: [ "/bin/bash /entrypoint.sh" ]
  variables:
    # All available variables are described in documentation
    # https://megalinter.github.io/configuration/
    DEFAULT_WORKSPACE: $CI_PROJECT_DIR
    # ADD YOUR CUSTOM ENV VARIABLES HERE TO OVERRIDE VALUES OF .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
  artifacts:
    when: always
    paths:
      - megalinter-reports
    expire_in: 1 week

Create a Gitlab access token and define it in a variable GITLAB_ACCESS_TOKEN_MEGALINTER in the project CI/CD masked variables

Use the following Azure Pipelines YAML template

Add the following job in your azure-pipelines.yaml file

  # Run MegaLinter to detect linting and security issues
  - job: MegaLinter
    pool:
      vmImage: ubuntu-latest
    steps:
      # Pull MegaLinter docker image
      - script: docker pull oxsecurity/megalinter:v6
        displayName: Pull MegaLinter

      # Run MegaLinter
      - script: |
          docker run -v $(System.DefaultWorkingDirectory):/tmp/lint \
            -e GIT_AUTHORIZATION_BEARER=$(System.AccessToken) \
            -e CI=true \
            -e TF_BUILD=true \
            -e SYSTEM_ACCESSTOKEN=$(System.AccessToken) \
            -e SYSTEM_COLLECTIONURI=$(System.CollectionUri) \
            -e SYSTEM_PULLREQUEST_PULLREQUESTID=$(System.PullRequest.PullRequestId) \
            -e SYSTEM_TEAMPROJECT=$(System.TeamProject) \
            -e BUILD_BUILD_ID=$(Build.BuildId) \
            -e BUILD_REPOSITORY_ID=$(Build.Repository.ID) \
            oxsecurity/megalinter:v6
        displayName: Run MegaLinter

      # Upload MegaLinter reports
      - task: PublishPipelineArtifact@1
        condition: succeededOrFailed()
        displayName: Upload MegaLinter reports
        inputs:
          targetPath: "$(System.DefaultWorkingDirectory)/megalinter-reports/"
          artifactName: MegaLinterReport

To benefit from Pull Request comments, please follow configuration instructions

Add the following stage in your Jenkinsfile

You may activate File.io reporter or E-mail reporter to access detailed logs and fixed source

// Lint with MegaLinter: https://megalinter.github.io/
stage('MegaLinter') {
    agent {
        docker {
            image 'oxsecurity/megalinter:v6'
            args "-u root -e VALIDATE_ALL_CODEBASE=true -v ${WORKSPACE}:/tmp/lint --entrypoint=''"
            reuseNode true
        }
    }
    steps {
        sh '/entrypoint.sh'
    }
    post {
        always {
            archiveArtifacts allowEmptyArchive: true, artifacts: 'mega-linter.log,megalinter-reports/**/*', defaultExcludes: false, followSymlinks: false  
        }
    }
}

Use the following job.step in your pipeline template

Note: make sure you have job.plan.get step which gets repo containing your repository as shown in example

---

  - name: linting
    plan:
      - get: repo
      - task: linting
        config:
          platform: linux
          image_resource:
            type: docker-image
            source:
              repository: oxsecurity/megalinter
              tag: v6
          inputs:
            - name: repo
          run:
            path: bash
            args:
            - -cxe
            - |
              cd repo
              export DEFAULT_WORKSPACE=$(pwd)
              bash -ex /entrypoint.sh
              ## doing this because concourse does not work as other CI systems
          # params:
            # PARALLEL: true
            # DISABLE: SPELL
            # APPLY_FIXES: all
            # DISABLE_ERRORS: true
            # VALIDATE_ALL_CODEBASE: true

OR

Create reusable concourse task which can be used with multiple pipelines

1. Create task file task-linting.yaml

---
platform: linux
image_resource:
  type: docker-image
  source:
    repository: oxsecurity/megalinter
    tag: v6

inputs:
- name: repo

## uncomment this if you want reports as task output
# output:
# - name: reports
#   path: repo/megalinter-reports

run:
  path: bash
  args:
  - -cxe
  - |
    cd repo
    export DEFAULT_WORKSPACE=$(pwd)
    bash -ex /entrypoint.sh

2. Use that task-linting.yaml task in pipeline

Note:

1. make sure task-linting.yaml is available in that repo input at root

2. task output is not shown here

resources:

  - name: linting
    plan:
      - get: repo
      - task: linting
        file: repo/task-linting.yaml
        # params:
        #   PARALLEL: true
        #   DISABLE: SPELL
        #   APPLY_FIXES: all
        #   DISABLE_ERRORS: true
        #   VALIDATE_ALL_CODEBASE: true

You can use mega-linter-runner to locally run MegaLinter with the same configuration defined in .mega-linter.yml file

See mega-linter-runner installation instructions

Example

npx mega-linter-runner --flavor salesforce -e 'ENABLE=,DOCKERFILE,MARKDOWN,YAML' -e 'SHOW_ELAPSED_TIME=true'

Note: You can also use such command line in your custom CI/CD pipelines

MegaLinter configuration variables can be defined in a .mega-linter.yml file at the root of the repository or with environment variables. You can see an example config file in this repo: .mega-linter.yml

Configuration is assisted with auto-completion and validation in most commonly used IDEs, thanks to JSON schema stored on schemastore.org

• VSCode: You need a VSCode extension like Red Hat YAML
• IDEA family: Auto-completion natively supported

MegaLinter have all linters enabled by default, but allows to enable only some, or disable only some

• If ENABLE is not set, all descriptors are activated by default. If set, all linters of listed descriptors will be activated by default
• If ENABLE_LINTERS is set, only listed linters will be processed
• If DISABLE is set, the linters in the listed descriptors will be skipped
• If DISABLE_LINTERS is set, the listed linters will be skipped
• If DISABLE_ERRORS_LINTERS is set, the linter linters will be run, but if errors are found, they will be considered as non blocking

Examples:

• Run all javascript and groovy linters except STANDARD javascript linter. DevSkim errors will be non-blocking

ENABLE: JAVASCRIPT,GROOVY
DISABLE_LINTERS: JAVASCRIPT_STANDARD
DISABLE_ERRORS_LINTERS: REPOSITORY_DEVSKIM

• Run all linters except PHP linters (PHP_BUILTIN, PHP_PHPCS, PHP_PHPSTAN, PHP_PSALM)

DISABLE: PHP

• Run all linters except PHP_PHPSTAN and PHP_PSALM linters

DISABLE_LINTERS: 
  - PHP_PHPSTAN
  - PHP_PSALM

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 You can apply filters to a single linter by defining variable <LINTER_KEY>_FILTER_REGEX_INCLUDE and <LINTER_KEY>_FILTER_REGEX_EXCLUDE

Examples:

• Lint only src folder: FILTER_REGEX_INCLUDE: (src/)
• Do not lint files inside test and example folders: FILTER_REGEX_EXCLUDE: (test/|examples/)
• Do not lint javascript files inside test folder: FILTER_REGEX_EXCLUDE: (test/.*\.js)

Warning: not applicable with linters using CLI lint mode project (see details)

Mega-linter is able to apply fixes provided by linters. To use this capability, you need 3 env variables defined at top level

• APPLY_FIXES: all to apply fixes of all linters, or a list of linter keys (ex: JAVASCRIPT_ES,MARKDOWN_MARKDOWNLINT)

Only for GitHub Action Workflow file if you use it:

• APPLY_FIXES_EVENT: all, push, pull_request, none (use none in case of use of Updated sources reporter)
• APPLY_FIXES_MODE: commit to create a new commit and push it on the same branch, or pull_request to create a new PR targeting the branch.

Notes:

• You can use Updated sources reporter if you do not want fixes to be automatically applied on git branch, but download them in a zipped file and manually extract them in your project

• If used, APPLY_FIXES_EVENT and APPLY_FIXES_MODE can not be defined in .mega-linter.ymlconfig file, they must be set as environment variables

• If you use APPLY_FIXES, add the following line in your .gitignore file

megalinter-reports/

• You may see github permission errors, or workflows not run on the new commit. To solve these issues:
  • Create Personal Access Token, then copy the PAT value
  • Define secret variable named PAT on your repository, and paste the PAT value

See variables related to a single linter behavior in linters documentations

MegaLinter can run custom commands before running linters (for example, installing an plugin required by one of the linters you use)

Example in .mega-linter.yml config file

PRE_COMMANDS:
  - command: npm install eslint-plugin-whatever
    cwd: "root"        # Will be run at the root of MegaLinter docker image
  - command: echo "pre-test command has been called"
    cwd: "workspace"   # Will be run at the root of the workspace (usually your repository root)
  - command: pip install flake8-cognitive-complexity
    venv: flake8 # Will be run within flake8 python virtualenv. There is one virtualenv per python-based linter, with the same name

MegaLinter can run custom commands after running linters (for example, running additional tests)

Example in .mega-linter.yml config file

POST_COMMANDS:
  - command: npm run test
    cwd: "workspace"   # Will be run at the root of the workspace (usually your repository root)

Each linter has a lint mode by default, visible in its MegaLinter documentation (example):

• list_of_files: All files are sent in single call to the linter
• project: The linter is called from the root of the project, without specifying any file name
• file: The linter is called once by file (so the performances may not be very good)

You can override the CLI_LINT_MODE by using configuration variable for each linter (see linters documentation)

• Linters with project default lint mode can not be overridden to list_of_files or file

Special considerations:

• As list of files is not sent to the linter command, linters using project lint mode do not take in account some variables like FILTER_REGEX_INCLUDE and FILTER_REGEX_EXCLUDE. For those linters, you must check their documentation to define ignore configuration as it is awaited by the linter (for example with a .secretlintignore file for secretlint)

MegaLinter can generate various reports that you can activate / deactivate and customize

To improve run performances, we generate Flavored MegaLinter images containing only the list of linters related to a project type

• When using default MegaLinter, if a MegaLinter Flavor would cover all your project requirements, a message is added in the logs
• If your project uses a MegaLinter Flavor not covering linter requirements, an error message will be thrown with instructions about how to solve the issue

The following table does not display docker pulls from MegaLinter v4 & v5 images.

	Flavor	Description	Embedded linters	Info
	all	Default MegaLinter Flavor	109
	ci_light	Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML	20
	cupcake	MegaLinter for the most commonly used languages	79
	documentation	MegaLinter for documentation projects	46
	dotnet	Optimized for C, C++, C# or VB based projects	56
	go	Optimized for GO based projects	49
	java	Optimized for JAVA based projects	50
	javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	55
	php	Optimized for PHP based projects	50
	python	Optimized for PYTHON based projects	57
	ruby	Optimized for RUBY based projects	47
	rust	Optimized for RUST based projects	47
	salesforce	Optimized for Salesforce based projects	49
	security	Optimized for security	21
	swift	Optimized for SWIFT based projects	47
	terraform	Optimized for TERRAFORM based projects	52

If you need a new flavor, post an issue 😉

You can show MegaLinter status with a badge in your repository README

If your main branch is main , replace main by main in URLs

• Format

[![MegaLinter](https://github.com/<OWNER>/<REPOSITORY>/workflows/MegaLinter/badge.svg?branch=main)](https://github.com/<OWNER>/<REPOSITORY>/actions?query=workflow%3AMegaLinter+branch%3Amain)

• Example

[![MegaLinter](https://github.com/nvuillam/npm-groovy-lint/workflows/MegaLinter/badge.svg?branch=main)](https://github.com/nvuillam/npm-groovy-lint/actions?query=workflow%3AMegaLinter+branch%3Amain)

• Format

.. |MegaLinter yes| image:: https://github.com/<OWNER>/<REPOSITORY>/workflows/MegaLinter/badge.svg?branch=main
   :target: https://github.com/<OWNER>/<REPOSITORY>/actions?query=workflow%3AMegaLinter+branch%3Amain

• Example

.. |MegaLinter yes| image:: https://github.com/nvuillam/npm-groovy-lint/workflows/MegaLinter/badge.svg?branch=main
   :target: https://github.com/nvuillam/npm-groovy-lint/actions?query=workflow%3AMegaLinter+branch%3Amain

Note: IF you did not use MegaLinter as GitHub Action name, please read GitHub Actions Badges documentation{target=_blank}

For security reasons, we try to embed in MegaLinter only linters that are widely adopted by open-source community.

But any linter can be callable within MegaLinter thanks to the plugin mechanism !

Add plugin URLs in PLUGINS property of .mega-linter.yml. URLs must either begin with "https://" or take the form of "file://<path>", where <path> points to a valid plugin descriptor file.

Note: Both <path> and the default mount directory (/tmp/lint/<path>) will be checked for a valid descriptor.

PLUGINS:
  - https://raw.githubusercontent.com/oxsecurity/megalinter/main/.automation/test/mega-linter-plugin-test/test.megalinter-descriptor.yml
  - https://raw.githubusercontent.com/cookiejar/mega-linter-plugin-cookietemple/main/cookietemple.megalinter-descriptor.yml
  - file://.automation/test/mega-linter-plugin-test/test.megalinter-descriptor.yml

• jupyfmt: The uncompromising Jupyter notebook formatter (usage)
• nitpick: Command-line tool and flake8 plugin to enforce the same settings across multiple language-independent projects. (usage)
• mustache: Plugin to validate Logstash pipeline definition files using mustache

Submit a PR if you want your plugin to appear here :)

You can implement your own descriptors and load them as plugins during MegaLinter runtime

• Descriptor format is exactly the same than MegaLinter embedded ones (see json schema documentation)
• Plugins descriptor files must be named **.megalinter-descriptor.yml and respect MegaLinter Json Schema
• Plugins must be hosted in a url containing **/mega-linter-plugin-**/
• File URLs must conform to the same directory and file naming criteria as defined above.

• For now, the only install attributes managed are dockerfile instructions starting by RUN

• Limit your technical debt and secure your code base using MegaLinter{target=_blank}, by Nicolas Vuillamy{target=_blank}
• MegaLinter sells his soul and joins OX Security{target=_blank}, by Nicolas Vuillamy{target=_blank}
• Linting a Jekyll blog with MegaLinter{target=_blank}, by Alec Johnson{target=_blank}
• Node.js Coding Standard Tools with MegaLinter on Gitlab CI{target=_blank}, by Albion Bame{target=_blank}
• Open-source linters landscape in 2021{target=_blank}, by Cédric Teyton{target=_blank}
• How to linter basic things like trailing whitespaces and newlines{target=_blank}, by Nicolai Antiferov{target=_blank}
• How to apply security at the source using GitOps{target=_blank}, by Edu Minguez{target=_blank}
• Linting - What is all the fluff about?, by Neil Shepard, University Of Sheffield
• Talk about the Kotlin plugins Kover, Ktlint and Detekt. Made for the AmsterdamJUG meetup., by Simone de Gijt
• GitOps security topics you must address, by Wiebe de Roos
• GitHub Actions: sharing your secrets with third-party actions, by Constantin Bosse and Stephen Hosom

My repo CI already have linters and they are perfectly working, so why do I need MegaLinter ?

You can perfectly continue using your installed linters and deactivate them in .mega-linter.yml. For example, in a javascript project using eslint, you can configure MegaLinter with DISABLE: JAVASCRIPT. That way, you will benefit from both your installed linters but also from other MegaLinter linters checking JSON, YAML, Markdown, Dockerfile, Bash, spelling mistakes, dead URLs...

Ok but... how does it work ?

MegaLinter is based on Docker images containing either all linters, or just a selection of linters if you are using a MegaLinter flavor for a project using a specific language / format

The core architecture does the following:

• Initialization
  • List all project files:
    • except files in ignored folders (node_modules, etc...)
    • except files not matching FILTER_REGEX_INCLUDE (if defined by user)
    • except files matching FILTER_REGEX_EXCLUDE (if defined by user)
  • Collect files for each activated linter, matching their own filtering criteria:
    • file extensions
    • file names
    • file content
    • <descriptor_or_linter_key>_FILTER_REGEX_INCLUDE (if defined by user)
    • <descriptor_or_linter_key>_FILTER_REGEX_EXCLUDE (if defined by user)
• Linting
  • Parallelly, for each linter with matching files:
    • Call the linter on matching files (or the whole project for some linters like copy-paste detector)
    • Call activated linter-level reporters (GitHub Status Reporter...)
• Finalization
  • Call activated global level reporters (GitHub Pull Request Comment Reporter, File.io Reporter, Email Reporter...)
  • Manage return code:
    • 0 if no error (or only non blocking errors if user defined DISABLE_ERRORS or <descriptor_or_linter_key>_DISABLE_ERRORS)
    • 1 if errors

Contributions to MegaLinter are very welcome, the more we are, the stronger MegaLinter is ! Please follow Contributing Guide

To help, you can also:

• ⭐ star the repository
• 🍺 offer a beer !
• report problems and request new features
• share on twitter{target=_blank}

• analysis-tools.dev{target=_blank}
• awesome-linters{target=_blank}
• schemastore.org{target=_blank}
• r2devops.io{target=_blank}
• abhith.net{target=_blank}

• checkstyle{target=_blank}
• clj-kondo{target=_blank}
• cspell{target=_blank}
• dotenv-linter{target=_blank}
• editorconfig-checker{target=_blank}
• eslint{target=_blank}
• eslint-plugin-jsonc{target=_blank}
• hadolint{target=_blank}
• htmlhint{target=_blank}
• jscpd{target=_blank}
• kics{target=_blank}
• ktlint{target=_blank}
• lintr{target=_blank}
• markdown-link-check{target=_blank}
• npm-groovy-lint{target=_blank}
• pmd{target=_blank}
• rst-lint{target=_blank}
• rstcheck{target=_blank}
• rubocop{target=_blank}
• scalafix{target=_blank}
• secretlint{target=_blank}
• stylelint{target=_blank}

MegaLinter obviously would not exist without its linters and libraries, so many thanks to all the dedicated Open-Source teams maintaining all these awesome linters !

MegaLinter has been built on the ashes of a rejected Pull Request{target=_blank} on GitHub Super-Linter{target=_blank}.

Even if I disagree with their decision to remain in bash, the core team has always been nice and supporting during the time I was a Super-Linter contributor{target=_blank} :)

• GNU Affero General Public License

The hard-fork of Super-Linter to be rewritten in Python is not just a language switch: use of python flexibility and libraries allowed to define lots of additional functions described below

• MegaLinter Flavors allow to use smaller docker images, so the pull time is reduced
• Thanks to python multiprocessing capabilities, linters are run in parallel, which is way faster than Super-Linter bash script who runs all linters in sequence
• When the linter allows it, call it 1 time with N files, instead of calling N times with one file

• C, C++, Copy-Paste detection, Credentials, GraphQL, JSON & YAML with JSON schemas, Markdown tables formatting, Puppet, reStructuredText, Rust, Scala, Spell checker, Swift, Visual Basic .NET ...

MegaLinter can automatically apply fixes performed by linters, and push them to the same branch, or create a Pull Request that you can validate

This is pretty handy, especially for linter errors related to formatting (in that case, you don't have any manual update to perform)

MegaLinter can be run locally thanks to mega-linter-runner

• Accuracy: Count the total number of errors and not only the number of files in error
• Show linter version and applied filters for each linter processed
• Reports stored as artefacts on GitHub Action run or other remote files
  • General log
  • One report file by linter

• Console

• Text files
• GitHub Pull Request comments

• Gitlab Merge Request comments

• Azure Pull Request comments

• Updated sources
• Email
• File.io

• Assisted installation and configuration using a yeoman generator and JSON schemas for configuration file

• Configure include and exclude regexes for a single language or linter: ex: JAVASCRIPT_FILTER_REGEX_INCLUDE (src)
• Configure additional CLI arguments for a linter: ex: JAVASCRIPT_ES_ARGUMENTS "--debug --env-info"
• Configure non blocking errors for a single language or linter: ex: JAVASCRIPT_DISABLE_ERRORS
• Simplify languages and linters variables
  • ENABLE = list of languages and formats to apply lint on codebase (default: all)
  • ENABLE_LINTERS = list of linters to apply lint on codebase (default: all)
  • DISABLE = list of languages and formats to skip (default: none)
  • DISABLE_LINTERS = list of linters to skip (default: none)
  • Variables VALIDATE_XXX are still taken in account (but should not be used in association with ENABLE and DISABLE variables)

• HTML documentation

• One page per linter documentation :
  • All variables that can be used with this linter
  • List of file extensions, names and filters applied by the linter
  • Link to MegaLinter default linter configuration
  • Link to linter Web-Site
  • Link to official page explaining how to customize the linter rules
  • Link to official page explaining how to disable rules from source comments
  • Examples of linter command line calls behind the hood
  • Help command text
  • Installation commands

• Installation links for related IDEs

• README
  • Separate languages, formats and tooling formats in the linters table
  • Add logos for each descriptor

For linters less commonly used, MegaLinters offers a plugins architecture so anyone can publish plugins

• Refactoring runtime in Python, for easier handling than bash thanks to classes and python modules
• Everything related to each linter in a single descriptor YML file
  • easier evolutive maintenance
  • less conflicts to manage between PRs.
  • Few special cases require a python linter class)
• Default behaviours for all linters, with possibility to override part of them for special cases
• Hierarchical architecture: Apply fixes and new behaviours to all linters with a single code update
• Documentation as code
  • Generate linters tables (ordered by type: language, format & tooling format) and include it in README. (see result)
  • Generate one markdown file per Linter, containing all configuration variables, infos and examples (See examples)
• Automatic generation of Dockerfile using YML descriptors, always using the linter latest version
  • Dockerfile commands (FROM, ARG, ENV, COPY, RUN )
  • APK packages (linux)
  • NPM packages (node)
  • PIP packages (python)
  • GEM packages (ruby)
  • Phive packages (PHP)
• Have a centralized exclude list (node_modules,.rbenv, etc...)

• Test classes for each capability
• Test classes for each linter: Automatic generation of test classes using .automation/build.py
• Setup code coverage
• Development CD / CI
  • Validate multi-status on PR inside each PR (posted from step "Run against all code base")
  • Run test classes and code coverage with pytest during validation GitHub Action
  • Validate descriptor YML files with json schema during build
  • Automated job to upgrade linters to their latest stable version

• Tool to upgrade user repos configuration files using npx mega-linter-runner --upgrade (will upgrade references to nvuillam/mega-linter into oxsecurity/megalinter)

• Migration from github individual repo nvuillam/mega-linter to github organization repo oxsecurity/megalinter

• Migration from docker hub space nvuillam to space megalinter

  • Docker images are now oxsecurity/megalinter or oxsecurity/megalinter-FLAVOR

• Documentation is now hosted at https://megalinter.github.io/

• Version management: Now mega-linter docker images, github action and mega-linter-runner versions are aligned

  • latest for latest official release
  • beta for current content of main branch
  • alpha for current content of alpha branch
  • docker image, github action and mega-linter-runner can still be called with exact version number

• Being more inclusive: rename master branch into main

• IGNORE_GITIGNORED_FILES parameter default to true