froiden/php_standard

Froiden公司应遵循的PHP编码标准

维护者

详细信息

github.com/Froiden/PHPStandard

源码

问题

安装: 206

依赖: 0

建议者: 0

安全性: 0

星标: 5

关注者: 5

分支: 0

开放问题: 0

类型:php-code-sniffer

v2.0.2 2024-06-06 07:45 UTC

Requires

MIT 65cee9cc821f5c2949795df4c5d4c2b05e8bb9ac

  • Shashank Jain <shashank.woop@froiden.com>

This package is auto-updated.

Last update: 2024-09-06 08:23:16 UTC

README

此仓库包含用于 PHP CodeSniffer 和 PHP Mess Detector 的规则集和一些自定义规则。这些标准在 Froiden (www.froiden.com) 内部遵循。

安装

使用composer全局安装此仓库

composer global require froiden/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项目中派生出来的。对这些sniffs的认可归功于相应的开发者。

VS Code设置

安装 PHP Sniffer 扩展，由 wongjn 提供

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

对于Mac

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

对于Linux

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

对于Windows

"phpSniffer.standard": "%userprofile%/AppData/Roaming/Composer/vendor/froiden/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