2latlantik/symfony-my-cs

此包最新版本（dev-master）没有可用的许可证信息。

我为Symfony项目定制的编码规范

维护者

详细信息

github.com/2latlantik/symfony-my-cs

源代码

问题

安装: 134

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

语言:Shell

dev-master 2018-04-05 11:21 UTC

Requires

Unknown License e53addc928b56671623ecddb13fc319e6959dbec

  • Nicolas <nicolascoudenne.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-22 03:42:57 UTC

README

此库的目标是收集一系列流程，以维护我symfony项目的良好代码质量。未能遵守某些良好实践将阻止git提交的考虑。

我结合了使用不同的库来批准git提交，这些库包括

  • PHP-Lint（一个分析PHP代码并返回使用错误的工具）
  • PHP-CS（一个用于控制遵守PSR2标准的工具）
  • PHP-CS-FIXER（一个用于控制遵守多个编码规范的工具）

还可以使用PHP Mess Detector来进一步细化对中明确性和错误倾向代码的检测

需求

  • 在Symfony4项目中使用
  • 在具有Git版本控制的项目中使用

安装和使用

I - 安装此库的过程

要能够安装不同的代码验证流程，您必须将这些行放入composer.json文件中。

"scripts" : {
    "my-cs-install": [
        "SymfonyMyCs\\Git\\Hooks\\PostInstall::installHooks"
    ] 
}

然后，您可以通过以下命令运行安装脚本

composer run-script my-cs-install

II - 安装Symfony代码质量可执行文件

Symfony创建了自己的代码解析器，并将其命名为http://cs.sensiolabs.org/。

您必须安装它才能允许验证您的提交。

III - 库操作的主要时刻

在git提交时

PHP Lint和PHPCS检查错误，并可能阻止提交。然后php-cs-fix修复仍然存在的问题。因此，验证过的提交是由所有人都认可的标准的PHP代码组成的。

执行PHPMD以进一步提高代码质量

./vendor/bin/phpmd src/Controller/ [format] phpmd

格式：xml|text|html

许可证

此项目在MIT许可证下授权 - 有关详细信息，请参阅LICENSE.md文件。