Weave Code
Php Style Laravel Package
jadu/php-style
Jadu PHP Style defines a shared coding standard for Jadu PHP projects, with configuration to automatically format code and enforce consistent conventions. Install via Composer and run the provided tooling to apply the rules across your codebase.
phpcs configuration for Jadu code
Frequently asked questions about Php Style
- What is jadu/php-style used for?
- jadu/php-style provides a shared, opinionated PHP coding standard for Jadu projects. It packages conventions into a reusable ruleset so Laravel and PHP codebases can adopt the same style with minimal setup. The aim is consistent, readable code and less noise in code review.
- How do I install jadu/php-style in a Laravel project?
- Install it through Composer, then run the tooling the package provides to apply or check the ruleset. It is typically used as development tooling in local environments and CI rather than in production deployments. Confirm the package's Composer constraints before adding it to an existing Laravel project.
- Does jadu/php-style format code automatically?
- The package includes configuration intended to automatically format code and enforce consistent conventions. You run the provided tooling to apply the rules across a Laravel/PHP codebase. It is development tooling, not a runtime library, so it should not affect production application behavior.
- How do I enforce jadu/php-style in CI?
- Add the package's style check command to your CI pipeline so builds fail when code does not match the shared ruleset. This catches style issues early and keeps conventions consistent across repositories. Use the same ruleset locally and in CI to avoid surprises.
- Which Laravel and PHP versions does jadu/php-style support?
- The overview does not list specific Laravel or PHP version constraints. The package's Composer requirements are the source of truth for supported versions. Check them before installing into an existing Laravel application, especially if you maintain multiple framework versions.
- Can I use jadu/php-style on an existing Laravel codebase?
- Yes, it is intended for new and existing Laravel/PHP codebases that want to adopt the same shared style. The first run on a legacy codebase may produce a large diff because existing code has not followed the ruleset. Apply formatting in a separate branch or commit so functional changes remain easy to review.
- Can I customize the jadu/php-style rules?
- The package is described as an opinionated shared standard, so its main value is applying the same conventions across Jadu repositories. The overview does not document project-specific customization, so verify what configuration the package exposes before overriding rules. Diverging too much can reduce the consistency the standard is meant to provide.
- How can I check that my code follows jadu/php-style?
- Run the package's provided style check command locally and in CI to confirm your code matches the shared ruleset. A passing check means the code aligns with jadu/php-style's configured conventions. Keep the check in your pipeline so new violations are caught before review.
- How is jadu/php-style maintained and updated?
- The overview does not state a release cadence or maintenance policy. Check the Composer package metadata and repository history, where available, for recent releases, compatibility updates, and issue activity. For long-lived Laravel projects, pin a version and review updates before upgrading.
- What alternatives exist to jadu/php-style?
- Alternatives include maintaining your own PHP coding standard or using another shared ruleset configured for Laravel teams. jadu/php-style is specifically opinionated for Jadu projects, so it is most useful when you want those conventions. Compare rulesets, CI integration, and maintenance activity before switching.
Weaver
How can I help you explore Laravel packages today?