通过
搜索
搜索youwe / coding-standard
尤维PHP编码规范
3.6.1
2024-02-05 21:46 UTC
Requires
- php: ^7.0 || ^8.0
- dealerdirect/phpcodesniffer-composer-installer: ^0.7.2 || ^1.0
- phpmd/phpmd: ^2.0
- squizlabs/php_codesniffer: ^3.9.0
- dev-master
- 3.6.1
- 3.6.0
- 3.5.1
- 3.5.0
- 3.5.0-RC2
- 3.5.0-RC1
- 3.4.0
- 3.4.0-RC1
- 3.3.1
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.2
- 3.0.1
- 3.0.0
- 2.0.6
- 2.0.5
- 2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 1.9.1
- 1.9.0
- 1.8.0
- 1.7.1
- 1.7.0
- 1.6.3
- 1.6.2
- 1.6.1
- 1.6.0
- 1.5.0
- 1.4.1
- 1.4.0
- 1.3.9
- 1.3.8
- 1.3.7
- 1.3.6
- 1.3.5
- 1.3.4
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.1
- 1.2.0
- 1.1.0
- 1.0.0
- dev-array-indent
- dev-namespace-use-statements
This package is auto-updated.
Last update: 2024-09-06 18:40:15 UTC
README
这是尤维编码规范，它包含PHPCS和PHPMD的规则集。
安装
使用composer在主目录中安装编码规范。
composer global require youwe/coding-standard
配置PHPStorm使用编码规范。
首先配置PHPStorm使用正确的phpcs命令。
转到设置 > 语言和框架 > PHP > 代码检查器。选择“本地”作为路径，并填写~/.config/composer/vendor/bin/phpcs的完整路径。
然后转到设置 > 编辑器 > 检查，搜索PHP代码检查器验证。选择自定义并添加~/.config/composer/vendor/youwe/coding-standard/src/Youwe的路径。
在项目中使用编码规范
要在项目中使用标准，需要在composer中要求该标准。
cd <project_directory> composer require youwe/coding-standard --dev
这将把编码规范添加到项目的供应商目录中。
要允许phpcs使用编码规范，在项目的根目录中添加一个名为phpcs.xml的文件。
<?xml version="1.0"?> <ruleset> <rule ref="./vendor/youwe/coding-standard/src/Youwe"/> </ruleset>
可以通过进入目录从命令行检查标准。
cd <project_directory> ./vendor/bin/phpcs ./src
配置PHP CodeSniffer以显示更严重的信息
默认情况下，PHP CodeSniffer仅显示严重性高于5的消息。尤维编码规范也有一些严重性较低的消息。这些是鼓励更好的编码方式的提示，但不应阻止拉取请求。
要配置phpcs以显示这些消息，请执行以下命令。
~/.config/composer/vendor/bin/phpcs --config-set severity 1