Larastan 自定义配置参数：如何根据项目需求调整分析行为

Larastan 是专为 Laravel 项目设计的强大静态分析工具，通过自定义配置参数可以精准调整分析行为。对于 Laravel 开发者来说，掌握这些参数配置是提升代码质量的关键步骤。🚀

为什么要自定义 Larastan 配置参数？

每个 Laravel 项目都有其独特的架构和需求，标准配置可能无法完全适应。自定义配置参数让您能够：

• 精准控制分析范围：只关注真正重要的代码
• 优化性能：避免不必要的文件扫描
• 适应复杂场景：处理多模块、多数据库等复杂架构

核心配置参数详解

数据库迁移路径配置

默认情况下，Larastan 会扫描 database/migrations 目录来理解表结构和模型属性。如果您的迁移文件存储在其他位置，可以使用 databaseMigrationsPath 参数：

parameters:
    databaseMigrationsPath:
        - app/Domain/DomainA/migrations
        - app/Domain/DomainB/migrations

禁用迁移扫描

对于不需要数据库结构分析的项目，可以禁用迁移扫描以提升性能：

parameters:
    disableMigrationScan: true

压缩迁移路径配置

Larastan 默认会检查 database/schema 目录查找模式转储。如果您有其他位置或多个文件夹，可以使用：

parameters:
    squashedMigrationsPath:
        - app/Domain/DomainA/schema
        - app/Domain/DomainB/schema

模型属性检查

启用模型属性检查可以帮助发现传递给方法的模型属性问题：

parameters:
    checkModelProperties: true

实用配置技巧

性能优化配置

对于大型项目，合理配置可以显著提升分析速度：

• 禁用不必要的扫描功能
• 指定精确的路径范围
• 根据项目阶段调整检查级别

多模块项目配置

处理包含多个域或模块的项目时，使用路径数组来包含所有相关目录：

parameters:
    databaseMigrationsPath:
        - modules/User/migrations
        - modules/Product/migrations
        - modules/Order/migrations

最佳实践建议

1. 渐进式配置：从基本配置开始，逐步添加复杂规则
2. 团队协作：确保配置在团队成员间保持一致
3. 版本控制：将配置文件纳入版本控制

通过合理配置 Larastan 参数，您可以让这个强大的工具更好地为您的 Laravel 项目服务，实现更高效的代码质量检查！✨

相关配置文件：docs/custom-config-parameters.md