Easy Ci Laravel Package

Getting Started

Install via Composer as a dev dependency:

composer require --dev symplify/easy-ci

Verify installation by running the config checker:

./vendor/bin/easy-ci check:config

This validates all CI-related config files (e.g., ecs.php, parameters.php, .github/workflows/*.yml) locally before CI runs—catching misconfigurations early. Start with simple check:php to lint PHP files, then layer in static analysis (check:phpstan).

Implementation Patterns

• Pre-commit Hook: Integrate check:changed into .git/hooks/pre-commit to run only on staged files, giving instant feedback without slowing down commits.
• Local CI Parity: Run ./vendor/bin/easy-ci check:all locally to mirror production CI behavior—ensuring contributors catch issues before push.
• Config Bootstrapping: Use easy-ci dump:config to scaffold reproducible setups for Rector, PHPStan, and ECS across new projects. Share the generated files via template repos.
• CI Stage Orchestration: Wrap multiple checks in a single command (e.g., check:quality) to reduce .gitlab-ci.yml/.github/workflows/*.yml verbosity and keep job definitions declarative.

Gotchas and Tips

• Silent Config overrides: parameters.php values can override ecs.php silently—always use check:config --debug when debugging rule application or rule-set precedence.
• Cache contention: In monorepos with multiple PHP versions or tools (e.g., PHP 8.0 local vs 8.1 CI), disable cache with --no-cache or clear var/cache on branch switches to avoid false positives.
• Version drift: With only 18 stars and low score, assume breaking changes. Pin to explicit versions (e.g., "symplify/easy-ci": "9.0.*") in composer.json to prevent CI pipeline drift.
• Tooling integration: It doesn’t run tools—it orchestrates them. Ensure phpstan, rector/rector, and friendsofphp/php-cs-fixer are installed separately and autoload-compatible.
• Laravel gotcha: While the package claims Laravel relevance, its underlying架构 is Symfony-centric. Test with php artisan tinker --execute="new \Symfony\Component\DependencyInjection\ContainerBuilder;" to verify Symfony DI compatibility before relying on advanced features.