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 以查找它，安装我们的 Standard。

$ 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应与打开php标签在同一行。例如：<?php namespace SocialEngine\Amazing
属性名应使用camelCase
测试名应使用下划线，而不是camelCase。例如：test_cats_love_catnip

许可证

MIT

socialengine / sniffer-rules

维护者

详情