Weave Code
Coding Standard Laravel Package
pccomponentes/coding-standard
PcComponentes Coding Standard adds PHP_CodeSniffer sniffs to enforce consistent PHP style. Install via Composer as a dev dependency and reference vendor/pccomponentes/coding-standard/src/ruleset.xml in your phpcs.xml(.dist) to apply the rules.
At a glance
Frequently asked questions about Coding Standard
- How do I install PcComponentes Coding Standard in a Laravel project?
- Run `composer require --dev pccomponentes/coding-standard` to add it as a dev dependency. Then reference the ruleset in your `phpcs.xml.dist` file by adding `<rule ref="vendor/pccomponentes/coding-standard/src/ruleset.xml" />` under your ruleset configuration.
- Does this package conflict with Laravel’s built-in coding standards?
- The package is designed to complement, not override, existing standards like PSR-12. However, run a test with `./vendor/bin/phpcs --standard=pccomponentes` on your Laravel codebase first to check for conflicts, especially in naming conventions or controller/service patterns.
- Which Laravel versions does PcComponentes Coding Standard support?
- The package requires PHP 8.0+, which aligns with Laravel 8+. It won’t work with older Laravel versions (e.g., 7.x) without manual adjustments, but it integrates cleanly into modern Laravel projects using PHP_CodeSniffer.
- Can I selectively enable or disable specific sniffs?
- Yes, the package is modular. In your `phpcs.xml.dist`, you can override individual sniffs by specifying `<rule ref="vendor/pccomponentes/coding-standard/src/ruleset.xml">` and then excluding or including specific rules using `<exclude>` or `<include>` tags.
- Will this slow down my CI/CD pipeline for Laravel?
- It may introduce minor overhead, especially for large codebases. Test performance with `phpcs --report=summary` and consider running it in parallel with other tasks or as a pre-commit hook to avoid blocking deployments.
- Are there alternatives to PcComponentes Coding Standard for Laravel?
- Yes, alternatives include PHPStan (for static analysis), Laravel’s built-in `phpcs.xml.dist` (PSR-12), or custom PHP_CodeSniffer rulesets. However, PcComponentes offers pre-defined sniffs tailored for consistency beyond PSR-12, making it ideal for teams needing stricter conventions.
- How do I handle false positives or rule disputes in a Laravel team?
- Document exceptions in your `phpcs.xml.dist` using `<exclude>` tags for specific files or classes. For team disputes, establish a code review process where violations can be discussed and temporarily ignored if justified, then re-enabled later.
- Does this package work with Laravel’s IDE helpers (e.g., PHPStorm or VSCode)?
- Yes, since it integrates with PHP_CodeSniffer, it will work with IDE plugins like PHPStorm’s built-in sniffer or VSCode extensions. Configure your IDE to use the `phpcs.xml.dist` file for real-time feedback during development.
- What should I do if the package stops receiving updates?
- Fork the repository and maintain it yourself, or migrate critical rules to a custom PHP_CodeSniffer ruleset. The package’s sniffs are modular, so extracting and redefining them in your own `ruleset.xml` is straightforward.
- Can I use this for Laravel migrations or service container checks?
- Yes, the package’s sniffs can enforce custom naming conventions for migrations (e.g., `YYYY_MM_DD_` prefixes) or service container bindings. Extend the ruleset by adding Laravel-specific patterns in your `phpcs.xml.dist` to target these files.
Weaver
How can I help you explore Laravel packages today?