⚗️ About Larastan
Larastan was created by Nuno Maduro, got artwork designed by @Caneco, is maintained by Can Vural and Viktor Szépe, and is a PHPStan wrapper for Laravel. Larastan focuses on finding errors in your code without actually running it. It catches whole classes of bugs even before you write tests for the code.
- Adds static typing to Laravel to improve developer productivity and code quality
- Supports most of Laravel's beautiful magic
- Discovers bugs in your code without running it
✨ Getting Started In 3 Steps
1: First, you may use Composer to install Larastan as a development dependency into your Laravel project:
composer require --dev nunomaduro/larastan
Using Larastan for analysing Laravel packages? You may need to install
2: Then, create a
phpstan.neon.dist file in the root of your application. It might look like this:
includes: - ./vendor/nunomaduro/larastan/extension.neon parameters: paths: - app # The level 8 is the highest level level: 5 ignoreErrors: - '#Unsafe usage of new static#' excludePaths: - ./*/*/FileToBeExcluded.php checkMissingIterableValueType: false
For all available options, please take a look at the PHPStan documentation: https://phpstan.org/config-reference
3: Finally, you may start analyzing your code using the phpstan console command:
If you are getting the error
Allowed memory size exhausted, then you can use the
--memory-limit option fix the problem:
./vendor/bin/phpstan analyse --memory-limit=2G
A list of configurable rules specific to Laravel can be found here.
Custom PHPDoc types
A list of PHPDoc types specific to Larastan can be found here.
Custom PHPStan config parameters
A list of custom config parameters that you can use in your PHPStan config file can be found here.
Errors To Ignore
Some parts of Laravel are currently too magical for Larastan/PHPStan to understand. We listed common errors to ignore, add them as needed.
Thank you for considering contributing to Larastan. All the contribution guidelines are mentioned here.
You can have a look at the CHANGELOG for constant updates & detailed information about the changes. You can also follow the Twitter account for the latest announcements or just come say hi!: @enunomaduro, @can__vural.
❤️ Support The Development
Do you like this project? Support it by donating
Larastan is an open-sourced software licensed under the MIT license.