perceptiontech/php-coding-standard

与 PHPCodeSniffer 一起使用的 PHP 编码标准

安装: 8

依赖项: 0

建议者: 0

安全性: 0

星星: 0

关注者: 2

分支: 0

开放问题: 0

类型:phpcodesniffer-standard

0.0.2 2019-03-08 09:12 UTC

This package is auto-updated.

Last update: 2024-09-08 23:01:30 UTC


README

此标准遵循 (Symfony 标准)[https://symfony.com.cn/doc/current/contributing/code/standards.html],但有以下例外

  • 它不需要在每个文件顶部添加许可证。
  • 它允许使用多行函数参数。

安装步骤

  1. 安装 PHP CodeSniffer: https://github.com/squizlabs/PHP_CodeSniffer#installation

  2. 使用 composer 全局要求包

    $ composer global require "perceptiontech/php-coding-standard"
  3. 将编码标准添加到 PHP_CodeSniffer 安装路径(在 MacOS 和 Linux 下)

    $ phpcs --config-set installed_paths ~/.composer/vendor/perceptiontech/php-coding-standard

    请注意,如果您已安装路径,它们将被丢失。如果是这样,您将必须执行

    $ phpcs --config-set installed_paths ~/.composer/vendor/perceptiontech/php-coding-standard,/path/to/already/insatlled/standard/
  4. 检查已安装的标准以查找 "Perception"

    $ phpcs -i

PHPStorm 配置

Code_Sniffer 配置

  1. 转到质量工具,展开 Code Sniffer 选项,通过单击 ... 来切换配置

    PHPStorm CodeSniffer configuration

  2. 设置您本地 PHPCode_Sniffer 二进制的路径并验证它

    PHPStorm CodeSniffer binary

规则集配置

  1. 转到编辑器 > 检查 > PHP > 质量工具 > PHP Code Sniffer 验证

    PHPStorm CodeSniffer insepctions

  2. 启用配置,刷新 "编码标准" 并选择 "Perception"。配置应如下所示

    PHPStorm CodeSniffer insepctions

    (注意:将严重性设置为 "警告"。否则,在编辑器中很难发现错误)

  3. 在此配置之后,PHPStorm 应该会在代码不符合规则时通知您

    PHPStorm CodeSniffer insepctions