martingold/coding-standard

基于 slevomat/coding-standard 的编码标准

维护者

详细信息

github.com/martingold/coding-standard

源代码

问题

安装: 266

依赖: 2

建议: 0

安全: 0

星标: 1

关注者: 2

分支: 0

开放问题: 1

1.0.1 2019-03-27 09:41 UTC

Requires (Dev)

MIT 2.0 a6ad408b05a5538240522bdb1ff99d1818f6a5ed

  • Martin Gold <martin.gold.woop@volny.cz>

This package is auto-updated.

Last update: 2024-09-27 22:06:34 UTC

README

安装

composer require \
    martingold/coding-standard \
    slevomat/coding-standard \
    consistence/coding-standard --dev

然后运行编码标准，例如

php vendor/bin/phpcs --standard=vendor/martingold/coding-standard/src/coding-standard.xml --extensions=php --tab-width=4 -sp app

太难记了？

这个命令似乎每次都要输入很多，我们可以利用 composer 脚本加速工作流程。将以下配置添加到您的 composer.json 文件中。

"scripts": {
    "phpcs": "php vendor/bin/phpcs --standard=vendor/martingold/coding-standard/src/coding-standard.xml --extensions=php --tab-width=4 -sp src",
    "phpcbf": "php vendor/bin/phpcbf --standard=vendor/martingold/coding-standard/src/coding-standard.xml --extensions=php --tab-width=4 -sp src",
    "lint": "php vendor/bin/parallel-lint src",
    "phpstan": "php vendor/phpstan/phpstan/bin/phpstan analyse src -l 7 -c phpstan.neon",
    "style": [
      "@lint",
      "@phpcs",
      "@phpstan"
    ]
}

然后我们可以只输入 composer style 来检查 PHP 语法错误，并检查代码是否符合编码标准要求。语法错误检查使用 JakubOnderka/PHP-Parallel-Lint 进行，您需要在想使用此示例时安装它。强烈建议运行 PHPStan 分析以检查意外的行为。这是一个非常方便的工具，可以捕捉代码中的低垂果实错误。

使用此编码标准的代码示例

代码示例可以在 src/Person.php 中找到。