markwalet/laravel-git-state

一个Laravel包,为您提供当前Git状态的详细信息。

v1.9.0 2024-03-13 10:01 UTC

This package is auto-updated.

Last update: 2024-09-13 10:57:16 UTC


README

MIT Licensed Latest Stable Version Build status Coverage Total Downloads

一个Laravel包,为您提供当前Git状态的详细信息。

安装

您可以使用composer安装此包

composer require markwalet/laravel-git-state

Laravel会自动加载服务提供者,因此您无需手动注册。如果您想手动注册服务提供者,请将以下行添加到您的 config/app.php 文件中

MarkWalet\GitState\GitStateServiceProvider::class

使用方法

当您想要获取关于当前Git状态的信息时,您可以在您的函数中注入 MarkWalet\GitState\Drivers\GitDriver

<?php

use MarkWalet\GitState\Drivers\GitDriver;

class Controller {
    
    public function index(GitDriver $driver) {
        $branch = $driver->currentBranch();
        $commit = $driver->latestCommitHash();
        
        return view('index', compact('branch', 'commit'));
    }
}

以这种方式注入GitDriver后,您将获得您配置的默认驱动程序的实例。如果您想要对使用的驱动程序有更多的控制权,您可以使用 MarkWalet\GitState\GitManager

<?php

use MarkWalet\GitState\GitStateManager;

class Controller {
    
    public function index(GitStateManager $driver) {
        $branch = $driver->driver('other-driver')->currentBranch();
        
        return view('index', compact('branch'));
    }
}

配置

默认配置定义在 git-state.php 文件中。如果您想编辑此文件,您可以使用以下命令将其复制到您的配置文件夹中

php artisan vendor:publish --provider="MarkWalet\GitState\GitServiceProvider"

在此文件中,您可以配置不同的驱动程序以获取当前的Git状态,以及设置默认配置。

支持的驱动程序有:execfile。还有一个用于测试目的的 fake 实现。