megalinter
v8.3.0
MegaLinter est un outil Open Source pour les flux de travail CI/CD qui analyse la cohérence de votre code , IAC , configuration et scripts dans les sources de votre référentiel, pour garantir que toutes les sources de vos projets sont propres et formatées quel que soit l'IDE/boîte à outils utilisé par leurs développeurs. , propulsé par OX Security .
Supportant 62 langues, 23 formats, 20 formats d'outils et prêt à l'emploi , en tant qu'action GitHub ou n'importe quel système CI, hautement configurable et gratuit pour toutes les utilisations .
MegaLinter possède des intégrations natives avec la plupart des principaux outils CI/CD du marché.
Mise à niveau vers MegaLinter v8 :)
Avant d'aller ci-dessous, consultez le site Web de documentation en ligne qui offre une navigation utilisateur beaucoup plus simple que ce README.
Les projets doivent contenir du code propre, afin d' éviter la dette technique , qui rend la maintenance évolutive plus difficile et longue .
En utilisant des formateurs de code et des linters de code , vous vous assurez que votre base de code est plus lisible et respecte les bonnes pratiques , du kick-off à chaque étape du cycle de vie du projet.
Tous les développeurs n'ont pas la bonne habitude d'utiliser des linters dans leurs IDE, ce qui rend les révisions de code plus difficiles et plus longues à traiter.
En utilisant MegaLinter , vous bénéficierez des avantages suivants pour vous et votre équipe :
npx mega-linter-runner --install pour générer les fichiers de configuration (vous devez installer node.js)
Remarques :
super-linter/super-linter@v3 par oxsecurity/megalinter@v8 dans votre fichier GitHub Action YML, comme sur ce PR)Tous les linters sont intégrés dans l'image docker MegaLinter, qui est fréquemment mise à niveau avec leurs dernières versions
| Langue | Linter | Supplémentaire | |
|---|---|---|---|
 | FRAPPER | bash-exécutable BASH_EXEC | |
| FRAPPER | contrôle de coquille BASH_SHELLCHECK | |
| FRAPPER | shfmt BASH_SHFMT | |
 | C | cpplin C_CPPLINT | |
| C | format clang C_CLANG_FORMAT | |
 | CLOJURE | clj-kondo CLOJURE_CLJ_KONDO | |
| CLOJURE | cljstyle CLOJURE_CLJSTYLE | |
 | CAFÉ | peluche de café COFFEE_COFFEELINT | |
 | C++ (CPP) | cpplin CPP_CPPLINT | |
| C++ (CPP) | format clang CPP_CLANG_FORMAT | |
 | C# (CSHARP) | format dotnet CSHARP_DOTNET_FORMAT | |
| C# (CSHARP) | plus net CSHARP_CSHARPIER | |
| C# (CSHARP) | Roslynateur CSHARP_ROSLYNATOR | |
 | DARD | analyseur de fléchettes DART_DARTANALYZER | |
 | ALLER | golangci-lint GO_GOLANGCI_LINT | |
| ALLER | relancer GO_REVIVE | |
 | groovy | npm-groovy-lint GROOVY_NPM_GROOVY_LINT | |
 | JAVA | style de contrôle JAVA_CHECKSTYLE | |
| JAVA | pmd JAVA_PMD | |
 | JAVASCRIPT | eslint JAVASCRIPT_ES | |
| JAVASCRIPT | standard JAVASCRIPT_STANDARD | |
| JAVASCRIPT | plus jolie JAVASCRIPT_PRÉTIER | |
 | JSX | eslint JSX_ESLINT | |
 | KOTLIN | klint KOTLIN_KTLINT | |
| KOTLIN | détecter KOTLIN_DETEKT | |
 | LUA | lucheck LUA_LUACHECK | |
| LUA | Séléné LUA_SELENE | |
| LUA | stylet LUA_STYLUA | |
 | FAIREFILE | faire un chèque MAKEFILE_CHECKMAKE | |
 | PERLE | perlcritique PERL_PERLCRITIC | |
 | PHP | phpcs PHP_PHPCS | |
| PHP | phpstan PHP_PHPSTAN | |
| PHP | psaume PHP_PSALM | |
| PHP | PHPlint PHP_PHPLINT | |
| PHP | php-cs-fixateur PHP_PHPCSFIXER | |
 | PUISSANCE | PowerShell POWERSHELL_POWERSHELL | |
| PUISSANCE | powershell_formatter POWERSHELL_POWERSHELL_FORMATTER | |
 | PYTHON | pylint PYTHON_PYLINT | |
| PYTHON | noir PYTHON_NOIR | |
| PYTHON | flocon8 PYTHON_FLAKE8 | |
| PYTHON | trier PYTHON_ISORT | |
| PYTHON | bandit PYTHON_BANDIT | |
| PYTHON | monpy PYTHON_MYPY | |
| PYTHON | droit d'auteur PYTHON_PYRIGHT | |
| PYTHON | fraise PYTHON_RUFF | |
 | R. | lintr R_LINTR | |
 | RAKU | raku RAKU_RAKU | |
 | RUBIS | rubocop RUBY_RUBOCOP | |
 | ROUILLER | clippé RUST_CLIPPY | |
 | FORCE DE VENTE | sfdx-scanner-apex SALESFORCE_SFDX_SCANNER_APEX | |
| FORCE DE VENTE | sfdx-scanner-aura SALESFORCE_SFDX_SCANNER_AURA | |
| FORCE DE VENTE | sfdx-scanner-lwc SALESFORCE_SFDX_SCANNER_LWC | |
| FORCE DE VENTE | scanner de flux de foudre SALESFORCE_LIGHTNING_FLOW_SCANNER | |
 | SCALA | scalafix SCALA_SCALAFIX | |
 | SQL | sqlfluff SQL_SQLFLUFF | |
| SQL | tsqllint SQL_TSQLLINT | |
 | RAPIDE | Swiftlint SWIFT_SWIFTLINT | |
 | Bourse de Toronto | eslint TSX_ESLINT | |
 | MANUSCRIT | eslint TYPESCRIPT_ES | |
| MANUSCRIT | norme ts TYPESCRIPT_STANDARD | |
| MANUSCRIT | plus jolie TYPESCRIPT_PRETTIER | |
 | Visual Basic .NET (VBDOTNET) | format dotnet VBDOTNET_DOTNET_FORMAT |
| Format | Linter | Supplémentaire | |
|---|---|---|---|
 | CSS | stylelint CSS_STYLELINT | |
 | ENV | dotenv-linter ENV_DOTENV_LINTER | |
 | GRAPHQL | graphql-schéma-linter GRAPHQL_GRAPHQL_SCHEMA_LINTER | |
 | HTML | Djlint HTML_DJLINT | |
| HTML | indice html HTML_HTMLHINT | |
 | JSON | jsonlint JSON_JSONLINT | |
| JSON | eslint-plugin-jsonc JSON_ESLINT_PLUGIN_JSONC | |
| JSON | v8r JSON_V8R | |
| JSON | plus jolie JSON_PRÉTIER | |
| JSON | npm-package-json-lint JSON_NPM_PACKAGE_JSON_LINT | |
 | LATEX | chktex LATEX_CHKTEX | |
 | RÉDUCTION | démarque MARKDOWN_MARKDOWNLINT | |
| RÉDUCTION | remarque-peluche MARKDOWN_REMARK_LINT | |
| RÉDUCTION | vérification du lien de démarque MARKDOWN_MARKDOWN_LINK_CHECK | |
| RÉDUCTION | formateur de table de démarques MARKDOWN_MARKDOWN_TABLE_FORMATTER | |
 | PROTOBUF | protolinte PROTOBUF_PROTOLINT | |
 | TVD | première charpie RST_RST_LINT | |
| TVD | première vérification RST_RSTCHECK | |
| TVD | rstfmt RST_RSTFMT | |
 | XML | xmllint XML_XMLLINT | |
 | YAML | plus jolie YAML_PRETTIER | |
| YAML | yamlint YAML_YAMLLINT | |
| YAML | v8r YAML_V8R |
| Format d'outillage | Linter | Supplémentaire | |
|---|---|---|---|
| ACTION | actionlint ACTION_ACTIONLINT | |
 | ANSIBLE | ansible-peluche ANSIBLE_ANSIBLE_LINT | |
| API | spectral API_SPECTRAL | |
 | BRAS | bras-ttk ARM_ARM_TTK | |
| BICEPS | biceps_linter BICEP_BICEP_LINTER | |
 | FORMATION EN NUAGE | cfn-lint CLOUDFORMATION_CFN_LINT | |
 | FICHIER DOCKER | hadolint DOCKERFILE_HADOLINT | |
 | EDITORCONFIG | éditeurconfig-checker EDITORCONFIG_EDITORCONFIG_CHECKER | |
 | CORNICHON | cornichon GHERKIN_GHERKIN_LINT | |
 | Kubernetes | kubeconform KUBERNETES_KUBECONFORM | |
| Kubernetes | barre KUBERNETES_HELM | |
| Kubernetes | Kubescape KUBERNETES_KUBESCAPE | |
 | FANTOCHE | peluche de marionnette PUPPET_PUPPET_LINT | |
 | SERPENT | faire un serpent SNAKEMAKE_LINT | |
| SERPENT | serpentfmt SNAKEMAKE_SNAKEFMT | |
 | TEKTON | tekton-lint TEKTON_TEKTON_LINT | |
 | TERRAFORME | silex TERRAFORM_TFLINT | |
| TERRAFORME | terrascan TERRAFORM_TERRASCAN | |
| TERRAFORME | terragrunt TERRAFORM_TERRAGRUNT | |
| TERRAFORME | terraform-fmt TERRAFORM_TERRAFORM_FMT |
| Vérificateur de la qualité du code | Linter | Supplémentaire | |
|---|---|---|---|
 | COPYPASER | jscpd COPYPASTE_JSCPD | |
| DÉPÔT | chèque REPOSITORY_CHECKOV | |
| DÉPÔT | Devskim REPOSITORY_DEVSKIM | |
| DÉPÔT | dépoussiéreur REPOSITORY_DUSTILOCK | |
| DÉPÔT | git_diff REPOSITORY_GIT_DIFF | |
| DÉPÔT | gitleaks REPOSITORY_GITLEAKS | |
| DÉPÔT | grogner REPOSITORY_GRYPE | |
| DÉPÔT | coups de pied REPOSITORY_KICS | |
| DÉPÔT | ls-lint REPOSITORY_LS_LINT | |
| DÉPÔT | secretlint REPOSITORY_SECRETLINT | |
| DÉPÔT | segrep REPOSITORY_SEMGREP | |
| DÉPÔT | Syft REPOSITORY_SYFT | |
| DÉPÔT | trivial REPOSITORY_TRIVY | |
| DÉPÔT | trivy-sbom REPOSITORY_TRIVY_SBOM | |
| DÉPÔT | truffière REPOSITORY_TRUFFLEHOG | |
 | ÉPELER | cspell SPELL_CSPELL | |
| ÉPELER | prosélin SPELL_PROSELINT | |
| ÉPELER | vallée SPELL_VALE | |
| ÉPELER | litchi SPELL_LYCHEE |
Exécutez simplement npx mega-linter-runner --install à la racine de votre référentiel et répondez aux questions, il générera des fichiers de configuration prêts à l'emploi pour MegaLinter :)
Les exemples d'instructions suivants utilisent la dernière version stable de MegaLinter ( v8 , correspondant toujours à la dernière version)
oxsecurity/megalinter:v8oxsecurity/megalinter@v8Vous pouvez également utiliser la version bêta (correspondant au contenu de la branche principale)
oxsecurity/megalinter:betaoxsecurity/megalinter@beta.github/workflows/mega-linter.ymlREMARQUES :
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} dans votre flux de travail, alors le MegaLinter marquera l'état de chaque exécution de linter individuel dans la section Vérifications d'une demande d'extraction. Sans cela, vous ne verrez que l'état global de l'exécution complète. Il n'est pas nécessaire de définir le secret GitHub car il est automatiquement défini par GitHub, il doit simplement être transmis à l'action.GITHUB_TARGET_URL existe. Dans votre référentiel, vous devriez avoir un dossier .github/workflows avec une action GitHub similaire à celle ci-dessous :
.github/workflows/mega-linter.yml---
# MegaLinter GitHub Action configuration file
# More info at https://megalinter.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 don't 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 :
megalinter :
name : MegaLinter
runs-on : ubuntu-latest
permissions :
# Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR
# Remove the ones you do not need
contents : write
issues : write
pull-requests : write
steps :
# Git Checkout
- name : Checkout Code
uses : actions/checkout@v4
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.io/flavors/
uses : oxsecurity/megalinter@v8
env :
# All available variables are described in documentation
# https://megalinter.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@v4
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@v6
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 "
commit_user_name : megalinter-bot
commit_user_email : [email protected] Créez ou mettez à jour le fichier .gitlab-ci.yml à la racine de votre référentiel
# MegaLinter GitLab CI job configuration file
# More info at https://megalinter.io/
mega-linter :
stage : test
# You can override MegaLinter flavor used to have faster performances
# More info at https://megalinter.io/flavors/
image : oxsecurity/megalinter:v8
script : [ "true" ] # if script: ["true"] doesn't work, you may try -> script: [ "/bin/bash /entrypoint.sh" ]
variables :
# All available variables are described in documentation
# https://megalinter.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 weekCréez un jeton d'accès Gitlab et définissez-le dans une variable GITLAB_ACCESS_TOKEN_MEGALINTER dans les variables masquées CI/CD du projet. Assurez-vous que votre jeton (par exemple s'il s'agit d'un jeton de projet) est le rôle approprié pour commenter une demande de fusion (au moins développeur).
Nos amis de R2Devops ont intégré un workflow Gitlab-CI MegaLinter sur leur marché de modèles open source, et il peut publier les résultats MegaLinter dans les rapports de qualité du code Gitlab !
Utilisez le modèle YAML Azure Pipelines suivant
Vous pouvez configurer une stratégie de branche de validation de build sur un seul référentiel ou sur tous les référentiels. Si vous effectuez une configuration sur tous les référentiels, votre pipeline est stocké dans un référentiel central.
Ajoutez ce qui suit à un fichier azure-pipelines.yaml dans votre référentiel de code :
# Run MegaLinter to detect linting and security issues
- job : MegaLinter
pool :
vmImage : ubuntu-latest
steps :
# Checkout repo
- checkout : self
# Pull MegaLinter docker image
- script : docker pull oxsecurity/megalinter:v8
displayName : Pull MegaLinter
# Run MegaLinter
- script : |
docker run -v $(System.DefaultWorkingDirectory):/tmp/lint
--env-file <(env | grep -e SYSTEM_ -e BUILD_ -e TF_ -e AGENT_)
-e SYSTEM_ACCESSTOKEN=$(System.AccessToken)
-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 Ajoutez ce qui suit à un fichier azure-pipelines.yaml dans un référentiel distinct, par exemple le référentiel « MegaLinter » :
# Run MegaLinter to detect linting and security issues
trigger : none
pool :
vmImage : ubuntu-latest
variables :
repoName : $[ replace(split(variables['System.PullRequest.SourceRepositoryURI'], '/')[6], '%20', ' ') ]
steps :
# Checkout triggering repo
- checkout : git://$(System.TeamProject)/$(repoName)@$(System.PullRequest.SourceBranch)
displayName : Checkout Triggering Repository
# Pull MegaLinter docker image
- script : docker pull oxsecurity/megalinter:v8
displayName : Pull MegaLinter
# Run MegaLinter
- script : |
docker run -v $(System.DefaultWorkingDirectory):/tmp/lint
--env-file <(env | grep -e SYSTEM_ -e BUILD_ -e TF_ -e AGENT_)
-e SYSTEM_ACCESSTOKEN=$(System.AccessToken)
-e GIT_AUTHORIZATION_BEARER=$(System.AccessToken)
oxsecurity/megalinter:v8
displayName: Run MegaLinter
# Upload MegaLinter reports
- task : PublishPipelineArtifact@1
condition : succeededOrFailed()
displayName : MegaLinter Report
inputs :
targetPath : $(System.DefaultWorkingDirectory)/megalinter-reports/
artifactName : MegaLinterReport Pour bénéficier des commentaires Pull Request, veuillez suivre les instructions de configuration
Vous pouvez également suivre ce tutoriel détaillé de DonKoning
Créez un fichier bitbucket-pipelines.yml sur le répertoire racine de votre référentiel
Copiez et collez le modèle suivant ou ajoutez l'étape à votre pipeline existant.
image : atlassian/default-image:3
pipelines :
default :
- parallel :
- step :
name :
Développer
