pd/coding-standard

PeckaDesign编码标准


README

Soupis firemního coding standardu pro PHP programátory v nástroji PHP CodeSniffer.

如何在您的项目中开始使用

每个发布版本都包含新的规则。建议从版本1.0.0开始,根据发现的错误和警告逐步提高版本。

可以通过composer轻松地将支持添加到项目中

$ composer require pd/coding-standard --dev

CI服务器会在项目的Makefile包含目标cs时启动检查

$ cat Makefile
cs:
	- vendor/bin/phpcs app/ --standard=vendor/pd/coding-standard/src/PeckaCodingStandard/ruleset.xml --report-file=output.cs

本地可以通过make cs或使用命令启动检查

vendor/bin/phpcs app/ --standard=vendor/pd/coding-standard/src/PeckaCodingStandard/ruleset.xml -p

输出

在CI服务器上启动后,在GitHub上会出现结果摘要,在Details下是PHP CS工具的完整输出

Vzorový výstup na GitHubu

将CodeSniffer集成到PhpStorm中

说明文档可在文档中找到.