mrchetan/php_standard

遵循的PHP编码规范

维护者

详细信息

github.com/mrchetan/PHPStandard

源代码

问题

资助包维护！
mr-chetan

安装: 300

依赖项: 1

建议者: 0

安全: 0

星星: 6

关注者: 3

分支: 2

公开问题: 0

类型:php-code-sniffer

4.1.1 2024-07-18 08:10 UTC

Requires

MIT fc6e7f1c014e8fd74147e564481d283ccff1224a

  • Chetan <contact.woop@mrchetan.com>

This package is auto-updated.

Last update: 2024-09-18 08:39:18 UTC

README

此存储库包含用于 PHP CodeSniffer 和 PHP Mess Detector 的规则集，以及一些自定义规则。

安装

使用以下composer命令全局安装此存储库

composer global require mrchetan/php_standard

始终使用存储库的最新版本。

设置

项目将安装在您PC上的全局composer文件夹中。

  • Mac: 您家目录中的 .composer/vendor 文件夹
  • Windows: 您用户目录中的 AppData/Roaming/Composer/vendor 文件夹
  • Ubuntu: 您家目录中的 .config/composer/vendor 文件夹

您可以根据您最喜欢的IDE的步骤配置PHP CodeSniffer和PHP MessDetector，并将安装文件夹中的两个规则集指向它们。

  • ruleset.xml - 用于CodeSniffer

归属

此存储库中的一些嗅探器是从原始PHP_CodeSniffer项目派生出来的。对这些嗅探器的认可归功于相应的开发者。

VS Code 设置

安装 PHP Sniffer 扩展，扩展名称为 wongjn

N|Solid 激活后，将以下文件添加到settings.json文件中

对于Mac

"phpSniffer.standard": "~/.composer/vendor/mrchetan/php_standard/ruleset.xml",

对于Linux

"phpSniffer.standard": "~/.config/composer/vendor/mrchetan/php_standard/ruleset.xml",

对于Windows

"phpSniffer.standard": "%userprofile%/AppData/Roaming/Composer/vendor/mrchetan/php_standard/ruleset.xml",

检查

phpcs --standard=<PATH_OF_RULESET> <SPACE> <PATH_OF_FILEs_CHECK>

例如

phpcs --standard=~/.composer/vendor/mrchetan/php_standard/ruleset.xml index.php

修复

phpcbf --standard=<PATH_OF_RULESET> <SPACE> <PATH_OF_FILEs_CHECK>

忽略文件

// @codingStandardsIgnoreFile

// phpcs:ignoreFile

忽略行

// @codingStandardsIgnoreLine

// phpcs:ignore

忽略块

// @codingStandardsIgnoreStart

// phpcs:disable

// @codingStandardsIgnoreEnd

// phpcs:enable