Weave Code
SupportPal PHP coding standard.
Frequently asked questions about Coding Standard
- What Laravel versions does supportpal/coding-standard officially support?
- The package is designed for legacy Laravel (v7–v9) workflows using PHPCS. It lacks explicit Laravel v10+ compatibility or integration with modern tooling like Laravel Pint. Test thoroughly if using newer Laravel versions.
- How do I install and configure this package for Laravel?
- Run `composer require --dev supportpal/coding-standard:^0.4.5` and update your `phpcs.xml` to specify the standard: `<arg name="standard" value="SupportPal"/>. Pin PHPCS to v3.7.2 to avoid breaking changes, as newer versions may not be tested.
- Will this package work with Laravel Pint or php-cs-fixer?
- No, this package is PHPCS-specific and may conflict with Laravel Pint or php-cs-fixer due to its custom sniffs. Use it only if your team explicitly requires SupportPal’s proprietary rules and cannot migrate to modern tooling.
- Are the custom sniffs stable, or could they break in future updates?
- The changelog is silent on rule stability, and the package is niche-focused on SupportPal’s internal conventions. If SupportPal updates their codebase, custom sniffs *may* change without warning, risking compatibility issues in your project.
- How do I handle rule conflicts if I’m using shared Laravel packages?
- There’s no built-in conflict resolution. You’ll need to manually override SupportPal’s rules in your `phpcs.xml` or suppress violations for shared libraries. Test thoroughly to avoid false positives in CI.
- Does this package support PHPCS v4.0+ or only v3.7?
- The package is tested against PHPCS v3.7.2. Upgrading to PHPCS v4.0+ risks breaking changes, as the sniff API may have evolved. Pin the version explicitly in your `composer.json` or CI configuration to avoid surprises.
- Can I use this with GitHub Actions or other CI tools?
- Yes, but you’ll need to manually configure PHPCS version pinning. Example: Use `php-actions/phpcs@v1` with `phpcs_version: "3.7.2"` in your workflow. There are no pre-built GitHub Actions templates for this package.
- What are the alternatives if I need stricter or more modern coding standards?
- For Laravel v10+, consider `laravel/pint` (modern PHP-CS-Fixer wrapper) or `dealerdirect/phpcodesniffer-composer-installer` for PHPCS. If you need SupportPal’s rules, this package is the only option, but it’s not actively maintained or community-driven.
- How do I extend or customize the custom sniffs?
- Extending sniffs requires manual PHPCS knowledge, as there’s no documented API or changelog updates. You’ll need to inspect the package’s source code and modify sniffs directly, which may not be sustainable long-term.
- Is this package suitable for production Laravel applications?
- This is a dev-only package for enforcing coding standards, not runtime dependencies. While it won’t break production, its niche focus and lack of maintenance mean it’s risky for long-term projects. Prioritize alternatives like Pint or PHPCS-composer-installer for production-grade workflows.
Weaver
How can I help you explore Laravel packages today?