README

此包提供生成关于您的应用控制台命令的文档。

安装

运行命令

composer require --dev artarts36/artisan-documentator
php artisan vendor:publish --provider="ArtARTs36\ArtisanDocumentator\Providers\ArtisanDocumentatorServiceProvider" --tag=config

控制台命令

安装后，您可以通过运行命令 php artisan command:doc {path} 来生成文档。例如：php artisan command:doc docs/command.md

配置

您可以在文件 config/artisan_documentator.php 的 'namespaces' 部分设置命令的命名空间。

    'namespaces' => [
        // 'namespace:' => 'title,
        // 'app:' => 'App Commands',
        // 'make:' => 'Laravel make Commands',
    ],

在 CI 中使用

为了在 CI 中使用生成功能，您需要在文件 config/artisan_documentator.php 的 'git.remotes' 部分指定您的登录和令牌。

    'git' => [
        'dir' => base_path(),
        'remote' => [
            'login' => 'my-name',
            'token' => env('ARTISAN_DOCUMENTATOR_GIT_REMOTE_TOKEN'),
        ],
        'commit' => [
            'message' => '[DOCS] auto-build console documentation',
        ],
    ],

在 CI 配置文件中调用命令

php artisan command:doc docs/command.md --ci

命令描述

必须在控制台命令中填写属性 description 以生成完整的文档。

使用PHP CS Fixer 规则 PhpCsFixerGoodFixers/laravel_command_no_empty_description 防止未描述的命令进入您的仓库。

artarts36 / artisan-documentator

维护者

详细信息

README

安装

控制台命令

配置

在 CI 中使用

命令描述