- How do I integrate this package into my Laravel CI pipeline to fail builds on lint violations?
- Use the package’s CLI tool in your CI script (e.g., GitHub Actions) to generate a report, then add a step to validate the output. For example, fail the build if the JSON report contains errors or if the exit code indicates violations. The package’s output can also be uploaded as an artifact for review. Laravel’s Artisan commands can wrap this logic for consistency.
- Does sweetchuck/lint-report support PHPStan, Psalm, and ESLint for frontend linting?
- The package is designed to normalize output from multiple linters, including PHPStan, Psalm, and ESLint. Check the package’s documentation for supported tools, as compatibility depends on the linter’s output format. If your tool isn’t listed, you may need to configure custom parsing or fork the package for extensions.
- Can I store lint reports in a Laravel database for historical tracking?
- Yes, the package generates machine-readable outputs (JSON, Markdown, etc.), which you can parse and store in a Laravel model. Create a custom Artisan command to fetch the report, process it, and save it to a database table (e.g., `lint_reports`). This enables trend analysis or alerts for recurring issues.
- What Laravel versions and PHP versions does this package support?
- The package itself has no direct Laravel dependencies, so it works with any Laravel version (5.8+). Ensure your PHP version (e.g., 8.1+) matches the package’s requirements, which are typically listed in its `composer.json`. Laravel’s PHP version support dictates compatibility, not the package itself.
- How do I customize the report format or add Laravel-specific metadata (e.g., commit hash)?
- The package likely supports command-line flags for output formats (JSON, Markdown, etc.). For Laravel-specific metadata, extend the package by modifying its configuration or wrapping it in a custom Artisan command. You can pre-process the report before generation or post-process the output to inject metadata like commit hashes or environment details.
- Is there a way to compare lint reports across CI runs to track improvements or regressions?
- Yes, the package is designed for trend-friendly reports. Store historical reports in a database or file system, then compare them using Laravel’s query builder or a custom script. Tools like `diff` or Laravel’s collection methods can highlight changes between runs, such as new violations or resolved issues.
- Can I use this package in a Laravel Forge or Deployer script for server-side linting?
- Absolutely. The package’s CLI tool can be executed in Forge hooks or Deployer tasks to generate lint reports on the server. Use the `--output` flag to save the report to a file (e.g., `/storage/app/lint-report.json`) and integrate it into your deployment workflow, such as failing the deploy if linting fails or logging results to a monitoring system.
- What are the alternatives to sweetchuck/lint-report for Laravel lint reporting?
- Alternatives include custom scripts using PHP’s `exec()` to run linters and parse outputs, or dedicated tools like `phpstan/extension-installer` for PHPStan reports. For frontend tools, ESLint’s `--format=json` can be used directly. However, this package stands out by normalizing outputs into a consistent format, making it easier to integrate with Laravel’s ecosystem (e.g., notifications, logging).
- How do I test this package locally before deploying to CI?
- Install the package via Composer (`composer require sweetchuck/lint-report`), then run it manually with `vendor/bin/lint-report --help` to explore options. Test with a sample command like `vendor/bin/lint-report --format=json --output=test-report.json` and validate the output structure. Use Laravel’s `Artisan::call()` in a test to simulate CI behavior and assert the report format.
- Will this package work with custom PHP linting rules or non-standard tooling?
- The package’s flexibility depends on its parsing logic. If your custom rules produce non-standard output, you may need to extend the package or pre-process the linter’s output to match expected formats. Check the package’s source code for extensibility points, such as custom parsers or configuration options for tool-specific adjustments.