PHPStan WordPress 扩展使用教程
1. 项目的目录结构及介绍
phpstan-wordpress/
├── examples/
│ └── phpstan.neon.dist
├── src/
│ ├── PHPStan/
│ │ └── WordPress/
│ │ ├── DynamicReturnTypeExtensions/
│ │ ├── Rules/
│ │ └── WordPressExtension.php
├── stub-generators/
├── tests/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .travis.yml
├── .typos.toml
├── LICENSE
├── README.md
├── bootstrap.php
├── composer.json
├── extension.neon
├── phpcs.xml.dist
├── phpstan.neon.dist
├── phpunit.xml.dist
examples/
: 包含示例配置文件。src/
: 包含扩展的核心代码。PHPStan/WordPress/
: 包含动态返回类型扩展和规则。
stub-generators/
: 存根生成器。tests/
: 测试文件。.editorconfig
,.gitattributes
,.gitignore
: 项目配置文件。.travis.yml
: Travis CI 配置文件。.typos.toml
: 拼写检查配置文件。LICENSE
: 许可证文件。README.md
: 项目说明文档。bootstrap.php
: 引导文件。composer.json
: Composer 配置文件。extension.neon
: PHPStan 扩展配置文件。phpcs.xml.dist
: PHP CodeSniffer 配置文件。phpstan.neon.dist
: PHPStan 配置文件示例。phpunit.xml.dist
: PHPUnit 配置文件。
2. 项目的启动文件介绍
bootstrap.php
是项目的引导文件,用于初始化 PHPStan 分析环境。它通常包含一些必要的初始化代码,确保 PHPStan 能够正确地分析 WordPress 插件和主题。
3. 项目的配置文件介绍
composer.json
Composer 配置文件,定义了项目的依赖关系和其他元数据。
{
"require-dev": {
"phpstan/phpstan": "^1.0",
"php-stubs/wordpress-stubs": "^5.0"
}
}
phpstan.neon.dist
PHPStan 配置文件示例,定义了分析级别和路径。
parameters:
level: 5
paths:
- plugin.php
- inc/
includes:
- vendor/szepeviktor/phpstan-wordpress/extension.neon
extension.neon
PHPStan 扩展配置文件,包含扩展的具体配置。
services:
- class: PHPStan\WordPress\WordPressExtension
通过这些配置文件,可以确保 PHPStan 能够正确地分析 WordPress 插件和主题,并提供必要的动态返回类型扩展和规则。