Optimize your code with Megalinter

We see more and more that code quality is a must in software development. In any size of company, maintaining clean and standards-compliant code is crucial. This is where MegaLinter comes, as a powerful and customizable tool that will transform your code and make it simply better. The advantage is that it's fully integrable in you pipelines.

What is MegaLinter?

MegaLinter is an open-source tool designed to automate static analysis and linting for your code and supports a lot of programming languages, file formats and configuration tools. If you're working with JavaScript, Python, Go, or even YAML, Megalinter will find a way to cover it properly and ensure that your code is complliant to best practices.

Why to choose MegaLinter?

Like mentionned before, MegaLinter stands out by supporting various languages and formats. This means you can manage a complex project with multiple tech stacks without having to integrate several specific linting tools.

Integrating MegaLinter into your CI/CD pipeline is easy. Whether you're using GitHub Actions, Jenkins, Gitlab, or Azure DevOps, MegaLinter fits into your workflow to analyze your code .

The best tool to be sure that your installation is ok is their assisted installation tool! It automaticlly generates configuration files!

more details here : https://megalinter.io/latest/install-assisted/

When it's installed (beware that you might have to install nodeJS on your machine before), you can simply run

npx mega-linter-runner --install and it will ask you questions and generate a .mega-linter.yml file with the configurations you need.

Now we can integrate it on our pipeline

Exemple with an Azure Devops yaml file:

  # Run MegaLinter to detect linting and security issues
  - job: MegaLinter
    pool:
      vmImage: ubuntu-latest #we'll use an Ubuntu VM
    steps:
      # First we need to checkout the repo
      - checkout: self

      # Pull MegaLinter docker image
      - script: docker pull oxsecurity/megalinter:v8
        displayName: Pull MegaLinter

      # Run the image and use the Git Token.

      - script: |
          docker run -v $(System.DefaultWorkingDirectory):/tmp/lint \
            --env-file <(env | grep -e SYSTEM_ -e BUILD_ -e TF_ -e AGENT_) \
            -e GIT_AUTHORIZATION_BEARER=$(System.AccessToken) \
            oxsecurity/megalinter:v8
        displayName: Run MegaLinter

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

Output example (in this case using terraform linters):

In addition, the MegaLinter documentation points to a really good and very well detailled example to have it perfectly integrated in azure devops. When you have a pull request, this shows you how to automatically trigger a code analysis with MegaLinter.

https://github.com/DonKoning/megaLinter

If you would like to have great example of github actions or even local use of Megalinter, please go to their official documentation:

https://megalinter.io/latest/install-github/

Customization

The second aspect is that Megalinter is highly customizable. You can enable or disable linters, exclude files simply by using a ".mega-linter.yml" file or via environment variables (FILTER_REGEX_INCLUDE:()and the opposite, FILTER_REGEX_EXCLUDE: ()). You can decide if you let the tool apply fixes or not (direct commit, new PR, etc).

more details on their Github repo:

https://github.com/oxsecurity/megalinter/blob/main/.mega-linter.yml

Detailed Reports

Once configured, MegaLinter generates detailed and clear reports. These reports allow you to identify issues in your code and fix them easily. It's an excellent way to keep your codebase clean and compliant.

THE cool feature regarding these reports is that you can generate them in almost all formats ! The full list is here : https://megalinter.io/latest/reporters/

Conclusion

Adopting MegaLinter within your CI/CD pipeline is a strategic move and can transform your code quality to make it more secure, more readable and more best-practices compliant.