longman/php-code-style

长代码风格配置

安装数量: 16,389

依赖项: 7

建议者: 0

安全: 0

星标: 9

关注者: 2

分支: 1

开放问题: 0

类型:phpcodesniffer-standard

10.2.0 2024-07-31 13:30 UTC

README

这是一个基于 PSR-12 的代码风格规则集,用于 PHP Code Sniffer

PHP Code Sniffer

配置文件: longish.phpcs.xml

使用方法

  1. 将 longman/php-code-style 仓库作为 composer 依赖项链接

    $ composer require --dev longman/php-code-style

  2. 扩展提供的配置以适应您的项目。例如,创建自定义 phpcs.xml 文件并将

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="Project code style checker config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../vendor/squizlabs/php_codesniffer/phpcs.xsd">
    <rule ref="./vendor/longman/php-code-style/longish.phpcs.xml"/>
    
    <!-- Exclude stubs file for PSR1.Classes.ClassDeclaration rule -->
    <rule ref="PSR1.Classes.ClassDeclaration">
        <exclude-pattern>*/_stubs.php</exclude-pattern>
    </rule>
    
    <!-- Exclude stubs file for Generic.CodeAnalysis.UnconditionalIfStatement rule -->
    <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement.Found">
        <exclude-pattern>*/_stubs.php</exclude-pattern>
    </rule>
</ruleset>
  1. 对于 Laravel,您可以直接包含 laravel.phpcs.xml
<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="Project code style checker config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../vendor/squizlabs/php_codesniffer/phpcs.xsd">
    <rule ref="./vendor/longman/php-code-style/laravel.phpcs.xml" />

</ruleset>

运行检查(Laravel 示例)

vendor/bin/phpcs --standard=vendor/longman/php-code-style/laravel.phpcs.xml -spn --encoding=utf-8 --report-width=150 --colors --parallel=16 app/ config/ tests/

使用自定义 phpcs.xml 运行检查

vendor/bin/phpcs --standard=phpcs.xml -spn --encoding=utf-8 --report-width=150 --colors --parallel=16 app/ config/ tests/