megalinter
v8.3.0
MegaLinter — это инструмент с открытым исходным кодом для рабочих процессов CI/CD , который анализирует согласованность вашего кода , IAC , конфигурации и скриптов в источниках вашего репозитория, чтобы гарантировать, что все исходные коды ваших проектов чистые и отформатированы, независимо от того, какая IDE/панель инструментов используется их разработчиками. , на базе OX Security .
Поддерживает 62 языка, 23 формата, 20 форматов инструментов и готов к использованию «из коробки» в качестве действия GitHub или любой системы CI, легко настраивается и бесплатен для любого использования .
MegaLinter имеет встроенную интеграцию со многими основными инструментами CI/CD на рынке.
Обновитесь до МегаЛинтер v8 :)
Прежде чем перейти к нижеизложенному, посетите веб-сайт онлайн-документации, навигация которого для пользователя гораздо проще, чем этот README.
Проекты должны содержать чистый код, чтобы избежать технического долга , который усложняет эволюционное обслуживание и отнимает много времени .
Используя средства форматирования кода и линтеры кода , вы гарантируете, что ваша кодовая база будет легче читаться и будет соответствовать лучшим практикам , от начала до каждого этапа жизненного цикла проекта.
Не у всех разработчиков есть хорошая привычка использовать линтеры в своих IDE, что усложняет и удлиняет обработку код-ревью.
Используя МегаЛинтер , вы получите следующие преимущества для себя и своей команды:
npx mega-linter-runner --install для создания файлов конфигурации (необходимо установить node.js)
Примечания :
super-linter/super-linter@v3 на oxsecurity/megalinter@v8 в вашем YML-файле действия GitHub, как в этом PR-файле).Все линтеры интегрированы в образ докера MegaLinter, который часто обновляется до последних версий.
| Язык | Линтер | Дополнительный | |
|---|---|---|---|
 | БАШ | bash-exec BASH_EXEC | |
| БАШ | шеллчек BASH_SHELLCHECK | |
| БАШ | шфмт БАШ_ШФМТ | |
 | С | cpplint C_CPPLINT | |
| С | clang-формат C_CLANG_FORMAT | |
 | КЛОЖЮР | clj-кондо CLOJURE_CLJ_KONDO | |
| КЛОЖЮР | cljstyle CLOJURE_CLJSTYLE | |
 | КОФЕ | кофелинта COFFEE_COFFEELINT | |
 | С++ (CPP) | cpplint CPP_CPPLINT | |
| С++ (CPP) | clang-формат CPP_CLANG_FORMAT | |
 | С# (CSHARP) | dotnet-формат CSHARP_DOTNET_FORMAT | |
| С# (CSHARP) | cострее CSHARP_CSHARPIER | |
| С# (CSHARP) | Рослинатор CSHARP_ROSLYNATOR | |
 | ДАРТ | дартанализатор ДАРТ_ДАРТАНАЛИЗЕР | |
 | ИДТИ | голангчи-линт GO_GOLANGCI_LINT | |
| ИДТИ | оживить GO_REVIVE | |
 | ЗАХВАТНЫЙ | npm-groovy-lint GROOVY_NPM_GROOVY_LINT | |
 | ЯВА | контрольный стиль JAVA_CHECKSTYLE | |
| ЯВА | пмд JAVA_PMD | |
 | ЯВАСКРИПТ | эслинт JAVASCRIPT_ES | |
| ЯВАСКРИПТ | стандартный JAVASCRIPT_STANDARD | |
| ЯВАСКРИПТ | красивее JAVASCRIPT_PRETTIER | |
 | JSX | эслинт JSX_ESLINT | |
 | КОТЛИН | ктлинт КОТЛИН_КТЛИНТ | |
| КОТЛИН | обнаружить КОТЛИН_ДЕТЕКТ | |
 | ЛУА | Луачек LUA_LUACHECK | |
| ЛУА | Селена LUA_SELENE | |
| ЛУА | стилус LUA_STYLUA | |
 | МАКЕФАЙЛ | проверка MAKEFILE_CHECKMAKE | |
 | ПЕРЛ | Перлкритик PERL_PERLCRITIC | |
 | PHP | PHPS PHP_PHPCS | |
| PHP | phpstan PHP_PHPSTAN | |
| PHP | псалом PHP_PSALM | |
| PHP | phplint PHP_PHPLINT | |
| PHP | php-cs-фиксатор PHP_PHPCSFIXER | |
 | Пауэршелл | PowerShell POWERSHELL_POWERSHELL | |
| Пауэршелл | powershell_formatter POWERSHELL_POWERSHELL_FORMATTER | |
 | ПИТОН | пилинт ПИТОН_ПИЛИНТ | |
| ПИТОН | черный ПИТОН_ЧЕРНЫЙ | |
| ПИТОН | чешуйка8 PYTHON_FLAKE8 | |
| ПИТОН | сортировать ПИТОН_ISORT | |
| ПИТОН | бандит PYTHON_BANDIT | |
| ПИТОН | мойпи ПИТОН_MYPY | |
| ПИТОН | пирайт PYTHON_PYRIGHT | |
| ПИТОН | ерш ПИТОН_РУФФ | |
 | Р | линтр Р_ЛИНТР | |
 | РАКУ | раку РАКУ_РАКУ | |
 | РУБИН | рубокоп РУБИ_РУБОКОП | |
 | РЖАВЧИНА | резкий RUST_CLIPPY | |
 | ПРОДАЖА | sfdx-сканер-апекс SALESFORCE_SFDX_SCANNER_APEX | |
| ПРОДАЖА | sfdx-сканер-аура SALESFORCE_SFDX_SCANNER_AURA | |
| ПРОДАЖА | sfdx-сканер-lwc SALESFORCE_SFDX_SCANNER_LWC | |
| ПРОДАЖА | сканер молниевых потоков SALESFORCE_LIGHTNING_FLOW_SCANNER | |
 | СКАЛА | скалафикс SCALA_SCALAFIX | |
 | SQL | sqlfluff SQL_SQLFLUFF | |
| SQL | tsqllint SQL_TSQLLINT | |
 | БЫСТРЫЙ | Свифтлинт СВИФТ_СВИФТЛИНТ | |
 | ТСХ | эслинт TSX_ESLINT | |
 | МАШИНОПИСЬ | эслинт TYPESCRIPT_ES | |
| МАШИНОПИСЬ | TS-стандарт ТИПЕСКРИПТ_СТАНДАРТ | |
| МАШИНОПИСЬ | красивее TYPESCRIPT_PRETTIER | |
 | Visual Basic .NET (VBDOTNET) | dotnet-формат VBDOTNET_DOTNET_FORMAT |
| Формат | Линтер | Дополнительный | |
|---|---|---|---|
 | CSS | стильлинт CSS_STYLELINT | |
 | ЕНВ | дотенв-линтер ENV_DOTENV_LINTER | |
 | ГРАФКЛ | Graphql-схема-линтер GRAPHQL_GRAPHQL_SCHEMA_LINTER | |
 | HTML | джлинт HTML_DJLINT | |
| HTML | htmlподсказка HTML_HTMLHINT | |
 | JSON | jsonlint JSON_JSONLINT | |
| JSON | eslint-плагин-jsonc JSON_ESLINT_PLUGIN_JSONC | |
| JSON | v8r JSON_V8R | |
| JSON | красивее JSON_PRETTIER | |
| JSON | npm-пакет-json-lint JSON_NPM_PACKAGE_JSON_LINT | |
 | ЛАТЕКС | чктекс LATEX_CHKTEX | |
 | УЦЕНКА | Маркдаунлинт MARKDOWN_MARKDOWNLINT | |
| УЦЕНКА | замечание-ворс MARKDOWN_REMARK_LINT | |
| УЦЕНКА | уценка-ссылка-проверка MARKDOWN_MARKDOWN_LINK_CHECK | |
| УЦЕНКА | форматировщик таблицы уценки MARKDOWN_MARKDOWN_TABLE_FORMATTER | |
 | ПРОТОБУФ | протолинт ПРОТОБУФ_ПРОТОЛИНТ | |
 | РСТ | первый линт RST_RST_LINT | |
| РСТ | первая проверка РСТ_РСТЧЕК | |
| РСТ | рстфмт RST_RSTFMT | |
 | XML | xmllint XML_XMLLINT | |
 | ЯМЛ | красивее ЯМЛ_ПРЕТТЬЕР | |
| ЯМЛ | ямлинт ЯМЛ_ЯМЛЛИНТ | |
| ЯМЛ | v8r ЯМЛ_V8R |
| Формат инструмента | Линтер | Дополнительный | |
|---|---|---|---|
| ДЕЙСТВИЕ | действиелинт ACTION_ACTIONLINT | |
 | АНСИБЛЕ | ansible-lint ANSIBLE_ANSIBLE_LINT | |
| API | спектральный API_SPECTRAL | |
 | РУКА | рука-ттк ARM_ARM_TTK | |
| БИЦЕП | бицепс_линтер БИЦЕП_БИЦЕП_ЛИНТЕР | |
 | ОБРАЗОВАНИЕ ОБЛАКОВ | cfn-lint CLOUDFORMATION_CFN_LINT | |
 | ДОКЕРФАЙЛ | хадолинт DOCKERFILE_HADOLINT | |
 | РЕДАКТОРКОНФИГ | редакторconfig-checker EDITORCONFIG_EDITORCONFIG_CHECKER | |
 | Огурец | корнишон GHERKIN_GHERKIN_LINT | |
 | КУБЕРНЕТЕС | кубеконформ КУБЕРНЕТЕС_КУБЭКОНФОРМ | |
| КУБЕРНЕТЕС | шлем КУБЕРНЕТЕС_HELM | |
| КУБЕРНЕТЕС | кубскейп КУБЕРНЕТЕС_КУБЕСКАПЕ | |
 | КУКОЛЬНЫЙ | кукольный ворс PUPPET_PUPPET_LINT | |
 | ЗМЕЯ | змеетворение SNAKEMAKE_LINT | |
| ЗМЕЯ | змея SNAKEMAKE_SNAKEFMT | |
 | ТЕКТОН | тектон-линт TEKTON_TEKTON_LINT | |
 | ТЕРРАФОРМ | тфлинт ТЕРРАФОРМ_ТФЛИНТ | |
| ТЕРРАФОРМ | терраскан ТЕРРАФОРМ_ТЕРРАСКАН | |
| ТЕРРАФОРМ | террагрунт ТЕРРАФОРМ_ТЕРРАГРУНТ | |
| ТЕРРАФОРМ | терраформ-ФМТ ТЕРРАФОРМ_ТЕРРАФОРМ_ФМТ |
| Проверка качества кода | Линтер | Дополнительный | |
|---|---|---|---|
 | КОПИПАСТА | jscpd COPYPASTE_JSCPD | |
| РЕПОЗИТАРИЙ | проверка РЕПОЗИТОР_ЧЕКОВ | |
| РЕПОЗИТАРИЙ | девским РЕПОЗИТОР_DEVSKIM | |
| РЕПОЗИТАРИЙ | пыльник РЕПОЗИТОР_DUSTILOCK | |
| РЕПОЗИТАРИЙ | git_diff РЕПОЗИТОР_GIT_DIFF | |
| РЕПОЗИТАРИЙ | gitleaks РЕПОЗИТОР_GITLEAKS | |
| РЕПОЗИТАРИЙ | раздражение РЕПОЗИТОР_GRYPE | |
| РЕПОЗИТАРИЙ | пинает РЕПОЗИТОР_KICS | |
| РЕПОЗИТАРИЙ | ls-lint РЕПОЗИТОРИ_LS_LINT | |
| РЕПОЗИТАРИЙ | секретный пучок РЕПОЗИТОРИ_СЕКРЕТЛИНТ | |
| РЕПОЗИТАРИЙ | семгреп РЕПОЗИТОРИ_SEMGREP | |
| РЕПОЗИТАРИЙ | сифт РЕПОЗИТОР_SYFT | |
| ХРАНИЛИЩЕ | банальный РЕПОЗИТОР_TRIVY | |
| РЕПОЗИТАРИЙ | триви-сбом REPOSITORY_TRIVY_SBOM | |
| ХРАНИЛИЩЕ | трюфельный боров РЕПОЗИТОР_ТРЮФЛЕХОГ | |
 | ЗАКЛИНАНИЕ | cspell SPELL_CSPELL | |
| ЗАКЛИНАНИЕ | прозелинт SPELL_PROSELINT | |
| ЗАКЛИНАНИЕ | долина SPELL_VALE | |
| ЗАКЛИНАНИЕ | личи ЗАКЛИНАНИЕ_ЛИЧИ |
Просто запустите npx mega-linter-runner --install в корне вашего репозитория и ответьте на вопросы, он сгенерирует готовые файлы конфигурации для MegaLinter :)
В следующих примерах инструкций используется последняя стабильная версия MegaLinter ( v8 , всегда соответствует последней версии).
oxsecurity/megalinter:v8oxsecurity/megalinter@v8Вы также можете использовать бета- версию (соответствующую содержимому основной ветки)
oxsecurity/megalinter:betaoxsecurity/megalinter@beta.github/workflows/mega-linter.ymlПРИМЕЧАНИЯ:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} в свой рабочий процесс, то MegaLinter будет отмечать статус каждого отдельного запуска линтера в разделе «Проверки» запроса на включение. Без этого вы увидите только общий статус полного запуска. Нет необходимости устанавливать секрет GitHub , поскольку он автоматически устанавливается GitHub, его нужно только передать в действие.GITHUB_TARGET_URL . В вашем репозитории должна быть папка .github/workflows с действием GitHub , как показано ниже:
.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] Создайте или обновите файл .gitlab-ci.yml в корне вашего репозитория.
# 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 weekСоздайте токен доступа Gitlab и определите его в переменной GITLAB_ACCESS_TOKEN_MEGALINTER в маскированных переменных CI/CD проекта. Убедитесь, что ваш токен (например, токен проекта) соответствует роли для комментирования мерж-реквеста (по крайней мере, для разработчика).
Наши друзья из R2Devops разместили рабочий процесс Gitlab-CI MegaLinter на своей торговой площадке шаблонов с открытым исходным кодом, и он может публиковать результаты MegaLinter в отчетах о качестве кода Gitlab!
Используйте следующий шаблон YAML Azure Pipelines.
Вы можете настроить политику ветвей проверки сборки для одного репозитория или для всех репозиториев. Если вы настраиваете все репозитории, ваш конвейер хранится в центральном репозитории.
Добавьте следующее в файл azure-pipelines.yaml в репозитории кода:
# 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 Добавьте следующее в файл azure-pipelines.yaml в отдельном репозитории, например репозитории 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 Чтобы воспользоваться комментариями к запросу на включение, следуйте инструкциям по настройке.
Вы также можете следовать этому подробному руководству от DonKoning.
Создайте файл bitbucket-pipelines.yml в корневом каталоге вашего репозитория.
Скопируйте и вставьте следующий шаблон или добавьте шаг в существующий конвейер.
image : atlassian/default-image:3
pipelines :
default :
- parallel :
- step :
name :
Расширять
