Weave Code
Coding Standard Laravel Package
chaplean/coding-standard
Chaplean Coding Standard provides a ready-to-use PHP_CodeSniffer ruleset for consistent PHP and Laravel code style. Drop-in configuration to enforce formatting, naming conventions, and best practices across your project and CI.
Chaplean coding standards
Frequently asked questions about Coding Standard
- How do I install Chaplean Coding Standard for my Laravel project?
- Run `composer require --dev chaplean/coding-standard` to add it as a dev dependency. No Laravel-specific setup is needed—it integrates directly with PHP_CodeSniffer. Configure it in your `phpcs.xml` by setting `<config name="standard" value="Chaplean"/>` or use the CLI flag `--standard=chaplean`.
- Does Chaplean Coding Standard support Laravel 10+ and PHP 8.1+?
- The package is designed to work with modern Laravel and PHP versions, but verify compatibility by checking its PHP_CodeSniffer rules against your project’s dependencies. Since it’s a static analysis tool, it won’t break runtime functionality, only flag style issues.
- Can I customize or override Chaplean’s rules for my Laravel project?
- Yes, you can override or extend rules via a custom `ruleset.xml` file. Document your changes clearly, as the package’s long-term maintenance is uncertain. For Laravel-specific adjustments (e.g., Blade templates), exclude directories like `resources/views/` in your PHPCS config.
- Will Chaplean Coding Standard conflict with Laravel Pint or PHPStan?
- No, it’s complementary. Use Laravel Pint for auto-formatting and PHPStan for static analysis while Chaplean enforces coding standards. Configure them in parallel—PHPCS for style rules, Pint for formatting, and PHPStan for type safety. Conflicts are unlikely unless Chaplean’s rules are overly strict on Laravel idioms.
- How do I integrate Chaplean into GitHub Actions for Laravel CI?
- Add a step to your workflow using `phpcs` with the Chaplean standard. Example: `- name: Run PHPCS run: vendor/bin/phpcs --standard=chaplean --report=github app/ tests/`. Cache dependencies with `actions/cache` to speed up CI. Test with a small subset of files first to avoid false positives.
- Does Chaplean Coding Standard handle Laravel-specific syntax like Blade templates or facades?
- It may flag Blade syntax or facades if they deviate from strict PSR-12 rules. Exclude Blade files by adding `<arg name="exclude" value="resources/views/"/>` to your PHPCS config. Test with Laravel’s default files (e.g., `RouteServiceProvider.php`) to identify edge cases.
- What’s the performance impact of running Chaplean in CI for a large Laravel codebase?
- Minimal if cached. Use `--cache` to store results between runs, reducing runtime. For large projects, parallelize scans with `--parallel` or split by directory. Local development may slow down if scanning frequently, but CI impact is negligible with caching.
- Are there alternatives if Chaplean’s rules are too opinionated for Laravel?
- Yes. Use `squizlabs/php_codesniffer` with PSR-12 for baseline compliance, then add custom rules for Laravel-specific needs. For project-wide standards, `dealerdirect/phpcodesniffer-composer-installer` lets you bundle rulesets. Laravel Pint can handle formatting separately.
- How do I exclude specific files or directories from Chaplean’s checks?
- Use the `<arg name="exclude" value="path/to/file"/>` directive in your `phpcs.xml` or pass `--exclude=path/to/dir` via CLI. Common exclusions for Laravel projects include `resources/views/`, `database/migrations/`, or vendor files. Document exclusions to avoid missing critical checks.
- Is Chaplean Coding Standard actively maintained? What if it stops working with future Laravel versions?
- The package shows no recent activity or maintainer updates, so long-term viability is uncertain. Mitigate risk by forking the ruleset or switching to PSR-12 + custom rules if needed. Always test with your Laravel version and monitor for breaking changes in PHP_CodeSniffer itself.
Weaver
How can I help you explore Laravel packages today?