README

laravel 或其他 PHP 项目的 php codesniffer 规则集。

安装

[*] 使用 composer 安装

composer require mreduar/laravel-phpcs --dev

[*] 手动安装

将 phpcs.xml 文件复制到您的项目根目录。
取消注释 phpcs.xml 文件中的 <file>app</file> 以及其他行。
由于此包使用了不在 phpcs 中的第三方标准，因此您需要安装这些包。
1. composer require slevomat/coding-standard
运行 phpcs . 检查您的项目。

用法

启用规则

如果您使用 composer 安装了包，则此步骤是必要的！

php artisan vendor:publish --provider="Mreduar\LaravelPhpcs\LaravelPhpcsServiceProvider" --tag="ruleset"

这将在您的根目录发布以下文件

<?xml version="1.0"?>
<ruleset>
    <arg name="basepath" value="."/>

    <file>./app</file>
    <file>./config</file>
    <file>./resources</file>
    <file>./routes</file>
    <file>./tests</file>

    <rule ref="./vendor/mreduar/laravel-phpcs/phpcs.xml"/>
</ruleset>

可选地，您还可以发布一个 git 钩子，这有助于您永远不会忽视有问题的代码。

php artisan vendor:publish --provider="Mreduar\LaravelPhpcs\LaravelPhpcsServiceProvider" --tag="hook"

该文件将发布在根目录的 .git/hooks/pre-commit 中，所以每次您尝试提交时，phpcs 将首先检查您是否一切都正确。

$ git commit -m "test"
[1/1] code sniffer        OK!
[master a6133d7] test
 1 file changed, 1 insertion(+), 1 deletion(-)

如果您有任何错误，提交将被取消。

代码嗅探

使用指向您的 xml 文件的 php CodeSniffer 命令，使用新的规则集嗅探代码。

vendor/bin/phpcs vendor/bin/phpcbf

在 PHPStorm 中代码嗅探

请参阅 PHP Code Sniffer in PhpStorm 了解如何在 PHPStorm 中设置 CodeSniffer。

在 Visual Studio Code 中代码嗅探

请参阅 PHP Sniffer by wongjn 或其他 phpcs 插件以获取有关 Visual Studio Code 中 PHP CodeSniffer 的更多信息。

贡献

所有使嗅探器更接近 Laravel 编码标准的更改都始终受到高度赞赏和欢迎。

请参阅 CONTRIBUTING 了解更多详情。

致谢

所有贡献者

许可协议

MIT 许可协议 (MIT)。有关更多信息，请参阅许可文件。

mreduar / laravel-phpcs

维护者

详细信息