qubus/qubus-coding-standard

Qubus 编码规范

维护者

详细信息

github.com/QubusPHP/qubus-coding-standard

源代码

问题

安装: 55

依赖项: 22

建议者: 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 20:02:57 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