twc/code-quality-plugin
Composer 安装命令:
composer require twc/code-quality-plugin
包简介
pre-configure fixer and analyse code quality
README 文档
README
Plugin composer permettant la mise en place d'outils pour une analyse qualité et respect des standards sur un projet symfony.
Pré-requis
- git >=2.17
- symfony (website-skeleton) >=4.4 ou symfony >=4.4 (skeleton) avec le pack symfony/test-pack
- composer 2.x
Installation
composer require twc/code-quality-plugin --dev
If you use composer v1.x try
composer require twc/code-quality-plugin:^1.0 --dev
Après l'installation plusieurs élements auront été créés.
| Type | Libelle | Def |
|---|---|---|
| Dossier | quality | Permet de configurer les standards et règles qualités sur votre projet |
| Fichier | Makefile | Ajoute des recettes |
Utilisation
Une fois installé lors de vos commits les actions suivantes seront réalisées.
- Fix du code avec php cs fixer
- Fix du code avec php code sniffer
- Analyse statique du code avec phpstan
La moindre erreur arrête le process de commit pour que vous puissiez fixer le problème.
Makefile
Lors de l'installation un Makefile sera créé s'il n'est pas présent, ou une liste de recettes seront ajoutées à votre Makefile s'il existe.
include vendor/twc/code-quality-plugin/make/quality.mk
Liste des recettes du Makefile
| Make | Def |
|---|---|
| make twc.stan | Lance une analyse statique avec phpstan |
| make twc.fixer | Fix les standards avec php-cs-fixer |
| make twc.fix | Fix les standards avec php-code-sniffer |
| make twc.rules | Retourne les erreurs suites au non respect des standards php-cs |
| make twc.test | Lancer les tests avec phpunit |
Commandes
Ce composant étant un plugin composer, plusieurs commandes sont disponibles.
| Commande | Def |
|---|---|
| composer twc:make:install | Installe un Makefile ou ajoute une extension pour bénéficier des recettes du composant |
| composer twc:hooks:install | Installe des hooks Git à votre projet |
| ↘ --mode=force | Ecrase vos hooks s'ils existent |
| ↘ --only-hook=pre-commit | Installe un hook pre-commit à votre projet |
| ↘ --only-hook=commit-msg | Installe un hook commit-msg à votre projet |
| composer twc:quality:install | Installe un dossier de configuration nommé quality à la racine de votre projet |
| ↘ --mode=force | Ecrase le dossier quality s'il existe |
| composer twc:commit:force "MSGCOMMIT" | Permet de désactiver le temps du commit les règles et analyses qualités. (A utiliser en cas de force majeure) Votre MSGCOMMIT sera préfixé [commit-forced] |
twc/code-quality-plugin 适用场景与选型建议
twc/code-quality-plugin 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 1.49k 次下载、GitHub Stars 达 3, 最近一次更新时间为 2020 年 01 月 15 日, 在 PHP 生态内属于活跃度较高的组件。
我们在过去多个企业项目中使用过 twc/code-quality-plugin 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。
基于 twc/code-quality-plugin 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。
统计信息
- 总下载量: 1.49k
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 3
- 点击次数: 6
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2020-01-15