Weave Code
Requirements Checker Laravel Package
symfony/requirements-checker
Symfony Requirements Checker is a small utility to verify your server meets Symfony’s requirements (PHP version, extensions, settings) before installing or deploying. Run it in CLI or via a web script to quickly spot missing dependencies and configuration issues.
Checks requirement for running Symfony
Frequently asked questions about Requirements Checker
- Can I use Symfony Requirements Checker in a Laravel project even though it’s Symfony-focused?
- Yes, but with customization. The package checks PHP versions and extensions—useful for Laravel too. You’ll need to define a custom requirements file (YAML/JSON) to replace Symfony’s defaults with Laravel-specific dependencies like `pdo_mysql` or `gd`. The core logic remains the same.
- How do I install Symfony Requirements Checker in Laravel?
- Run `composer require symfony/requirements-checker --dev` to install it as a development dependency. For CLI use, execute `vendor/bin/requirements-checker check` directly. For Laravel integration, wrap it in an Artisan command (see Phase 2 in the TPM assessment).
- Will this work with Laravel 5.x or older versions?
- Officially, the package supports PHP 7.4+, so Laravel 8+ projects will work fine. For Laravel 5.x (PHP 7.1–7.3), you may need to manually adjust the PHP version checks or use a polyfill. Test thoroughly, as Symfony’s requirements might not align perfectly with older Laravel setups.
- Can I integrate this into my CI/CD pipeline (GitHub Actions, GitLab CI)?
- Absolutely. Add a step like `- name: Check PHP requirements run: vendor/bin/requirements-checker check` to fail builds if requirements aren’t met. The CLI returns non-zero exit codes on failures, making it ideal for CI gatekeeping. For Laravel, combine it with PHPUnit or Pest for full test coverage.
- How do I customize the requirements for Laravel-specific dependencies?
- Create a custom requirements file (e.g., `laravel-requirements.yml`) defining your PHP extensions, versions, or settings. Use the `--format=json` flag to generate a template, then modify it. Load it via `--requirements=path/to/laravel-requirements.yml` in your CLI command or Artisan wrapper.
- Does this package add significant performance overhead to my Laravel app?
- No, the checks are lightweight and idempotent. Running `requirements-checker` in CLI mode adds ~100ms–1s for a full scan, which is negligible. For Artisan commands, the overhead is minimal since it’s a one-time validation step, not a runtime process.
- Are there any false positives/negatives when using this with Laravel?
- Possible, since Symfony’s default requirements (e.g., `apcu`) may not apply to Laravel. Mitigate this by defining a custom requirements file tailored to your Laravel stack. Ignore Symfony-specific checks (e.g., OS-level tools like `systemd`) unless they’re critical to your deployment.
- Can I run this as a pre-commit hook in Laravel?
- Yes, but ensure it’s fast. Add a script to your `composer.json` like `"pre-commit": "symfony/requirements-checker check --format=json"` and use a tool like [Husky](https://typicode.github.io/husky/) to trigger it. For large projects, limit checks to critical dependencies (e.g., PHP version, `pdo`) to avoid slow feedback loops.
- What are the alternatives to Symfony Requirements Checker for Laravel?
- For Laravel-specific checks, consider `phpstan/extension-installer` (for missing extensions) or `roave/security-advisories` (for PHP security). For broader PHP validation, `php -m` (built-in) or `phpunit/phpunit` (with custom assertions) are options. However, none offer the structured, Symfony-proven output format of this package.
- How do I handle Symfony’s future updates that might break Laravel compatibility?
- Monitor Symfony’s [deprecations](https://github.com/symfony/symfony/blob/main/UPGRADE.md) and adjust your custom requirements file if needed. Since you’re not using Symfony’s framework, focus on PHP/extension changes. For example, if Symfony drops PHP 8.0 support, update your Laravel project’s PHP version requirement in the custom file.
Weaver
How can I help you explore Laravel packages today?