mediatis/coding-standards

Mediatis - 编码标准

1.1.5 2024-09-25 15:13 UTC

README

安装

请确保您已经删除了旧代码质量以及流水线配置文件或文件夹,例如 rector.php.php-cs-fixer.php.phpstan 等。

请确保您的 composer.json 文件中没有对显式代码质量包的任何开发依赖项(如 phpunit/phpunitrector/rector 等)。

请确保您的 .gitignore 文件包括 vendor 文件夹和 composer.lock 文件。

vendor
composer.lock

安装编码标准包。

composer require --dev --with-all-dependencies mediatis/coding-standards

运行启动脚本以安装配置文件。

./vendor/bin/mediatis-coding-standards-setup

通常合并的文件(大多是 CI 配置)可以使用 reset 参数重置并覆盖。例外的是 composer.json 文件,它总是合并。

./vendor/bin/mediatis-coding-standards-setup reset

用法 - 检查

运行所有检查

composer ci

运行分组检查

# all php tests and code quality checks
composer ci:php

# all php tests
composer ci:php:tests

# all php code quality checks
composer ci:php:static

# all composer-related checks
composer ci:composer

运行特定检查

composer ci:composer:normalize
composer ci:composer:psr-verify
composer ci:composer:validate
composer ci:php:lint
composer ci:php:rector
composer ci:php:cs-fixer
composer ci:php:stan
composer ci:php:tests:unit
composer ci:php:tests:integration

用法 - 修复

运行所有修复

composer fix

运行分组修复

composer fix:php
composer fix:composer

运行特定修复

composer fix:php:rector
composer fix:php:cs
composer fix:composer:normalize