README

مدیریت مخزن‌های Git از طریق دستورالعمل خطی.

توجه: این هنوز یک پروژه در حال پیشرفت است، آزمایش‌های واحد، تحلیل‌های ساکت و غیره کامل نیستند و این راهنمای مختصر ممکن است تغییر کند.

استفاده

کد پایگاه داده Git Destroyer را دانلود کنید یا از Composer استفاده کنید composer create-project danc0/git-destroyer و یک آلیاس برای src/git-destroyer ایجاد کنید. این کار به شما امکان می‌دهد که از این فایل در CLI با آلیاس استفاده کنید به جای اینکه مجبور شوید php [PATH TO INSTALL]/src/git-destroyer را تایپ کنید. مثال‌های آینده فرض می‌کنند که آلیاس git-destroyer تنظیم شده است.

اساسی‌ها

Git Destroyer گزینه‌های منحصر به فردی برای منوهای کمک ارائه می‌دهد git-destroyer help دستورات موجود و برخی اطلاعات بسته را نمایش می‌دهد. دستورات زیر را نشان می‌دهم.

|Command           |Description                                               |
|------------------|----------------------------------------------------------|
|init              |Initialize a project                                      |
|clone             |Clone the remote repository                               |
|new-branch        |Create a new branch                                       |
|update            |Switch to a new branch                                    |
|commit <message>  |Commit your changes                                       |
|staging-push      |Merge your changes into the staging branch and push them  |
|live-push         |Merge your changes into the live branch and push them     |
|push              |Push your changes to the remote                           |
|script <name>     |Run a script from the config                              |
|version           |Prints the version information for git-destroyer          |

هر یک از این دستورات نیز منوهای کمک خود را دارند که می‌توانید با استفاده از --help دسترسی پیدا کنید به عنوان مثال git-destroyer commit --help

Command: commit <message>
About: Commit your changes
Usage:

|Arg              |Alias       |Description                               |Required  |Is Flag  |
|-----------------|------------|------------------------------------------|----------|---------|
|--add-all        |-a          |Add all files to the commit               |False     |True     |
|--files=[VALUE]  |-f=[VALUE]  |CSV string of files to add to the commit  |False     |False    |
|--local-only     |-l          |Only commit locally, do not push          |False     |True     |

این شما را به استفاده، دکمه‌های موجود، گزینه‌های موجود و اینکه آیا آنها الزامی هستند، راهنمایی می‌کند.

آغاز کردن

دستور git-destroyer init را اجرا کنید تا یک تنظیم جدید Git Destroyer برای پروژه خود ایجاد کنید. این کار یک فایل پیکربندی و یک فایل هooke را ایجاد می‌کند.

فایل هooke

فایل هooke یک فایل JSON است که به شما امکان می‌دهد اجرای Git Destroyer را در زمان‌های مختلف شخصی‌سازی کنید.

{
    "new_branch": {
        "pre": [],
        "post": []
    },
    "commit": {
        "pre": [],
        "post": []
    },
    "staging": {
        "pre": [],
        "post": []
    },
    "live": {
        "pre": [],
        "post": []
    },
    "scripts": {
        "example": "echo \"hello world\""
    }
}

تعداد pre و post باید رشته‌های دستورات bash باشند که می‌خواهید در آن زمان‌ها اجرا کنید. کلیدهای staging و live برای ترکیب کد با شاخه‌های staging یا تولیدی شما هستند. بخش scripts باید یک شیء باشد تا بتوانید آن‌ها را با استفاده از git-destroyer script example فراخوانی کنید.

نکات محیط توسعه

لازم است src/stan.php برای پیدا کردن ثابت‌ها برای PHPStan ایجاد کنید، این فایل باید به این شکل باشد

<?php
define('ROOT', getcwd());
define('APP_ROOT', __DIR__);

اگر سعی کنید روی این کار کنید و آن را اضافه نکنید، PHPStan به شما اعتراض می‌کند.