Weave Code
Rector Config Laravel Package
mll-lab/rector-config
Shared Rector configuration from mll-lab for standardizing automated PHP refactoring and code upgrades across projects. Install it to apply a consistent, maintained ruleset without copying boilerplate config between codebases.
Shared configuration for rector
Frequently asked questions about Rector Config
- What is mll-lab/rector-config used for?
- mll-lab/rector-config is a Composer package that provides a shared Rector configuration from mll-lab. It helps standardize automated PHP refactoring and code upgrades across projects so you do not copy the same ruleset boilerplate into every repository. It is typically used as a development dependency alongside Rector.
- How do I install mll-lab/rector-config?
- Install it as a development dependency with composer require --dev mll-lab/rector-config. You also need Rector available in the project, since this package supplies configuration rather than the Rector executable itself. After installation, reference the shared config from your rector.php file as documented.
- How do I use the shared config in my rector.php file?
- In your project's rector.php, import or reference the configuration provided by mll-lab/rector-config, then add your own paths and any project-specific overrides. The exact include or setup line depends on the package version, so follow the README for the release you installed. Keeping the shared config in version control makes refactoring behavior reproducible.
- Does mll-lab/rector-config work with Laravel projects?
- Yes, it can be used in Laravel projects because Rector operates on PHP source code, including Laravel application and package code. The shared ruleset is aimed at standardizing refactoring, but you should still review rules that may affect framework-specific patterns. Run Rector on a branch and inspect diffs before merging.
- Which Laravel versions are supported by mll-lab/rector-config?
- Laravel version support is not determined by this config package alone; it depends on the Rector version and rules you enable, plus your project's PHP constraints. Check the package's composer.json and README for current PHP and dependency requirements. Test the ruleset against your Laravel version in a non-production branch first.
- Can I customize or override the shared Rector rules?
- You can customize the shared configuration by adding project-specific rules, skips, or path settings in your local rector.php after including the package config. Rector configurations are PHP code, so you can override or extend behavior as needed. Avoid editing vendor files; keep overrides in your repository.
- Do I need to install Rector separately to use this package?
- Yes, mll-lab/rector-config supplies configuration, not the Rector binary. You normally install Rector as a development dependency and then load this shared config from your rector.php. Check the package requirements for compatible Rector versions.
- Is mll-lab/rector-config suitable for CI/CD pipelines?
- Yes, a shared Rector config works well in CI because it gives every pipeline the same refactoring rules. A common pattern is to run Rector in dry-run mode on pull requests and fail if changes are suggested. Use a pinned package version so CI results stay stable.
- What are alternatives to using a shared Rector config package?
- Alternatives include maintaining your own rector.php ruleset, using Rector's built-in sets directly, or adopting another organization's shared config package. A shared package like this reduces duplication and centralizes maintenance. Choose based on how closely the ruleset matches your coding standards.
- How should I manage mll-lab/rector-config updates in production projects?
- Treat it like any development dependency: pin a compatible version in composer.json and review changelogs before upgrading. Because Rector rules can change code, run upgrades on a branch and validate with tests. If the package is not actively maintained, you can fork it or copy the config into your project.
Weaver
How can I help you explore Laravel packages today?