在 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 相關的開發工作,不妨嘗試一下這個庫。