README

这是一个 Laravel 5 包，可以将 SquizLabs CodeSniffer 2 集成到基于 Laravel 的应用程序中。它也可以手动使用，请继续阅读。

检测定义的编码标准违规。它有助于保持代码的整洁和一致性。可用选项包括：PSR2、PSR1、Zend、PEAR、Squiz、PHPCS 和 SocialEngine。

设置

在 composer 中要求此包

$ composer require socialengine/sniffer-rules

Laravel 5

在您的 config/app.php 中将 'SocialEngine\SnifferRules\ServiceProvider' 添加到 $providers 数组中

'providers' => [
    'Illuminate\Foundation\Providers\ArtisanServiceProvider',
    'Illuminate\Auth\AuthServiceProvider',
    
    'SocialEngine\SnifferRules\ServiceProvider',

],

Laravel 5：发布配置文件

$ php artisan vendor:publish

手动

通过配置 PHP_CodeSniffer 以查找它来安装我们的标准。

$ php ./vendor/bin/phpcs --config-set installed_paths ./vendor/socialengine/src/Socialengine/SnifferRules/Standard/

使用方法

Laravel

$ php artisan sniff

在 CI 环境中运行 sniffer 时，应将 -n 选项设置为移除交互

$ php artisan sniff -n

手动

$ php ./vendor/bin/phpcs --standard=SocialEngine path/to/code

建议将 Makefile 添加到您的项目中，以便其他开发者可以轻松使用。使用此目录中的 Makefile 并根据需要调整以适应项目要求。

Travis

与 Makefile 结合使用时，Travis 在查找标准时存在问题，我们不得不添加一个 before_script 以使其正常工作。请参阅 Unum 存储库的示例。

before_script: php ./vendor/bin/phpcs --config-set installed_paths "`pwd`/vendor/socialengine/sniffer-rules/src/SocialEngine/SnifferRules/Standard/"

SocialEngine 编码标准

编码标准

补充和说明

namespace 应与 opening php 标签在同一行上。例如：<?php namespace SocialEngine\Amazing
属性名称应使用 camelCase
测试名称应使用下划线，而不是 camelCase。例如：test_cats_love_catnip

许可

MIT

socialengine / sniffer-rules

维护者

详细信息