Welcome!

دستور خط فرمان pre-commit یک ابزار است که به ما امکان میدهد تا قبل از هر کامیت، برخی از بررسیها و اصلاحات خودکار را روی کد خود انجام دهید. با استفاده از pre-commit، شما میتوانید از وجود خطاهای ساده، فضای خالی اضافی، قوانین نوشتاری و غیره در کد خود مطمئن شوید. pre-commit همچنین از زبانهای مختلف برنامه نویسی پشتیبانی میکند و شما میتوانید از هوکهای آماده یا سفارشی استفاده کنید. برای استفاده از pre-commit، شما باید:

• pre-commit را نصب کنید. روشهای نصب برای پلتفرمهای مختلف را میتوانید در سایت رسمی pre-commit ببینید.
• یک فایل پیکربندی با نام .pre-commit-config.yaml در ریپوزیتوری گیت خود بسازید. در این فایل، شما باید لیست هوکهای مورد نظر خود را تعریف کنید.
• دستور pre-commit install را در ترمینال وارد کنید تا هوکهای گیت را فعال کنید.

بعد از این مراحل، هر بار که شما دستور git commit را وارد کنید، pre-commit به صورت خودکار هوکهای تعریف شده را روی کد شما اجرا میکند و در صورت وجود مشکل، جلوی کامیت را میگیرد.

از این دستور در تمام پروژه‌های OCA و ویراوب۱۲۳ استفاده می‌شود و شما باید تمام قوانین موجود در این سیستم را رعایت کنید. اما ممکن است سوال کنید که چه قوانینی وجود دارد؟ این کاملا وابسته به روش پیکره بندی پروژه‌ها است. در پروژه‌های OCA روشی یک پارچه برای این کار استفاده می شود و پروژه‌هایی هم برای این کار در نظر گرفته شده. اما ما در ویراور۱۲۳ ار روش‌های محدودتری استفاده می‌کنیم.