README

通过 Artisan CLI 使用行业标准工具检查您的代码。

此 Laravel 4 包向 Artisan CLI 添加了几个预先配置的工具，加速了您的开发过程，并使您的代码更加整洁。

当前提供的工具有：

• PHP Code Sniffer
• PHP CS Fixer
• PHP Mess Detector
• PHP 的原生 Linter

安装

1. 将包添加到 Composer

此包应通过 Composer 安装。您可以通过编辑项目的 composer.json 文件以要求 bca/laravel-inspect 或通过命令行来实现。

composer require bca/laravel-inspect:~1.3

2. 添加服务提供者

一旦安装了包，最后一步就是添加服务提供者。打开 app/config/app.php，并将新项目添加到 providers 数组中

'BCA\LaravelInspect\LaravelInspectServiceProvider'

3. 享受吧！

就这样，大家！只需从您的 Laravel 安装根目录中键入 ./artisan，即可看到您的新工具！

高级用法

我们已经为提供的工具制定了符合 Laravel 项目本身编码风格的规则。话虽如此，一种尺寸并不适合所有人，您当然可以使用 PEAR 风格指南、PSR-2 或自行创建一个！

自定义规则集

PHP Code Sniffer 和 PHP Mess Detector 都支持创建自定义规则集。

PHP Code Sniffer

要为使用 inspect:sniff 命令的 phpcs.xml 规则集，只需将规则集放入 Laravel 的 app 目录中。然后，您可以使用此 注释规则集 作为创建自己规则集的指南。

您还可以运行 php artisan inspect:sniff --install-ruleset 以将我们的规则复制到您的项目中以便进行修改。

PHP Mess Detector

要为使用 inspect:mess 命令的 phpmd.xml 规则集，只需将规则集放入 Laravel 的 app 目录中。PHPMD 网站提供了如何 创建规则集 的说明。

您还可以运行 php artisan inspect:mess --install-ruleset 以将我们的规则复制到您的项目中以便进行修改。

贡献

此项目将在 Github 上维护，网址为 https://github.com/brodkinca/BCA-Laravel-Inspect。您还可以在那里找到此项目的 问题跟踪器。

版本管理

此库将根据语义版本指南进行维护。

发布将采用以下格式编号

<major>.<minor>.<patch>

并按照以下指南构建

• 破坏向后兼容性将增加主版本（并重置次版本和补丁）
• 在不破坏向后兼容性的情况下添加的新功能将增加次版本（并重置补丁）
• 错误修复和其它更改将增加补丁

有关 SemVer 的更多信息，请访问 http://semver.org/。

测试

由于Artisan CLI的特殊性，无法在完整Laravel应用的环境之外运行单元测试。相反，应将此软件包安装到Laravel副本中，作为一个工作台应用，然后将其添加到该安装的phpunit.xml文件中。因此，建议在包开发时运行Laravel的开发副本。

请在提交任何代码之前运行所有单元测试！

注意：运行单元测试将会在没有任何警告的情况下清除您app目录中的所有phpcs/phpmd配置文件！！！