README

Backdevs PHP项目使用的PHP_CodeSniffer编码规范以及其他静态分析工具配置文件。

包含默认配置

• PHP_CodeSniffer
• PHP Mess Detector

安装

Composer

composer require --dev backdevs/coding-standard

使用方法

PHP_CodeSniffer

在您项目的phpcs.xml文件中添加以下行

<rule ref="BackdevsCodingStandard"/>

如果您没有phpcs.xml文件，这里是一个Laravel项目的示例

<?xml version="1.0"?>
<ruleset
        name="Backdevs Coding Standard"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="./vendor/squizlabs/php_codesniffer/phpcs.xsd"
>
    <description>Backdevs Coding Standard.</description>
    
    <arg name="extensions" value="php"/>
    <arg name="colors" />

    <arg value="sp"/>

    <file>app</file>
    <file>bootstrap</file>
    <file>config</file>
    <file>database</file>
    <file>routes</file>
    <file>tests</file>

    <exclude-pattern>cache/*</exclude-pattern>

    <rule ref="BackdevsCodingStandard"/>
</ruleset>

现在您应该可以运行

vendor/bin/phpcs

PHP Mess Detector

如果您尚未安装phpmd/phpmd包，可以通过运行以下命令安装它

composer require --dev phpmd/phpmd

然后，在您项目的phpmd.xml文件中添加以下行

<rule ref="vendor/backdevs/coding-standard/phpmd/phpmd.xml"/>

如果您没有phpmd.xml文件，这里有一个简单的示例

<?xml version="1.0"?>
<ruleset
    name="Backdevs Coding Standard"
    xmlns="http://pmd.sf.net/ruleset/1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
    xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
>
    <description>Backdevs Coding Standard.</description>

    <rule ref="vendor/backdevs/coding-standard/phpmd/phpmd.xml"/>
</ruleset>

现在您可以运行

vendor/bin/phpmd app,bootstrap,config,database,routes,tests text phpmd.xml