Weave Code
Code Style Php Laravel Package
umbrellio/code-style-php
A shared PHP coding-standard toolkit that bundles PHP-CS-Fixer rules and configuration, helping teams enforce consistent formatting and style conventions across projects with minimal setup.
umbrellio/code-style-php provides a shared coding standard for PHP projects, helping teams keep formatting consistent with minimal setup. It packages a ready-to-use PHP-CS-Fixer configuration so you can adopt Umbrellio’s conventions quickly and enforce them across local development and CI.
- Preconfigured PHP-CS-Fixer ruleset
- Simple Composer installation
- Consistent formatting across projects
- Easy to extend or override
- Suitable for CI checks and local workflows
Frequently asked questions about Code Style Php
- What is umbrellio/code-style-php used for?
- Umbrellio Code Style PHP provides a shared PHP-CS-Fixer configuration used to keep formatting consistent across PHP projects. It is intended to be installed via Composer and extended from your project's PHP-CS-Fixer setup. It is especially useful for teams that want the same coding standard across Laravel and other PHP codebases.
- How do I install umbrellio/code-style-php with Composer?
- Install it with Composer, typically as a development dependency, using composer require --dev umbrellio/code-style-php. Then reference the package ruleset from your PHP-CS-Fixer configuration. Commit the updated composer.json and composer.lock so teammates and CI use the same version.
- Does umbrellio/code-style-php support Laravel projects?
- Yes, the package is intended for consistent formatting across Laravel and general PHP projects. Because it is a PHP-CS-Fixer configuration, it works anywhere PHP-CS-Fixer runs in your Laravel codebase. It supplies shared style rules rather than replacing Laravel-specific tooling by itself.
- How do I apply the shared ruleset in PHP-CS-Fixer?
- Create or update your .php-cs-fixer.php configuration and extend the ruleset provided by the package. The exact class or file path to reference is defined in the package documentation. After wiring it up, run PHP-CS-Fixer with that config to format files or check formatting.
- Can I customize or override the code style rules?
- Yes, a shared ruleset should be treated as a baseline, and you can merge additional rules or override specific fixers in your project-level PHP-CS-Fixer config. Keep overrides intentional and documented so local formatting stays close to the shared standard. If you need broad changes, consider contributing them upstream.
- Which PHP versions and PHP-CS-Fixer versions are supported?
- The package is Composer-installed and intended for PHP projects, but the exact PHP and PHP-CS-Fixer version constraints depend on the release. Check the package's composer.json on Packagist or in the repository for the current requirements. Pin a compatible version in composer.json when adopting it in CI.
- Should umbrellio/code-style-php be a require or require-dev dependency?
- It should normally be a require-dev dependency because it is a development-time formatting tool, not runtime application code. Installing it in require-dev keeps production installs lean. Commit composer.json and composer.lock so the ruleset version is reproducible for the whole team.
- How do I run umbrellio/code-style-php in CI or a Composer script?
- Add a Composer script such as composer lint or composer fix that invokes PHP-CS-Fixer with your project configuration. In CI, run PHP-CS-Fixer in check-only mode so the build fails when files are not formatted. Cache Composer dependencies to keep CI runs fast.
- Can I use umbrellio/code-style-php alongside Laravel Pint?
- You can use both in a project, but avoid running two formatters with conflicting rules as your source of truth. Laravel Pint has its own presets, while this package provides a PHP-CS-Fixer ruleset. Choose one primary formatter or carefully align Pint's configuration with the shared ruleset.
- Is umbrellio/code-style-php actively maintained, and what alternatives exist?
- Check Packagist and the repository for the latest release date, open issues, and compatibility updates before adopting it. Because it is a shared internal style package, activity may be tied to Umbrellio's own needs. Alternatives include Laravel Pint, existing PHP-CS-Fixer rulesets, or maintaining your own PHP-CS-Fixer configuration.
Weaver
How can I help you explore Laravel packages today?