README

Leviy 编码规范

Leviy 为 PHP 代码编写的编码规范，包含用于 PHP CodeSniffer 和 PHP Mess Detector 的规则集。

安装

使用 Composer 安装此包

composer require --dev leviy/coding-standard

安装 PHP CodeSniffer 规则集

在项目的根目录创建一个名为 phpcs.xml 的文件，内容如下

<?xml version="1.0" encoding="UTF-8"?>
<ruleset>
    <rule ref="LEVIY"/>

    <config name="ignore_warnings_on_exit" value="1"/>

    <arg name="extensions" value="php"/>

    <file>src/</file>
    <file>tests/</file>
    <file>public/index.php</file>
</ruleset>

安装 PHP Mess Detector 规则集

在项目的根目录创建一个名为 phpmd.xml 的文件，内容如下

<?xml version="1.0" encoding="UTF-8"?>
<ruleset 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"
         name="Mess detector ruleset">
    <description>Ruleset for PHP Mess Detector that enforces coding standards</description>

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

配置

PHP CodeSniffer

您可以在此处找到标注的 ruleset.xml 配置文件，其中您可以查看所有功能及其配置选项，并据此修改配置以适应您的项目需求。

PHP Mess Detector

有关调整规则集、排除规则或更改设置的文档，请参阅此处。

使用方法

运行 vendor/bin/phpcs 以运行 PHP CodeSniffer。如果您在项目的根目录中有一个 phpcs.xml 或 phpcs.xml.dist 文件，CodeSniffer 会自动使用它。添加路径以仅针对该文件或目录运行 CodeSniffer。有关更详细的用法说明，请参阅用法。

运行 vendor/bin/phpmd src/ text phpmd.xml 以对 src 目录运行 PHP Mess Detector 并以 "text" 格式打印报告。

PHPStorm 代码规范验证

打开 "首选项" 并导航到 "编辑器 > 检查"。
启用 "PHP > 质量工具 > PHP_Code Sniffer 验证"。
选择 "自定义" 编码规范。
选择项目代码规范配置的路径。

享受代码规范验证问题的即时反馈！

leviy / coding-standard

维护者

详情