axepress/wp-graphql-stubs

为静态分析提供 WPGraphQL 函数和类声明占位符。

v1.29.0 2024-09-20 01:43 UTC

This package is auto-updated.

Last update: 2024-09-20 01:44:13 UTC


README

WPGraphQL 核心函数、类和接口提供占位符声明。这些占位符可以帮助插件和主题开发者利用静态分析工具,如 PHPStan

占位符是用 php-stubs/generator 生成的。

要求

  • PHP 7.3+
  • Sodium PHP 扩展,因为最新版本的 WordPress 核心使用它,并且从占位符中移除了兼容代码。

安装

使用 Composer 将此包作为开发依赖项要求。

composer require --dev axepress/wp-graphql-stubs

或者您可以直接下载 wp-graphql-stubs.php

与 PHPStan 一起使用

composer require --dev szepeviktor/phpstan-wordpress axepress/wp-graphql-stubs

szepeviktor/phpstan-wordpress 依赖于 phpstan/phpstan。请务必阅读那个包的 README,并查看那里的 example 目录。

版本控制

此包的版本与生成的占位符所依据的 WPGraphQL 版本相匹配。

当对实际的占位符生成进行更改并需要新的发布版本时,旧版本将被 删除,并创建一个格式为 x.x.x+repack.y 的新标签,其中 x.x.x 是 WPGraphQL 版本,y 是重新打包迭代。这是必要的,因为 Composer 的 SemVer 实现在确定最新版本时忽略了构建元数据。

如果您已经安装了旧版本的构建,您需要运行 composer update --no-cache 以获取最新的重新打包。

为不同的 WPGraphQL 版本生成占位符

  1. 克隆此存储库并 cd 进入。
  2. composer.json 中将 "wpackagist-plugin/wp-graphql": "x.x.x" 更新为所需的版本
  3. 运行 composer update
  4. 运行 composer generate

现在 wp-graphql-stubs.php 文件应该已更新。

先验技术