<!-- markdownlint-disable MD013 MD033 MD041 --> <!-- header-intro-start --> <!-- header-intro-end --> <!-- header-logo-start --> <div align="center"> <a href="https://megalinter.io" target="blank" title="Visit MegaLinter Web Site"> <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/megalinter-banner.png" alt="MegaLinter" min-height="200px"> </a> </div> <!-- header-logo-end --> <!-- mega-linter-title-start -->

MegaLinter, by

<!-- mega-linter-title-end --> <!-- mega-linter-badges-start -->

<!-- gh-dependents-info-used-by-start -->

<!-- gh-dependents-info-used-by-end -->

<!-- mega-linter-badges-end --> <!-- welcome-phrase-start -->

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 60 languages, 23 formats, 20 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.

MegaLinter has native integrations with many of the major CI/CD tools of the market.

<!-- welcome-phrase-end -->

Upgrade to MegaLinter v8 :)

<!-- online-doc-start -->

Before going below, see Online Documentation Web Site which has a much easier user navigation than this README

<!-- online-doc-end --> <!-- table-of-contents-start -->

Table of Contents

• Why MegaLinter
• Quick Start
• Supported Linters
  • Languages
  • Formats
  • Tooling formats
  • Other
• Installation
  • Assisted installation
  • Which version to use ?
  • GitHub Action
  • GitLab CI
    • Manual Setup
    • Using R2Devops
  • Azure Pipelines
  • Bitbucket Pipelines
  • Jenkins
  • Concourse
    • Pipeline step
    • Use it as reusable task
  • Drone CI
    • (Optional) Adjusting trigger rules
  • Docker container
  • Run MegaLinter locally
• Configuration
  • .mega-linter.yml file
  • Common variables
  • Activation and deactivation
  • Filter linted files
  • Apply fixes
    • Apply fixes issues
    • Notes
  • Linter specific variables
  • Pre-commands
  • Post-commands
  • Environment variables security
    • Secured env variables
    • Secured configuration examples
    • Default secured variables
    • Unhide variables for linters
  • CLI lint mode
• Reporters
• Flavors
• Badge
  • Markdown
  • reStructuredText
• Plugins
  • External Plugins Catalog
  • Use external plugins
    • Example
  • Create your own plugin
    • Limitations
• They talk about MegaLinter
  • English articles
  • French articles
  • Videos
  • Web Sites
  • Linters
• Frequently Asked Questions
• How to contribute
• Special thanks
  • Maintainers
  • Contributors
  • Open-source teams
  • Super-Linter team
• License
• MegaLinter vs Super-Linter
  • Security
  • 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

<!-- table-of-contents-end -->

Why MegaLinter

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're 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

<!-- quick-start-section-start --> <!-- markdown-headers --- title: Quick Start with MegaLinter description: Setup MegaLinter in 5 minutes thanks to its assisted installation tool --- -->

Quick Start

• 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 super-linter/super-linter@v3 by oxsecurity/megalinter@v8 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

<!-- quick-start-section-end --> <!-- supported-linters-section-start --> <!-- markdown-headers --- title: List of the 100+ supported linters embedded in MegaLinter description: Full list of all linters for all languages and formats that are available in MegaLinter --- -->

Supported Linters

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

<!-- languages-section-start--> <!-- linters-table-start -->

Languages

<!-- -->	Language	Linter	Additional
<img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/bash.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon -->	BASH	bash-exec<br/>BASH_EXEC
<img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/bash.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon -->	BASH	shellcheck<br/>BASH_SHELLCHECK
<img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/bash.ico" alt="" height="32px" class="megalinter-icon"></a> <!-- linter-icon -->	BASH