创建命令组

代码示例

<?php declare(strict_types=1);
namespace Inhere\Kite\Console\Controller;
use Inhere\Console\Controller;
use Inhere\Console\Exception\PromptException;
use Inhere\Console\IO\Input;
use Inhere\Console\IO\Output;
use Inhere\Kite\Console\Component\Clipboard;
use Inhere\Kite\Common\Cmd;
use Inhere\Kite\Common\CmdRunner;
use Inhere\Kite\Helper\AppHelper;
use Inhere\Kite\Helper\GitUtil;
use PhpGit\Changelog\Filter\KeywordsFilter;
use PhpGit\Changelog\Formatter\GithubReleaseFormatter;
use PhpGit\Changelog\Formatter\SimpleFormatter;
use PhpGit\Changelog\GitChangeLog;
use PhpGit\Git;
use PhpGit\Info\TagsInfo;
use PhpGit\Repo;
use Throwable;
use Toolkit\PFlag\FlagsParser;
use Toolkit\Stdlib\Obj\ConfigObject;
use Toolkit\Stdlib\Str;
/**
 * Class GitController
 */
class GitController extends Controller
{
 protected static $name = 'git';
 protected static $description = 'Provide useful tool commands for quick use git';
 /**
 * @var ConfigObject
 */
 private $settings;
 public static function aliases(): array
 {
 return ['g'];
 }
 protected static function commandAliases(): array
 {
 return [
 'changelog' => ['chlog', 'clog', 'cl'],
 'log' => ['l', 'lg'],
 ];
 }
 /**
 * @return string[]
 */
 protected function options(): array
 {
 return [
 '--dry-run' => 'bool;Dry-run the workflow, dont real execute',
 '-y, --yes' => 'Direct execution without confirmation',
 // '-i, --interactive' => 'Run in an interactive environment[TODO]',
 ];
 }
 protected function beforeRun(): void
 {
 if ($this->app && !$this->settings) {
 $this->settings = ConfigObject::new($this->app->getArrayParam('git'));
 }
 }
 
 /**
 * display recently git commits information by `git log`
 *
 * @arguments
 * maxCommit int;Max display how many commits;;15
 *
 * @options
 * --ac, --abbrev-commit bool;Only display the abbrev commit ID
 * --exclude Exclude contains given sub-string. multi by comma split.
 * --file Export changelog message to file
 * --format The git log option `--pretty` value.
 * can be one of oneline, short, medium, full, fuller, reference, email, raw, format:<string> and tformat:<string>.
 * --mc, --max-commit int;Max display how many commits
 * --nc, --no-color bool;Dont use color render git output
 * --nm, --no-merges bool;No contains merge request logs
 *
 * @param FlagsParser $fs
 * @param Output $output
 */
 public function logCommand(FlagsParser $fs, Output $output): void
 {
 $b = Git::new()->newCmd('log');
 $noColor = $fs->getOpt('no-color');
 $exclude = $fs->getOpt('exclude');
 $noMerges = $fs->getOpt('no-merges');
 $abbrevID = $fs->getOpt('abbrev-commit');
 $maxCommit = $fs->getOpt('max-commit', $fs->getArg('maxCommit'));
 // git log --color --graph --pretty=format:'%Cred%h%Creset:%C(ul yellow)%d%Creset %s (%Cgreen%cr%Creset, %C(bold blue)%an%Creset)' --abbrev-commit -10
 $b->add('--graph');
 $b->addIf('--color', !$noColor);
 $b->add('--pretty=format:"%Cred%h%Creset:%C(ul yellow)%d%Creset %s (%Cgreen%cr%Creset, %C(bold blue)%an%Creset)"');
 $b->addIf("--exclude=$exclude", $exclude);
 $b->addIf('--abbrev-commit', $abbrevID);
 $b->addIf('--no-merges', $noMerges);
 $b->add('-' . abs($maxCommit));
 $b->runAndPrint();
 $output->success('Complete');
 }
}

编写命令组说明

绑定选项参数

查看帮助

运行命令

kite git log
# 添加选项和参数
kite git log 2
kite git log --abbrev-commit 5

设置命令组别名

 /**
 * @return string[]
 */
 public static function aliases(): array
 {
 return ['g'];
 }

设置子命令的别名

 protected static function commandAliases(): array
 {
 return [
 'changelog' => ['chlog', 'clog', 'cl'],
 'log' => ['l', 'lg'],
 ];
 }

设置命令组的选项

 /**
 * @return string[]
 */
 protected function getOptions(): array
 {
 return [
 '--try,--dry-run' => 'bool;Dry-run the workflow, dont real execute',
 '-y, --yes' => 'bool;Direct execution without confirmation',
 '-w, --workdir' => 'The command work dir, default is current dir.',
 ];
 }

kite git --workdir another/dir log 2

更多有用的方法