amitchandrakar/php_standard

应遵循的PHP编码规范

维护者

详细信息

github.com/amitchandrakar/PHPStandards

来源

问题

安装: 17

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

公开问题: 0

类型:php-code-sniffer

1.1 2021-07-19 05:19 UTC

Requires

MIT 64aa6c2109733f2bb8d061ed6641dbb0deea13ff

  • Amit Chandrakar <amitchandrakar028.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-19 12:31:51 UTC

README

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

安装

使用composer全局安装此存储库

composer global require amitchandrakar/php_standard

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

设置

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

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

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

  • ruleset.xml - 适用于CodeSniffer
  • rulesetmd.xml - 适用于MessDetector

归属

此存储库中的一些sniffs来自原始PHP_CodeSniffer项目。对于那些的贡献归功于相应的开发者。

VS Code 设置

安装 PHP Sniffer 扩展，由 wongjn 提供

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

对于Mac

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

对于Linux

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

对于Windows

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

N|Solid

检查

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

修复

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

忽略文件

// @codingStandardsIgnoreFile

// phpcs:ignoreFile

忽略行

// @codingStandardsIgnoreLine

// phpcs:ignore

忽略块

// @codingStandardsIgnoreStart

// phpcs:disable

// @codingStandardsIgnoreEnd

// phpcs:enable