chiiya/laravel-code-style

Laravel项目的代码风格和质量配置

3.0.0 2024-06-06 09:04 UTC

README


Laravel代码风格

使用PHP-CS-Fixer、ECS和Rector的组合为Laravel项目配置代码风格。

Latest Version on Packagist GitHub Code Style Action Status Total Downloads

索引   ·   安装   ·   使用



索引

> Installation ..................................................................... 
> Usage ............................................................................ 

安装

使用Composer安装包。当提示创建GrumPHP配置文件时,选择“否”。

composer require chiiya/laravel-code-style --dev

使用

# Publish config files
php artisan vendor:publish --tag="code-style-config"

接下来,调整您项目文件夹中刚刚创建的ecs.php.php-cs-fixer.dist.phprector.phpphpstan.neon文件,以适应您的项目结构。

发布配置文件后,您可能需要重新初始化GrumPHP

php ./vendor/bin/grumphp git:deinit
php ./vendor/bin/grumphp git:init

GrumPHP配置默认包含PHP-CS-Fixer、ECS和TLint的任务。由于它们可能需要很长时间,因此不包括rectorphpstan的任务。您可以选择单独执行它们(例如,在CI管道中),或者如果可以接受较长的等待时间,可以将它们添加到GrumPHP配置中

grumphp.yml的示例

grumphp:
  tasks:
    # ...
    rector: ~
    phpstan: ~

CI配置的示例(在您的管道中的某个位置调用这些)

./vendor/bin/ecs check
./vendor/bin/php-cs-fixer fix --dry-run --diff
./vendor/bin/rector process --dry-run
./vendor/bin/tlint lint
./vendor/bin/phpstan analyse --memory-limit=2G