Weave Code
Runner Bootstrap Laravel Package
phpcq/runner-bootstrap
Bootstrap package for phpcq/runner. Provides the minimal runtime setup to start the runner reliably in different environments, handling initial configuration and wiring so tools can execute consistently in CI and local setups.
The phpcq plugin for composer - installs phpcq via composer
Frequently asked questions about Runner Bootstrap
- How do I integrate **phpcq/runner-bootstrap** into an existing Laravel project?
- Add it as a dev dependency in `composer.json` under `require-dev`, then run `composer update`. The package auto-wires PHPCQ for analysis without manual configuration. Use `composer phpcq` to trigger runs via Composer scripts.
- Does this package support Laravel’s PHP version requirements (e.g., 8.0+)?
- Verify PHPCQ’s PHP version support first, as this package delegates runtime execution to it. Check the `phpcq/runner` package constraints in Composer. If conflicts arise, pin versions explicitly in `composer.json`.
- Can I customize PHPCQ rules without editing the bootstrap package?
- Yes. Define rules in a `.phpcq.yml` file in your project root or pass CLI arguments like `--ruleset=custom`. The bootstrap handles initialization but defers rule logic to PHPCQ’s core.
- Will this work in CI pipelines like GitHub Actions or GitLab CI?
- Absolutely. The package is CI-friendly—add a Composer script (e.g., `phpcq`) and fail builds on errors. Example: `if ! composer phpcq; then exit 1; fi`. Works with any CI that supports Composer.
- Are there conflicts with other Laravel static analysis tools (e.g., PHPStan, Psalm)?
- Potential overlaps exist, but the bootstrap doesn’t enforce rules—it delegates to PHPCQ. Audit your toolchain for redundant checks (e.g., duplicate type analysis). Use Composer scripts to sequence tools logically.
- How do I handle false positives or suppress warnings in PHPCQ?
- Configure suppressions in `.phpcq.yml` or via CLI flags (e.g., `--suppress-file`). PHPCQ’s core handles this; the bootstrap provides no built-in overrides. Test locally before CI enforcement.
- Is this package maintained, or should I consider alternatives like Docker?
- The package has minimal adoption (0 stars), so monitor its GitHub for updates. For production, consider Dockerizing PHPCQ or using standalone installers like `dealerdirect/phpcodesniffer-composer-installer` for more control.
- Can I parallelize PHPCQ runs for large Laravel codebases?
- PHPCQ’s core supports parallel execution via CLI flags (e.g., `--parallel`). The bootstrap doesn’t enforce this, but you can wrap calls in your CI scripts. Test performance with `--jobs=N` for your project size.
- How do I debug issues if PHPCQ fails silently in CI?
- Enable verbose output with `composer phpcq --verbose`. Check logs for missing dependencies or PHP extensions. Use `composer why-not phpcq/runner` to diagnose version conflicts.
- What’s the difference between this and manually installing PHPCQ?
- This package standardizes initialization (e.g., config loading, environment checks) and reduces boilerplate. Manual installs require more setup, but offer flexibility for advanced use cases like custom reporters or pre/post-run hooks.
Weaver
How can I help you explore Laravel packages today?