通过以下链接搜索：
consistence / coding-standard
一致性 - 编码规范 - PHP 代码规范规则
3.10.1
2020-04-17 14:43 UTC
Requires
- php: ~7.1
- slevomat/coding-standard: ~6.0
- squizlabs/php_codesniffer: ~3.5.5
Requires (Dev)
- jakub-onderka/php-console-highlighter: 0.4
- jakub-onderka/php-parallel-lint: 1.0
- phing/phing: 2.16.1
- phpunit/phpunit: 7.5.1
- dev-master
- 3.10.1
- 3.10
- 3.9
- 3.8
- 3.7
- 3.6
- 3.5
- 3.4
- 3.3.1
- 3.3
- 3.2
- 3.1
- 3.0.1
- 3.0
- 2.4
- 2.3.1
- 2.3
- 2.2.1
- 2.2
- 2.1
- 2.0
- 1.1
- 1.0
- 0.13
- 0.12
- 0.11.1
- 0.11
- 0.10.1
- 0.10
- 0.9
- 0.8
- 0.7
- 0.6
- 0.5
- dev-dependabot/github_actions/coverallsapp/github-action-2.2.0
- dev-dependabot/github_actions/actions/checkout-3.5.3
- dev-dependabot/github_actions/shivammathur/setup-php-2.25.3
- dev-mutli-definitions
- dev-dev-3.x
This package is auto-updated.
Last update: 2024-09-12 16:45:54 UTC
README
完整的规范描述在单独的文档中.
这是一个自定义编码规范，由所有 Consistence 项目使用。它也适合与其他项目一起使用，或作为您自己标准的基石。
本标准的 主要目标包括
- 严格（且可预测）的代码。
- 防止常见错误。
- 可读性高于可写性（字符计数）。
- 友好地对待差异 - 最小化更改的影响。
- 不要编写不必要的/不可靠的信息。
自动检查
本标准的自动检查是通过为 PHP_CodeSniffer (phpcs) 实现的嗅探器，但并非所有规则都已检查。PHP_CodeSniffer 还包含自动修正某些错误的工具 phpcbf，但此工具也不完全可靠 - 由它产生的结果可能不符合此标准。
这些检查还包括一些代码分析工具，如检测不可达代码等。这些不是标准的一部分，但可能很有帮助。
稳定性
本软件包使用以下规则使用 SemVer。
Coding Standard 文档应被视为 SemVer 的真理来源和主要对象。
- 如果向文档中添加了新规则，则将增加
MAJOR版本。 - 如果为检查现有描述的规则实现了新嗅探器，则将增加
MINOR版本。 - 为修复错误 - 修复错误被视为不符合文档的一切 - 这甚至可能导致（暂时）禁用一个现有的嗅探器或其部分，直到有更好的检查可用或正确修复。
自动检查的实现（自定义嗅探器和 ruleset.xml 文件）不受 SemVer 的约束，并且可能随着时间的推移而变化，以适应 PHP_CodeSniffer 和提供的默认嗅探器的变化，这些嗅探器也由本标准使用。
本软件包的推荐依赖项是 MINOR 版本（例如 ~1.0.0），这意味着实际上
- 不会添加新规则。
- 可能会添加新的自动检查。
- 您将获得现有自动检查的修复，或者如果发现回归，则其中一些可能被禁用。
安装与使用
使用 Composer 安装软件包 consistence/coding-standard
composer require --dev consistence/coding-standard
然后使用此标准运行 phpcs
vendor/bin/phpcs --standard=vendor/consistence/coding-standard/Consistence/ruleset.xml --extensions=php --encoding=utf-8 -sp src
有关进一步的使用选项，请参阅 PHP_CodeSniffer 文档。