Weave Code
Coding Standards Laravel Package
joomla/coding-standards
Joomla coding standard definitions for PHP_CodeSniffer, plus helpful resources for developers writing Joomla software. Note that since Joomla 4.2 the project uses PSR-12; install via Composer.
Joomla Coding Standards Definition
Frequently asked questions about Coding Standards
- What is joomla/coding-standards used for?
- It is a PHP_CodeSniffer standard definition for Joomla coding conventions, plus resources for developers writing Joomla software. It is intended for checking Joomla-style code and non-PHP assets, not for enforcing Laravel application conventions. Since Joomla 4.2, Joomla itself uses PSR-12, and the README says the PHP standards are being updated.
- Is joomla/coding-standards a Laravel coding standard?
- No. It is a Joomla-focused PHPCS ruleset and does not align with Laravel's recommended PSR-12/PER conventions or Laravel Pint defaults. Laravel teams should use PSR-12, Laravel Pint, or maintained PHP-CS-Fixer rules instead. This package only makes sense if you maintain legacy Joomla code or need Joomla-specific non-PHP validation.
- How do I install joomla/coding-standards with Composer?
- Install it as a dev dependency, for example by adding joomla/coding-standards to require-dev and running composer install. Then configure PHP_CodeSniffer with a phpcs.xml that references the Joomla standard. Keep it out of production dependencies and pin both the package and PHPCS versions because compatibility is not guaranteed with modern toolchains.
- Does joomla/coding-standards support PHP 8.2, PHP 8.3, and PHP_CodeSniffer 3.x?
- The README lists PHP 5.3+ and PHP_CodeSniffer 2.8+, and it warns that the released custom sniffs are compatible with PHPCS 2.x while a 3.x-dev branch exists separately. Modern PHP 8.2/8.3 and current PHPCS compatibility are not verified in the provided context. Run a short compatibility spike with your PHP and PHPCS versions before adopting it.
- Should I use joomla/coding-standards instead of Laravel Pint or PHP-CS-Fixer?
- For Laravel application code, no. Laravel Pint and PSR-12/PER provide stronger, maintained standards that match modern Laravel conventions. This package is outdated for PHP rules and is better treated as a reference for legacy Joomla compatibility. Avoid combining overlapping Pint and PHPCS rules that can produce contradictory fixes.
- Which Joomla coding standards are still valid after Joomla 4.2 moved to PSR-12?
- According to the README, the non-PHP Joomla coding standards remain valid, while PHP standards are being updated for the PSR-12 change. The package's PHP rules should not be treated as a current Joomla 4.2+ or Laravel quality gate. Use PSR-12 for PHP and keep any Joomla-specific checks narrowly scoped to assets that genuinely need them.
- Can I run joomla/coding-standards in CI for a Laravel project?
- You can technically add it as a Composer dev dependency and run it in an isolated CI job, but the value is low for Laravel code. It should not be part of application runtime or replace Laravel Pint/PSR-12 checks. If used at all, pin versions, isolate the job, and expect false positives or PHPCS compatibility issues.
- What are good alternatives to joomla/coding-standards for Laravel?
- Use Laravel Pint for Laravel projects, backed by PSR-12/PER conventions and PHP-CS-Fixer where needed. For JavaScript, CSS, and other assets, use maintained tools such as ESLint, Stylelint, and Prettier rather than importing Joomla's non-PHP standards. These alternatives are better aligned with Laravel and have stronger ecosystem support.
- Is joomla/coding-standards maintained and safe to use in production?
- It should never ship to production runtime and should only be considered as a dev or CI tool. The last release noted is from 2020, the README says PHP standards are being updated, and modern PHP/PHPCS compatibility is unverified. Treat it as a legacy Joomla reference with medium technical risk and high standards debt.
- What license does joomla/coding-standards use and do I need legal review?
- The package is GPL-2.0, so legal review is advisable if you redistribute, bundle, vendor, or modify the standard. Internal dev-only use may still need policy review depending on your organization. Do not assume it can be copied into Laravel tooling without checking license obligations.
Weaver
How can I help you explore Laravel packages today?