gboquizosanchez/phpstan-report

Laravel package to display PHPStan errors in a view

1.0.4 2025-09-25 09:15 UTC

This package is auto-updated.

Last update: 2025-09-25 09:16:00 UTC


README

Latest Version Software License Total Downloads

Overview

PHPStan Report is a Laravel package that provides an elegant web interface for viewing, analyzing, and managing PHPStan static analysis results. Transform your code quality insights into an interactive, user-friendly dashboard.

Features ✨

  • 🎯 Dynamic Level Control - Adjust PHPStan analysis levels (1-10) through an intuitive web interface
  • ⚑ Real-time Analysis - Execute PHPStan analysis directly from your browser
  • πŸ“Š Beautiful Reports - View detailed analysis results with clear, organized presentation
  • πŸŒ“ Theme Support - Switch between dark and light themes with session persistence
  • πŸ“‹ Copy Functionality - One-click copy for error messages and solutions
  • πŸ“± Responsive Design - Optimized experience across mobile and desktop devices
  • πŸš€ Composer Integration - Seamless integration with Composer scripts
  • πŸ’Ύ Auto-save Settings - Automatically remembers your preferred configuration

Requirements

  • PHP: 8.3+
  • Laravel: 11.0+ or 12.0+
  • Composer: Latest stable version

Installation

Install the package via Composer:

composer require gboquizo/phpstan-report

Quick Setup

Run the installation command to automatically configure PHPStan Report:

php artisan install:phpstan-report

This command performs the following actions:

  1. Creates phpstan.neon - Generates a configuration file with level 3 analysis (if not exists)
  2. Publishes assets - Copies package assets to public/vendor/phpstan-report
  3. Updates composer.json - Adds PHPStan script for easy execution
  4. Runs initial analysis - Executes PHPStan analysis and asset discovery

Generated Configuration

The installation creates a basic phpstan.neon configuration:

parameters:
    level: 3
    paths:
        - app

You can customize this configuration according to your project needs.

Screenshots πŸ’„

Panel

Usage

Accessing the Web Interface

Navigate to the PHPStan Report dashboard using any of these methods:

  • Direct URL: https://your-application.com/phpstan-report
  • Artisan route list: Use php artisan route:list --name=phpstan to verify the route

Dashboard Features

πŸ“Š Analysis Dashboard

  • Real-time statistics showing total errors, warnings, and analysis status
  • File-based organization with expandable error lists
  • Severity indicators with color-coded error types

βš™οΈ Level Management

  • Interactive slider to adjust PHPStan analysis levels (1-10)
  • Instant feedback showing level descriptions and expected behavior
  • Automatic re-analysis when level changes are applied

πŸš€ Analysis Execution

  • One-click analysis button for immediate code scanning
  • Progress indicators showing analysis status
  • Success/error notifications with detailed feedback

🎨 User Experience

  • Theme toggle between dark and light modes
  • Persistent preferences saved across browser sessions
  • Mobile-optimized interface for analysis on-the-go
  • Copy-to-clipboard functionality for quick error sharing

Command Line Usage

You can also run PHPStan analysis through Composer:

# Run analysis (added by installation command)
composer phpstan-report

Getting Help

If you encounter issues:

  1. Check the logs - Laravel logs may contain helpful error messages
  2. Verify requirements - Ensure PHP and Laravel versions meet minimum requirements
  3. Clear cache - Run php artisan config:clear and php artisan cache:clear
  4. Open an issue - Report bugs or request features

Contributing

We welcome contributions! Please feel free to:

  • πŸ› Report bugs through GitHub issues
  • πŸ’‘ Suggest features or improvements
  • πŸ”§ Submit pull requests with bug fixes or enhancements
  • πŸ“– Improve documentation or add examples

Credits πŸ§‘β€πŸ’»

License

This package is open-source software licensed under the MIT License.

Dependencies

PHP dependencies πŸ“¦

  • Illuminate Console Latest Stable Version
  • Illuminate Http Latest Stable Version
  • Illuminate Support Latest Stable Version
  • Illuminate View Latest Stable Version
  • Phpstan Phpstan Latest Stable Version

Develop dependencies πŸ”§

  • Hermes Dependencies Latest Stable Version
  • Laravel Pint Latest Stable Version

Develop dependencies πŸ”§

  • Alpinejs Latest Stable Version
  • Autoprefixer Latest Stable Version
  • Postcss Latest Stable Version
  • Tailwindcss Latest Stable Version
  • Vite Latest Stable Version

Made with ❀️ for the PHP community