larastan/larastan
Larastan
Larastan is a static analysis extension and type inference engine for PHP designed to detect bugs and type errors in Laravel applications. It extends PHPStan to resolve framework-specific patterns and magic methods, providing a rule-based scanning engine to audit code quality without executing the application.
The tool specializes in Eloquent analysis, verifying that model properties, casts, and relationships align with database schemas and migrations. It tracks types across Eloquent collections, custom builders, and model factories to ensure type safety during database operations and iteration.
Broad capability areas include configuration validation, view path verification, and the detection of inefficient database queries or redundant collection calls. The engine also audits job dispatch arguments, localization keys, and compatibility with long-running process environments.
Diagnostics include styled bootstrap error reporting to resolve startup failures, as well as mechanisms for error suppression and the establishment of legacy issue baselines.
Features
- Code Quality and Analysis - Provides static analysis and linting to identify bugs and quality issues in Laravel applications without executing code.
- Static Analysis Extensions - Provides a rule-based scanning engine to find bugs and logical errors in Laravel applications without executing the code.
- Cast Configuration Validation - Checks that the return type and array shape of model casts match the expected configuration.
- Relationship Validations - Validates database relationship methods by checking return types and string arguments.
- ORM Component Validation - Validates custom builders and relations using generic templates to maintain type integrity across extended classes.
- Relation Validations - Verifies that relations passed to builder methods exist to prevent runtime errors.
- Builder Chain Validation - Validates method chains in custom query builders to ensure type safety during database queries.
- Database Column Validation - Checks that strings used in model or builder methods correspond to actual database columns or properties.
- Factory Type Validators - Analyzes model factories to verify they extend the base factory class with the correct model type.
- Model Factory Type Analysis - Verifies the relationship between models and factory classes using template types to prevent type mismatches.
- Type Safety - Enforces data integrity and prevents runtime crashes by ensuring correct data types for models, collections, and database relations.
- Collection Type Refinement - Tracks the types of objects stored within custom collection classes to maintain type safety during iteration.
- PHP Code Analysis - Scans PHP source code to identify inefficient database queries, unused views, and architectural violations.
- Model Attribute Inference - Recognizes model properties defined via attributes by validating associated getter and setter method types.
- Eloquent Collection Type Inference - Resolves collection type hints to specific model classes to ensure type safety during iteration.
- Static Analysis Engines - Uses a rule-based scanning engine to detect bugs, type errors, and maintainability issues in PHP code.
- Type Inference Engines - Automatically determines the data types of model properties and collection elements to enable deeper static analysis.
- Database - Analyzes database migrations and schema dumps to determine the types and existence of model properties.
- Code Quality Tools - Provides static analysis to identify dead views, inefficient queries, and redundant method calls to improve overall code quality.
- Laravel Integrations - Extends PHPStan to resolve Laravel's magic methods and framework-specific architecture for deeper static analysis.
- Schema Validation - Verifies that model properties, casts, and relationships match the actual database schema and configuration.
- Static Analysis Rules - Provides specialized rules for analyzing Laravel applications to resolve magic methods and framework-specific patterns.
- Static Query Analysis - Identifies collection method calls that should be performed as direct database queries to reduce memory usage.
- Configuration Verification - Verifies that the return types of configuration helper functions match the actual configuration files.
- Analysis Suppression Mechanisms - Disables specific error reports via inline comments or regex configurations to silence known issues.
- Environment Variable Type Coercions - Infers the return type of environment functions based on provided default values to ensure type consistency.
- Redundant Instantiation Detection - Flags the use of static creation methods where a simple new instance is more efficient.
- Helper Call Constraints - Flags calls to environment helpers outside of configuration files to prevent runtime instability when config is cached.
- Redundant Call Detection - Identifies unnecessary collection method calls that do not change the result and should be removed.
- Resource Type Inference - Infers the underlying model class used within API resources to validate property and method calls.
- Configuration Validation - Checks that keys passed to configuration methods point to arrays to prevent runtime type errors.
- Job Dispatch Type Verification - Checks that arguments passed when dispatching a job are type-compatible with the job class constructor.
- Long-Running Process Compatibility Analysis - Analyzes the codebase for patterns that are incompatible with long-running process environments.
- Model Coding Standards Enforcement - Validates that appended computed properties exist and that local scopes and accessors are not public.
- Provider Validation - Ensures deferrable service providers include the required provides method for correct bootstrapping.
- Static Analysis Baselines - Records existing issues in a configuration file to prevent legacy errors from blocking stricter analysis levels.
- Code Quality and Linting - Adds static analysis to Laravel via PHPStan.
- Static Analysis - Adds static analysis capabilities to framework-specific projects.
- Static Analysis Tools - Static analysis wrapper for Laravel applications.
