README.md

Author: lisgroup

laravel/readme/24. 2019-05-27-PHP 静态代码分析包 Larastan.md

@@ -0,0 +1,42 @@
+## 23. PHP 静态代码分析包 Larastan
+
+`Larastan` 是对 [phpstan/phpstan](https://github.com/phpstan/phpstan) 的 Laravel 封装，主要是帮你查找代码中的错误，而无需实际的运行代码。它可以捕获所有类的 `bug` 。支持 `Laravel` 优美的魔术
+
+![Larastan Example](https://static.oschina.net/uploads/img/201905/17104813_oSxA.png)
+
+### 安装和使用
+
+#### Requires:
+
+- PHP 7.1.3+
+- Laravel 5.6+
+
+你可以通过 `Composer` 来安装 `Larastan` 作为开发依赖到你的 `Laravel` 项目：
+
+```
+composer require --dev nunomaduro/larastan
+```
+
+在 Laravel 应用中使用
+可以使用如下命令来分析代码
+
+```
+php artisan code:analyse
+```
+
+定制配置
+如果你想提供你自己的配置，可以创建 `phpstan.neon` 或者 `phpstan.neon.dist` 文件在你应用的根目录中，如下所示：
+
+```
+includes:
+    - ./vendor/nunomaduro/larastan/extension.neon
+parameters:
+    level: 5
+    ignoreErrors:
+        - '#Access to an undefined property App\\Demo\\[a-zA-Z0-9\\_]+::\$[a-zA-Z0-9\\_]+\.#'
+        - '#Call to an undefined method App\\Http\\Resources\\DemoResource::DemoMethod\(\)\.#'
+    excludes_analyse:
+        - /*/*/FileToBeExcluded.php
+```
+
+所有可用配置请阅读 [PHPStan documentation](https://github.com/phpstan/phpstan).