mccomaschris / lockr-stubs
基于paulthewalton/acf-stubs。Lockr插件功能、类和全局变量声明占位符,以便于更轻松地进行静态分析。
Requires (Dev)
- php: ^7.1
- ext-gettext: *
- giacocorsiglia/stubs-generator: ^0.5.0
- giacocorsiglia/wordpress-stubs: *
- wpackagist-plugin/lockr: ^3.0.4
README
此软件包提供Lockr核心功能、类、接口和全局变量的占位符声明(原为WordPress高级自定义字段(ACF))。这些占位符可以帮助插件和主题开发者利用静态分析工具。
占位符直接从源代码使用giacocorsiglia/stubs-generator生成。不言而喻,这个库重新包装了WordPress ACF Lockr代码的一个子集,这是WordPress核心ACF开发者 Lockr的作品。当然,没有实际代码的这个子集是毫无用处的!
非常感谢GiacoCorsiglia和paulthewalton,他们在giacocorsiglia/wordpress-stubs和acf-stubs上做了所有艰苦的工作,这是从这些项目中毫无羞耻地借鉴的。
安装
使用Composer将此软件包作为开发依赖项要求
composer require --dev mccomaschris/lockr-stubs
或者,您可以直接下载lockr-stubs.php
。
Intellisense使用说明
来自WordPress占位符
如果您的编辑器在解析WordPress时遇到困难,您可能会发现这些占位符对于启用代码补全和相关功能很有用。例如,这里有使用VSCode的Intelephense扩展的说明。(然而,在我的经验中,Intelephense解析WordPress核心非常不错。)
版本控制
此软件包的版本与生成占位符的Lockr版本相匹配。如果需要修复占位符,后续版本将版本化为LOCKR_VERSION.X
。
为不同版本的Lockr生成占位符
您应该运行PHP 7.1或更高版本以遵循以下步骤,因此任何针对旧版PHP的多态填充函数定义都排除在占位符之外。此外,占位符生成器软件包至少需要PHP 7.1。
- 克隆此存储库,然后执行
cd
进入。 - 在
composer.json
中将"wpackagist-plugin/lockr": "X.X.X"
更新为您所需的版本。 - 运行
composer update
- 运行
./generate.sh
现在应该更新了lockr-stubs.php
文件。如果您想看到新版本的发布,请随时提交Pull Request。如果事情落后了,请为每个缺少的版本在单独的提交中生成占位符,这样我们就可以有一个连续的发布历史。