README

基本信息

关于 PHP Codesniffer 软件包

PHP_CodeSniffer 是一套包含两个 PHP 脚本的工具；主要的 phpcs 脚本用于对 PHP、JavaScript 和 CSS 文件进行标记化，以检测违反定义的编码标准的违规行为，另一个 phpcbf 脚本用于自动纠正编码标准的违规行为。PHP_CodeSniffer 是一个必不可少的开发工具，确保您的代码保持清洁和一致性。

=> 文档：[https://github.com/squizlabs/PHP_CodeSniffer/wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki)

关于本项目

本项目基本上提供了一套预定义的 PHP 编码标准规则，可以按照以下描述使用和扩展。

安装

在 composer.json 文件中添加以下内容

添加仓库

"repositories": [
   {
      "type": "vcs",
      "url": "https://github.com/singularit-de/php-codesniffer-base-config.git"
   }
]

添加软件包

"require": {
   ...
   "singular-it/php-codesniffer-base-config": "dev-master"
   ...
},

运行 composer install 或 composer update 安装新的依赖项。

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

<?xml version="1.0"?>
<ruleset>
    <description>Project-specific ruleset</description>
    <rule ref="./vendor/singular-it/php-codesniffer-base-config/src/phpcs.xml"/>

    <!-- Add project-specific rules below -->
</ruleset>

或者，对于小于 8 的 PHP 版本，规则应如下所示： <rule ref="./vendor/singular-it/php-codesniffer-base-config/src/phpcs-before-php8.xml"/>

CLI 使用

您现在可以通过 vendor/bin/phpcs path/to/check 运行 phpcs，并且可以扩展 phpcs.xml 文件以添加项目特定的规则。
由于 PHP Codesniffer 还包括 "PHP 代码美化器与修复器"，您可以使用 vendor/bin/phpcbf path/to/fix 自动修复一些问题。

PhpStorm 设置

在此处找到官方描述：[https://www.jetbrains.com/help/phpstorm/using-php-code-sniffer.html](https://www.jetbrains.com/help/phpstorm/using-php-code-sniffer.html) 。基本上

在设置中，在 PHP > 质量工具 > PHP_Codesniffer 点击 "配置" 字段后面的三个点，这会打开一个单独的视图。在这里，您将找到 "PHP_CodeSniffer 路径" 字段和 "phpcbf 路径" 字段。phpcs 的路径应设置为类似以下内容 C:\...\vendor\bin\phpcs.bat，而 phpcbf 的路径应设置为类似以下内容 C:\...\vendor\bin\phpcbf.bat。
返回 PHP > 质量工具 > PHP_Codesniffer，选择 "自定义" 作为编码标准，这将导致出现一个输入字段。如果 "自定义" 选项不可用，请尝试关闭并重新打开设置。在此输入字段中输入您项目根目录中自己的 phpcs.xml 文件的路径。
转到 PHP > 质量工具 > 外部格式化器，并代码 PHP 代码美化器和修复器。

=> 现在您应该能够看到 IDE 的代码问题高亮显示，并且悬停应该提供修复选项，如果这些问题可以自动修复的话。

singular-it / php-codesniffer-base-config

维护者

详细信息