Weave Code
Coding Standard Laravel Package
interaction-design-foundation/coding-standard
A shared PHP coding standard from Interaction Design Foundation for Laravel/PHP projects. It packages PHP_CodeSniffer rules so teams can enforce consistent style and catch common issues with minimal configuration, standardizing local and CI checks across apps and packages.
Interaction Design Foundation Coding Standard provides a shared PHP_CodeSniffer ruleset for enforcing consistent code style and catching common issues across Laravel/PHP projects. It gives teams a ready-to-use standard that can be installed via Composer and run locally or in CI, reducing style debates and keeping codebases maintainable.
- Ready-to-use PHP_CodeSniffer ruleset
- Consistent formatting and naming conventions
- Suitable for Laravel/PHP projects
- Easy Composer installation
- Works in local workflows and CI pipelines
Frequently asked questions about Coding Standard
- How do I install interaction-design-foundation/coding-standard in a Laravel project?
- Install it as a development dependency with Composer using require-dev, then point PHP_CodeSniffer at the package ruleset in your phpcs.xml or run the provided configuration. It is a dev-time quality gate, so keep it out of production runtime dependencies. After installation, run PHPCS through a Composer script or directly from vendor/bin to verify the rules load.
- Which PHP and Laravel versions does this coding standard support?
- The available context does not list exact PHP, Laravel, PHP_CodeSniffer, or PHP-CS-Fixer versions. Check the package composer.json and README, then pin the coding standard alongside PHPCS and PHP-CS-Fixer versions. Validate it against your organization's supported PHP and Laravel matrix before making CI checks blocking.
- Is this package compatible with Laravel Pint or does it replace Pint?
- This package supplies PHP_CodeSniffer rules and PHP-CS-Fixer configuration, while Laravel Pint wraps PHP-CS-Fixer. You should decide explicitly whether this package replaces Pint, layers on top of it, or is adapted into an internal ruleset. Check whether Pint can import the package's PHP-CS-Fixer config or whether Pint must be disabled for those checks.
- How do I run this coding standard in GitHub Actions or GitLab CI?
- Add the package as a require-dev dependency and call PHPCS from a Composer script in GitHub Actions, GitLab CI, or a similar pipeline. Start with a non-blocking job so you can measure runtime and existing violations. Pin package, PHPCS, and PHP-CS-Fixer versions so CI behavior stays stable across repositories.
- How do I auto-fix coding standard violations with this package?
- Use PHP_CodeSniffer's auto-fix mode through the package's ruleset, then review the diff before committing. For an existing codebase, generate an isolated auto-fix pull request so style changes do not mix with functional changes. Run the fixed code through CI again to confirm only intended rules were applied.
- How do I exclude files or ignore specific PHPCS rules?
- PHP_CodeSniffer supports ignore patterns and inline annotations for rule exceptions, but the package may define its own conventions. Establish a clear exception policy and document which files or rules may be suppressed. For legacy code, baseline existing violations and enforce rules on changed files first.
- Is this package on Packagist and what license does it use?
- Confirm the package listing on Packagist and review the repository license before reuse or forking. The package is intended to be installed with Composer, but you should verify the exact license terms in the repository. Because external adoption is very low, legal and ownership review matter before standardizing on it.
- Does it support changed-file scanning, parallel execution, and CI caching?
- The package provides the rules, while changed-file scanning, parallel execution, and caching are handled by PHPCS, PHP-CS-Fixer, and your CI configuration. Use changed-file checks and caching to reduce runtime on large repositories. Validate CI runtime before turning the checks into a blocking gate.
- Who maintains this coding standard and what is the release cadence?
- Upstream maintenance belongs to Interaction Design Foundation, but the package has very low external validation, with few stars and no dependents. Assign an internal owner for version pinning, upstream review, and rule-change communication. Assume you may need to fork or vendor the ruleset if upstream becomes inactive, and verify the release date and cadence.
- How should I roll this coding standard out to legacy Laravel codebases?
- Pilot the standard in one representative Laravel repository with a dry run to establish a baseline. Generate an auto-fix pull request in isolation, then enforce rules on changed files before blocking the whole repository. Once exceptions and CI runtime are stable, roll out to additional repositories with pinned versions and developer documentation.
Weaver
How can I help you explore Laravel packages today?