MegaLinter هي أداة مفتوحة المصدر لسير عمل CI/CD التي تحلل اتساق التعليمات البرمجية وIAC والتكوين والبرامج النصية في مصادر المستودع لديك، لضمان أن جميع مصادر مشروعاتك نظيفة ومنسقة مهما كان IDE/صندوق الأدوات الذي يستخدمه مطوروها ، مدعوم من OX Security .
دعم 62 لغة، و23 تنسيقًا، و 20 تنسيقًا للأدوات، وجاهز للاستخدام بمجرد إخراجه من الصندوق ، كإجراء GitHub أو أي نظام CI، وقابل للتكوين بدرجة عالية ومجاني لجميع الاستخدامات .
تتمتع MegaLinter بتكاملات أصلية مع العديد من أدوات CI/CD الرئيسية في السوق.
الترقية إلى MegaLinter v8 :)
قبل الانتقال أدناه، راجع موقع ويب التوثيق عبر الإنترنت الذي يتمتع بتنقل أسهل بكثير للمستخدم من الملف التمهيدي هذا
يجب أن تحتوي المشاريع على تعليمات برمجية نظيفة لتجنب الديون الفنية التي تجعل الصيانة التطورية أكثر صعوبة وتستغرق وقتًا طويلاً .
باستخدام منسقات التعليمات البرمجية ووحدات معالجة التعليمات البرمجية ، فإنك تتأكد من أن قاعدة التعليمات البرمجية لديك أسهل في القراءة وتحترم أفضل الممارسات ، بدءًا من البداية وحتى كل خطوة من دورة حياة المشروع
ليس لدى جميع المطورين عادة جيدة لاستخدام اللينترات في بيئة التطوير المتكاملة الخاصة بهم، مما يجعل معالجة مراجعات التعليمات البرمجية أصعب وأطول
باستخدام MegaLinter ، سوف تستمتع بالمزايا التالية لك ولفريقك:
npx mega-linter-runner --install
لإنشاء ملفات التكوين (تحتاج إلى تثبيت Node.js)ملحوظات :
super-linter/super-linter@v3
بـ oxsecurity/megalinter@v8
في ملف GitHub Action YML، كما هو الحال في هذا العلاقات العامة)تم دمج جميع أجهزة الفحص في صورة MegaLinter docker، والتي يتم ترقيتها بشكل متكرر بأحدث إصداراتها
لغة | لينتر | إضافي | |
---|---|---|---|
سحق | bash-exec BASH_EXEC | ||
سحق | com.shellcheck BASH_SHELLCHECK | ||
سحق | com.shfmt BASH_SHFMT | ||
ج | com.cpplint C_CPPLINT | ||
ج | تنسيق رنة C_CLANG_FORMAT | ||
كلوجور | clj-kondo CLOJURE_CLJ_KONDO | ||
كلوجور | com.cljstyle CLOJURE_CLJSTYLE | ||
قهوة | com.coffeelint القهوة_القهوة | ||
C++ (CPP) | com.cpplint CPP_CPPLINT | ||
C++ (CPP) | تنسيق رنة CPP_CLANG_FORMAT | ||
سي# (سيشارب) | تنسيق الدوت نت CSHARP_DOTNET_FORMAT | ||
سي# (سيشارب) | com.csharpier CSHARP_CSHARPIER | ||
سي# (سيشارب) | roslynator CSHARP_ROSLYNATOR | ||
دارت | dartanalyzer DART_DARTANALYZER | ||
يذهب | golangci-lint GO_GOLANGCI_LINT | ||
يذهب | إحياء GO_REVIVE | ||
رائع | npm-رائع-لينت GROOVY_NPM_GROOVY_LINT | ||
جافا | com.checkstyle JAVA_CHECKSTYLE | ||
جافا | PMD Java_PMD | ||
جافا سكريبت | eslint جافا سكريبت_ES | ||
جافا سكريبت | معيار جافا سكريبت_ستاندارد | ||
جافا سكريبت | أجمل جافا سكريبت_PRETTIER | ||
JSX | eslint JSX_ESLINT | ||
كوتلين | ktlint KOTLIN_KTLINT | ||
كوتلين | كشف KOTLIN_DETEKT | ||
لوا | luacheck LUA_LUACHECK | ||
لوا | سيلين LUA_SELENE | ||
لوا | stylua LUA_STYLUA | ||
ملف تعريفي | checkmake MAKEFILE_CHECKMAKE | ||
بيرل | com.perlcritic بيرل_بيرلكريتيك | ||
PHP | phpcs PHP_PHPCS | ||
PHP | com.phpstan PHP_PHPSTAN | ||
PHP | مزمور PHP_PSALM | ||
PHP | phplint PHP_PHPLINT | ||
PHP | PHP-CS-المثبت PHP_PHPCSFIXER | ||
بوويرشيل | com.powershell POWERSHELL_POWERSHELL | ||
بوويرشيل | powershell_formatter POWERSHELL_POWERSHELL_FORMATTER | ||
بايثون | بيلينت PYTHON_PYLINT | ||
بايثون | أسود بايثون_أسود | ||
بايثون | فليك8 PYTHON_FLAKE8 | ||
بايثون | isort PYTHON_ISORT | ||
بايثون | قطاع الطرق بايثون_بانديت | ||
بايثون | com.mypy PYTHON_MYPY | ||
بايثون | pyright PYTHON_PYRIGHT | ||
بايثون | راف PYTHON_RUFF | ||
ر | lintr R_LINTR | ||
راكو | راكو RAKU_RAKU | ||
روبي | com.rubocop RUBY_RUBOCOP | ||
الصدأ | Clippy روست_كليبي | ||
قوة المبيعات | sfdx-الماسح الضوئي-قمة SALESFORCE_SFDX_SCANNER_APEX | ||
قوة المبيعات | sfdx-الماسح الضوئي-هالة SALESFORCE_SFDX_SCANNER_AURA | ||
قوة المبيعات | sfdx-الماسح الضوئي-lwc SALESFORCE_SFDX_SCANNER_LWC | ||
قوة المبيعات | البرق تدفق الماسح الضوئي SALESFORCE_LIGHTNING_FLOW_SCANNER | ||
سكالا | scalfix SCALA_SCALAFIX | ||
SQL | com.sqlfluff SQL_SQLFLUFF | ||
SQL | com.tsqllint SQL_TSCLINT | ||
سويفت | com.swiftlint SWIFT_SWIFTLINT | ||
تسكس | eslint TSX_ESLINT | ||
نسخة مطبوعة | eslint TYPESCRIPT_ES | ||
نسخة مطبوعة | ts-معيار TYPESCRIPT_STANDARD | ||
نسخة مطبوعة | أجمل TYPESCRIPT_PRETTIER | ||
فيجوال بيسك دوت نت (VBDOTNET) | تنسيق الدوت نت VBDOTNET_DOTNET_FORMAT |
شكل | لينتر | إضافي | |
---|---|---|---|
CSS | com.stylelint CSS_STYLELINT | ||
بيئى | dotenv-linter ENV_DOTENV_LINTER | ||
جرافقل | graphql-مخطط-linter GRAPHQL_GRAPHQL_SCHEMA_LINTER | ||
HTML | com.djlint HTML_DJLINT | ||
HTML | htmlhint HTML_HTMLHINT | ||
JSON | com.jsonlint JSON_JSONLINT | ||
JSON | eslint-plugin-jsonc JSON_ESLINT_PLUGIN_JSONC | ||
JSON | v8r JSON_V8R | ||
JSON | أجمل JSON_PRETTIER | ||
JSON | npm-package-json-lint JSON_NPM_PACKAGE_JSON_LINT | ||
مطاط | chktex LATEX_CHKTEX | ||
تخفيض السعر | com.markdownlint MARKDOWN_MARKDOWNLINT | ||
تخفيض السعر | ملاحظة الوبر MARKDOWN_REMARK_LINT | ||
تخفيض السعر | فحص الارتباط-تخفيض السعر MARKDOWN_MARKDOWN_LINK_CHECK | ||
تخفيض السعر | تخفيض السعر-منسق الجدول MARKDOWN_MARKDOWN_TABLE_FORMATTER | ||
بروتوبوف | com.protolint PROTOBUF_PROTOLINT | ||
RST | أول لينت RST_RST_LINT | ||
RST | com.rstcheck RST_RSTCHECK | ||
RST | com.rstfmt RST_RSTFMT | ||
XML | com.xmllint XML_XMLLINT | ||
يامل | أجمل YAML_PRETTIER | ||
يامل | ياملينت YAML_YAMLLINT | ||
يامل | v8r YAML_V8R |
تنسيق الأدوات | لينتر | إضافي | |
---|---|---|---|
فعل | actionlint ACTION_ACTIONLINT | ||
معقول | غير قابل للوبر ANSIBLE_ANSIBLE_LINT | ||
واجهة برمجة التطبيقات | طيفي API_SPECTRAL | ||
ذراع | ذراع-TTK ARM_ARM_TTK | ||
العضلة ذات الرأسين | bicep_linter BICEP_BICEP_LINTER | ||
التشكل السحابي | cfn-الوبر CLOUDFORMATION_CFN_LINT | ||
ملف الرصيف | هادولينت DOCKERFILE_HADOLINT | ||
تكوين المحرر | Editorconfig-checker EDITORCONFIG_EDITORCONFIG_CHECKER | ||
غيركين | غيركين لينت غيركين_غيركين_لينت | ||
كوبيرنيتيس | kubeconform KUBERNETES_KUBECONFORM | ||
كوبيرنيتيس | خوذة KUBERNETES_HELM | ||
كوبيرنيتيس | com.kubescape KUBERNETES_KUBESCAPE | ||
دمية | دمية الوبر PUPPET_PUPPET_LINT | ||
صنع الثعبان | com.snakemake SNAKEMAKE_LINT | ||
صنع الثعبان | com.snakefmt SNAKEMAKE_SNAKEFMT | ||
تيكتون | تكتون لينت TEKTON_TEKTON_LINT | ||
تيرافورم | tflint TERRAFORM_TFLINT | ||
تيرافورم | تيراسكان TERRAFORM_TERRASCAN | ||
تيرافورم | terergrunt TERRAFORM_TERRAGRUNT | ||
تيرافورم | terraform-fmt TERRAFORM_TERRAFORM_FMT |
مدقق جودة الكود | لينتر | إضافي | |
---|---|---|---|
كوبيباستي | jscpd COPYPASTE_JSCPD | ||
مستودع | checkov REPOSITORY_CHECKOV | ||
مستودع | devskim REPOSITORY_DEVSKIM | ||
مستودع | غبار REPOSITORY_DUSTILOCK | ||
مستودع | git_diff REPOSITORY_GIT_DIFF | ||
مستودع | gitleaks REPOSITORY_GITLEAKS | ||
مستودع | غريب REPOSITORY_GRYPE | ||
مستودع | kics REPOSITORY_KICS | ||
مستودع | ls-lint REPOSITORY_LS_LINT | ||
مستودع | com.secretlint REPOSITORY_SECRETLINT | ||
مستودع | com.semgrep REPOSITORY_SEMGREP | ||
مستودع | syft REPOSITORY_SYFT | ||
مستودع | تافه REPOSITORY_TRIVY | ||
مستودع | تافه sbom REPOSITORY_TRIVY_SBOM | ||
مستودع | trufflehog REPOSITORY_TRUFFLEHOG | ||
يتهجى | com.cspell SPELL_CSPELL | ||
يتهجى | proselint SPELL_PROSELINT | ||
يتهجى | فالي SPELL_VALE | ||
يتهجى | ليتشي SPELL_LYCHE |
ما عليك سوى تشغيل npx mega-linter-runner --install
في جذر مستودعك والإجابة على الأسئلة، وسيقوم بإنشاء ملفات تكوين جاهزة للاستخدام لـ MegaLinter :)
تستخدم أمثلة الإرشادات التالية أحدث إصدار ثابت من MegaLinter ( الإصدار 8 ، الذي يتوافق دائمًا مع أحدث إصدار)
oxsecurity/megalinter:v8
oxsecurity/megalinter@v8
يمكنك أيضًا استخدام الإصدار التجريبي (المتوافق مع محتوى الفرع الرئيسي)
oxsecurity/megalinter:beta
oxsecurity/megalinter@beta
.github/workflows/mega-linter.yml
ملحوظات:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
في سير عملك، فسيقوم MegaLinter بوضع علامة على حالة كل عملية تشغيل فردية في قسم الشيكات لطلب السحب. بدون هذا سوف ترى فقط الحالة العامة للتشغيل الكامل. ليست هناك حاجة لتعيين سر GitHub لأنه يتم تعيينه تلقائيًا بواسطة GitHub، بل يحتاج فقط إلى تمريره إلى الإجراء.GITHUB_TARGET_URL
. في مستودعك، يجب أن يكون لديك مجلد .github/workflows
مع GitHub Action مشابه لما يلي:
.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!
استخدم قالب Azure Pipelines YAML التالي
يمكنك تكوين سياسة فرع التحقق من صحة البناء مقابل مستودع واحد أو عبر جميع المستودعات. إذا قمت بالتكوين عبر جميع المستودعات، فسيتم تخزين خط الأنابيب الخاص بك في مستودع مركزي.
أضف ما يلي إلى ملف 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 :
يوسع