thetomnewton/laravel-docblocks-php-cs-fixer

PHP-CS-Fixer 的 Laravel-style docblocks 包

v0.0.3 2022-03-15 11:29 UTC

This package is auto-updated.

Last update: 2023-10-15 14:58:03 UTC


README

Latest Version on Packagist Total Downloads GitHub Actions

此包将帮助您使用 PHP-CS-Fixer 获得一致的 Laravel-style docblocks

安装

您可以通过 composer 安装此包

composer require thetomnewton/laravel-docblocks-php-cs-fixer

当然,您也需要安装 PHP-CS-Fixer 包。

用法

在您的 .php-cs-fixer.php 中,将自定义修复器添加到配置类中,例如

return (new Config)
    ->setFinder($finder)
    ->registerCustomFixers([
        new \Thetomnewton\LaravelDocFixer\LaravelDocblocks,
    ])
    ->setRules($rules);

然后在您的规则列表中添加以下行

$rules = [
    // ...
    'LaravelDocblocks/laravel_style_docs' => true,
    // ...
];

任务完成!来试一试

./vendor/bin/php-cs-fixer fix -vvv --show-progress=dots

安全

如果您发现任何与安全相关的问题,请发送电子邮件至 tom@tomn.dev 而不是使用问题跟踪器。

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件