在 woocommerce 插件或主题开发中,静态分析工具如 phpstan 可以极大地帮助我们提高代码质量。然而,这些工具在处理 woocommerce 特定的函数和类时,常常会因为缺乏相应的声明而无法正确识别,导致分析结果不准确。为了解决这个问题,我尝试了多种方法,最终找到了一个名为 php-stubs/woocommerce-stubs 的库。
php-stubs/woocommerce-stubs 是一个专门为 WooCommerce 插件函数、类和接口提供声明桩的库。这些声明桩可以帮助开发者在 ide 中获得更好的代码补全功能,同时也能让静态分析工具正确识别 WooCommerce 的代码结构。
安装这个库非常简单,只需要通过 composer 将其作为开发依赖项引入即可:
composer require --dev php-stubs/woocommerce-stubs
如果你更喜欢手动下载,也可以直接下载 woocommerce-stubs.php 文件。
为了让 PHPStan 识别这些声明桩,你需要在 PHPStan 的配置文件中包含这些桩文件:
立即学习“PHP免费学习笔记(深入)”;
parameters: bootstrapFiles: - vendor/php-stubs/woocommerce-stubs/woocommerce-stubs.php #- vendor/php-stubs/woocommerce-stubs/woocommerce-packages-stubs.php
使用 php-stubs/woocommerce-stubs 后,我的开发环境中的代码补全变得更加智能,PHPStan 也能够更准确地分析 WooCommerce 相关的代码。这不仅提升了开发效率,还提高了代码的可靠性和可维护性。
此外,需要注意的是,php-stubs/woocommerce-stubs 的维护者 Viktor 表示,由于维护成本高昂,他计划停止对 WordPress 生态系统的贡献。如果你觉得这个库对你的开发工作有帮助,请考虑支持他的工作,以确保这个有价值的工具继续得到维护。
总的来说,php-stubs/woocommerce-stubs 是一个非常实用的工具,能够显著提升 WooCommerce 开发中的静态分析和代码补全效果。如果你也在进行 WooCommerce 相关的开发工作,不妨尝试一下这个库。