Weave Code
Cs Laravel Package
sabre/cs
Developer-only package providing shared coding standards for sabre/* projects. Install via Composer to enforce consistent style across sabre packages; mainly useful if you maintain or create sabre components.
sabre/cs provides coding standards for all sabre packages.
Frequently asked questions about Cs
- Can I use sabre/cs to enforce coding standards in a Laravel project?
- Sabre/cs is not Laravel-specific, but you can integrate it into your project via PHP_CodeSniffer. It enforces Sabre’s tweaks to PSR-12, which may conflict with Laravel’s defaults. Use it only if you’re working with Sabre packages or need Sabre’s exact conventions. For general Laravel projects, PHP-CS Fixer or Pint are better choices.
- How do I install sabre/cs in a Laravel project?
- Run `composer require sabre/cs --dev` in your project root. No Laravel-specific setup is needed—it works as a standalone PHP_CodeSniffer ruleset. Ensure PHP_CodeSniffer is installed globally or via Composer (`composer require --dev squizlabs/php_codesniffer`).
- Will sabre/cs work with Laravel’s default tooling like Pint or laravel-pint?
- No, sabre/cs is PHP_CodeSniffer-based and won’t integrate natively with Pint. Conflicts may arise if your project uses both tools. Override conflicting rules in your `phpcs.xml` or use PHP-CS Fixer’s `--rules` to align Sabre’s standards with Laravel’s toolchain.
- Does sabre/cs support Laravel 10+?
- Sabre/cs itself doesn’t target Laravel versions, but it requires PHP 7.2+. Since Laravel 10+ supports PHP 8.1+, compatibility depends on your PHP_CodeSniffer version. Test the ruleset against your codebase to confirm no breaking conflicts with Laravel’s conventions.
- How do I enforce sabre/cs rules in CI for a Laravel project?
- Add a linting step to your CI (e.g., GitHub Actions) using PHP_CodeSniffer. Example: `./vendor/bin/phpcs --standard=sabre --warning-severity=0 src/ tests/`. For Laravel, exclude Blade files or document exceptions, as Sabre’s rules may not apply to them.
- Are there alternatives to sabre/cs for Laravel projects?
- For Laravel, use PHP-CS Fixer with a custom preset or Pint for PSR-12 compliance. If you need Sabre-specific rules, consider forking sabre/cs or migrating its rules to PHP-CS Fixer. Avoid redundant tooling—Laravel’s ecosystem already handles most coding standards.
- Can I use sabre/cs with Git hooks in Laravel?
- Yes, but it requires manual setup. Use `composer require laravel/hooks` and configure a `post-autoload-dump` script to run `phpcs` with Sabre’s rules. Note that Git hooks may slow down development, so CI enforcement is often preferred.
- Is sabre/cs actively maintained? Should I use it in production?
- Sabre/cs is archived with no active maintenance, which introduces long-term risks. If you’re maintaining Sabre packages, proceed with caution. For production, document the dependency’s limitations and plan for forking or migrating to PHP-CS Fixer if issues arise.
- How do I handle conflicts between sabre/cs and Laravel’s PSR-12 rules?
- Sabre’s rules may override or extend PSR-12. Override specific rules in your `phpcs.xml` or use PHP-CS Fixer to merge standards. Test thoroughly—some Sabre rules (e.g., class naming) might clash with Laravel’s conventions. Document exceptions in your team’s contributing guidelines.
- Can I integrate sabre/cs into PHPStorm or VSCode for real-time feedback?
- Sabre/cs requires manual IDE setup. In PHPStorm, configure PHP_CodeSniffer under `Settings > Editor > Inspections > PHP > PHP_CodeSniffer`. For VSCode, use the PHP_CodeSniffer extension and point it to Sabre’s ruleset. No native Laravel support exists, so expect additional configuration.
Weaver
How can I help you explore Laravel packages today?