tigitz/phpcs

官方 Geolid 编码标准，支持 php7.1。

维护者

详细信息

github.com/tigitz/phpcs

主页

源代码

安装: 254

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 3

8.0.0 2019-01-20 13:11 UTC

Requires

MIT dac5635bf934c01df9edca96cc336c1dba4da9a9

standardsphpcsCoding Style

This package is auto-updated.

Last update: 2024-09-21 02:56:49 UTC

README

composer require --dev tigitz/phpcs

您只需要此包，无需手动要求 squizlabs/php_codesniffer。

require 之后，将以下文件复制到您的路径中： phpcs.xml.dist 并将其重命名为 phpcs.xml，或者在现有的 phpcs.xml 中添加以下规则。

<rule ref="./vendor/tigitz/phpcs/src/Geolid/ruleset.xml" />

用法

通常使用 phpcs。

vendor/bin/phpcs

描述

我们遵循 PSR-2 编码风格，并添加了额外的规则。

附加规则

  • 私有方法和属性不得以下划线开头。
  • 在连接操作符周围有一个空格。
  • 在类型转换操作符后有一个空格。
  • 数组必须使用短语法。
  • 尾随逗号：多行数组必须在所有行中都有逗号。
  • 不允许超过 3 个嵌套缩进级别。
  • 命名（函数、变量、常量等）的最小长度是 3 个字符（i、id、em、om、to、ID、TO 除外）。
  • 对象实例化必须始终使用括号。
  • 必须在返回语句之前有一个空行。
  • 必须在返回类型提示之前有一个空格。
    public function foo(): self {}
  • PHP 必须包含 declare(strict_types=1);，并在声明和 PHP 开头标签之间有一个空行。
  • 必须在所有常量上声明可见性（PSR-12）。
  • 不允许有未使用的导入（use 语句）。

命名

  • 除了 PHPUnit *TestCase 的名称外，所有抽象类都必须以前缀 Abstract 开头。（目前无法检测空抽象类的名称）。
  • 接口后缀为 Interface。
  • 特质后缀为 Trait。
  • 异常后缀为 Exception。

测试

composer test