qubus/coding-standard

Qubus 编码标准

维护者

详情

github.com/QubusPHP/qubus-coding-standard

源代码

问题

安装: 3

依赖: 0

建议者: 0

安全: 0

星标: 2

关注者: 1

分支: 0

开放问题: 0

类型:phpcodesniffer-standard

v1.1.0 2022-09-26 15:34 UTC

Requires

MIT 442827fb9e5ebc52d58047643d8fbd00162d3ed2

Coding Standardqubus

This package is auto-updated.

Last update: 2024-08-26 19:37:42 UTC

README

QubusPHP 编码标准的规则集。

QubusPHP 编码标准大致遵循Laminas 编码风格指南，但有少量例外

  1. 抽象类不得以前缀或后缀形式使用Abstract。
  2. 特质不得以前缀或后缀形式使用Trait。
  3. 接口不得以前缀或后缀形式使用Interface或Contract。
  4. 异常必须后缀为Exception。
  5. 类的文件名必须使用PascalCase。
  6. 函数的文件名必须使用小写字母，并且可以用_分隔。
  7. 自定义函数必须是命名空间化的，并在使用时导入。
  8. 类必须按照接口编写，并遵循SOLID原则。

安装

  1. 将编码标准作为项目依赖项安装
$ composer require --dev qubus/qubus-coding-standard
  1. 将编码标准添加到PHP_CodeSniffer的安装路径
 vendor/bin/phpcs --config-set installed_paths vendor/qubus/qubus-coding-standard
  1. 运行标准
 vendor/bin/phpcs /path/to/code