wpdesk / phpstan-rules
包含PHPStan配置的元包,适用于WP Desk项目
1.1.1
2024-09-10 22:27 UTC
Requires
- php-stubs/woocommerce-stubs: ^8.3 || ^9
- phpstan/extension-installer: ^1.3
- phpstan/phpstan: ^1.10
- phpstan/phpstan-deprecation-rules: ^1.1
- phpstan/phpstan-strict-rules: ^1.5
- szepeviktor/phpstan-wordpress: ^1.3
README
此元包包含WP Desk项目的PHPStan配置。这包括依赖扩展如szepeviktor/phpstan-wordpress
,以及额外的默认配置,如包含WooCommerce存根。
安装
composer require wpdesk/phpstan-rules
使用
安装后,您可以直接在项目中使用PHPStan,无需进一步配置。不过,随着项目的增长,添加基本配置也是有价值的。
要运行PHPStan,只需执行以下命令(<path>
仅在配置文件中不存在时需要)
vendor/bin/phpstan analyse <path>
插件之间的依赖关系
除了WordPress和WooCommerce,有时还需要分析插件之间的依赖关系,例如在开发基础插件扩展时,PHPStan需要了解依赖插件的代码库。
在这种情况下,有必要使用存根生成库为依赖插件生成存根。尽量将其安装为系统范围内的实用工具,而不是作为插件的包。
composer global require php-stubs/generator
借助这个库,您将能够为PHPStan目的提供对依赖代码库的只读访问。使用stub
扩展忽略文件,以便您的编辑器分析器忽略它。
generate-stubs --out=/path/to/.stubs/dependency.stub -- /path/to/dependency/src
记住,当上游插件发生重要更改时,请重新生成存根。
最后,将生成的存根包含到您的PHPStan配置中。
parameters:
scanFiles:
- .stubs/dependency.stub