Rector Laravel 项目使用教程

1. 项目的目录结构及介绍

Rector Laravel 项目的目录结构如下：

rector-laravel/
├── docs/
│   └── rector_rules_overview.md
├── src/
│   ├── Set/
│   │   └── LaravelSetList.php
│   └── ...
├── .gitignore
├── composer.json
├── LICENSE
├── README.md
└── ...

目录结构介绍

• docs/: 包含项目的文档文件，如 rector_rules_overview.md。
• src/: 包含项目的源代码，如 Set/LaravelSetList.php。
• .gitignore: Git 忽略文件列表。
• composer.json: Composer 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

Rector Laravel 项目的启动文件主要是 composer.json 和 src/Set/LaravelSetList.php。

composer.json

composer.json 文件是 Composer 的配置文件，用于定义项目的依赖关系和其他配置。以下是部分内容：

{
    "require": {
        "php": "^7.2 || ^8.0",
        "rector/rector": "^1.0"
    },
    "require-dev": {},
    "suggest": {},
    "autoload": {
        "psr-4": {
            "RectorLaravel\\": "src/"
        }
    }
}

src/Set/LaravelSetList.php

src/Set/LaravelSetList.php 文件定义了 Laravel 项目的升级规则。以下是部分内容：

<?php

declare(strict_types=1);

namespace RectorLaravel\Set;

use Rector\Config\RectorConfig;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->sets([
        __DIR__ . '/../../config/sets/laravel-code-quality.php',
        __DIR__ . '/../../config/sets/laravel-collection.php',
    ]);
};

3. 项目的配置文件介绍

Rector Laravel 项目的主要配置文件是 rector.php，该文件用于配置 Rector 的规则和设置。

rector.php

rector.php 文件通常位于项目的根目录，以下是一个示例配置：

<?php

declare(strict_types=1);

use Rector\Config\RectorConfig;
use RectorLaravel\Set\LaravelSetList;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->sets([
        LaravelSetList::LARAVEL_CODE_QUALITY,
        LaravelSetList::LARAVEL_COLLECTION,
    ]);
};

配置文件介绍

• sets: 定义了要应用的规则集，如 LaravelSetList::LARAVEL_CODE_QUALITY 和 LaravelSetList::LARAVEL_COLLECTION。

通过以上配置，可以自动化地升级和优化 Laravel 项目。