راه اندازی قلاب های Pre-Commit در GitHub: اطمینان از کیفیت و سازگاری کد

معرفی:
قلاب‌های Pre-commit ابزار قدرتمندی هستند که می‌توانند به حفظ کیفیت کد، اجرای دستورالعمل‌های سبک و جلوگیری از اشتباهات رایج در توسعه نرم‌افزار کمک کنند. در این پست وبلاگ، نحوه راه‌اندازی قلاب‌های Pre-commit را برای کل تیم خود با استفاده از GitHub بررسی خواهیم کرد. به طور خاص، ما در مورد فرآیند تنظیم قلاب‌های پیش‌متعهد برای ابزارهای محبوبی مانند Black، pre-commit-hooks، Prettier و pylint بحث خواهیم کرد.

فهرست مطالب:

1. قلاب های Pre-Commit چیست؟
2. مزایای قلاب های Pre-Commit
3. تنظیم Hook های Pre-Commit در GitHub
الف. پیش نیازها
b.پیکربندی فایل پیکربندی پیش از انجام commit
c.Installing و Initializing Pre-Commit
d.Adding Pre-Commit Hooks

1. قلاب های پرکاربرد قبل از ارتکاب a.سیاه b.قبل از ارتکاب قلاب c.Prettier d.pylint
2. سفارشی کردن قلاب های Pre-Commit
3. اجرای قلاب های Pre-Commit
4. نتیجه

مطمئن! در اینجا مراحل نصب و قطعه کد برای هر بخش در فهرست مطالب آمده است:

1. قلاب های Pre-Commit چیست؟

قلاب های Pre-commit اسکریپت ها یا اقداماتی هستند که به طور خودکار قبل از انجام یک commit به یک سیستم کنترل نسخه اجرا می شوند. آنها به اجرای استانداردهای کیفیت کد کمک می کنند و مشکلات احتمالی را قبل از اینکه متعهد شوند، شناسایی می کنند.

2. مزایای قلاب های Pre-Commit

استفاده از قلاب‌های پیش‌متعهد در گردش کار توسعه، چندین مزیت را به همراه دارد:

• تضمین کیفیت و سازگاری کد
• اجرای دستورالعمل های سبک و استانداردهای قالب بندی
• جلوگیری از اشتباهات یا مسائل رایج
• تشخیص زود هنگام باگ ها یا آسیب پذیری های احتمالی
• تسهیل همکاری و کاهش تلاش‌های بازبینی کد

3. راه اندازی Pre-Commit Hooks در GitHub

آ. پیش نیازها

• Git روی سیستم شما نصب شده است
• دایرکتوری پروژه که با یک مخزن Git راه اندازی شده است

ب پیکربندی فایل پیکربندی قبل از انجام تعهد

یک فایل به نام ایجاد کنید .pre-commit-config.yaml در ریشه دایرکتوری پروژه شما. این فایل شامل پیکربندی برای قلاب های Pre-Commit شما خواهد بود.

ج نصب و راه اندازی Pre-Commit

pip install pre-commit
pre-commit init

د اضافه کردن قلاب‌های Pre-Commit

در .pre-commit-config.yaml فایل، قلاب هایی را که می خواهید استفاده کنید تعریف کنید. به عنوان مثال، برای استفاده از فرمت کننده کد سیاه:

repos:
  - repo: https://github.com/psf/black
    rev: <version>
    hooks:
      - id: black

جایگزین کردن <version> با نسخه دلخواه Black.

4. قلاب های Pre-Commit معمولاً مورد استفاده قرار می گیرند

آ. مشکی

نصب و راه اندازی:

pip install black

پیکربندی در .pre-commit-config.yaml:

repos:
  - repo: https://github.com/psf/black
    rev: <version>
    hooks:
      - id: black

ب قلاب های قبل از تعهد

نصب و راه اندازی:

pip install pre-commit-hooks

پیکربندی در .pre-commit-config.yaml:

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: <version>
    hooks:
      - id: check-json

ج زیباتر

نصب و راه اندازی:

npm install --save-dev prettier

پیکربندی در .pre-commit-config.yaml:

repos:
  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: <version>
    hooks:
      - id: prettier
    files: \.(json|markdown|md|yaml|yml)$

د ستون

نصب و راه اندازی:

pip install pylint

پیکربندی در .pre-commit-config.yaml:

repos:
  - repo: https://github.com/PyCQA/pylint
    rev: <version>
    hooks:
      - id: pylint
        name: pylint
        entry: pylint
        language: system
        types: [python]
        env:
          PYTHONPATH: "./"

5. سفارشی کردن قلاب های Pre-Commit

می‌توانید قلاب‌های Pre-Commit را با تغییر آن سفارشی کنید .pre-commit-config.yaml فایل. این شامل تعیین گزینه های هوک، حذف فایل ها یا دایرکتوری ها، یا تعریف قلاب ها یا اسکریپت های اضافی است.

6. اجرای Pre-Commit Hooks

برای اجرای قلاب های قبل از commit، به سادگی با استفاده از Git یک commit ایجاد کنید. قلاب ها به طور خودکار اجرا می شوند. برای اجرای دستی هوک ها بدون انجام commit، از دستور استفاده کنید pre-commit run --all-files.

7. نتیجه گیری

در این پست وبلاگ، نحوه راه اندازی و استفاده از قلاب های Pre-Commit در GitHub را بررسی کرده ایم. با دنبال کردن این مراحل و پیکربندی قلاب‌ها، می‌توانید از کیفیت کد اطمینان حاصل کنید، دستورالعمل‌های سبک را اجرا کنید و مشکلات احتمالی را در مراحل اولیه توسعه خود پیدا کنید. قلاب‌های Pre-Commit مزایای متعددی را ارائه می‌دهند و می‌توانند همکاری و هماهنگی کد را در تیم شما تا حد زیادی بهبود بخشند.