插件 SDK 参考

页面摘要： Plugin SDK 是一组来自 @strapi/sdk-plugin 的命令，用于在本地或为 NPM 和 Marketplace 创建、构建、链接和发布 Strapi 插件。

Plugin SDK 是由 @strapi/sdk-plugin 包提供的一组命令，围绕开发插件而设计，既可将插件用作本地插件，也可将其发布到 NPM 和/或提交到 Marketplace。

本文档列出了可用的 Plugin SDK 命令。相关指南说明了如何使用这些命令从零开始创建插件、将其链接到现有项目并发布它。

npx @strapi/sdk-plugin init

在给定路径创建一个新的插件。

npx @strapi/sdk-plugin init

Arguments	Type	Description	Default
`path`	string	插件的路径	`./src/plugins/my-plugin`

Option	Type	Description	Default
`-d, --debug`	-	启用带详细日志的调试模式	false
`--silent`	-	不记录任何日志	false

打包 Strapi 插件以进行发布。

strapi-plugin build

Option	Type	Description	Default
`--force`	string	对所有提示自动回答 “yes”，包括潜在破坏性的请求，并以非交互方式运行。	-
`-d, --debug`	-	启用带详细日志的调试模式	false
`--silent`	-	不记录任何日志	false
`--minify`	-	压缩输出	false
`--sourcemap`	-	生成 sourcemap	false

NOTE

从 v6 开始，构建配置会从你的 package.json 的 exports 字段自动推导。不再需要配置文件（例如 vite.config.ts 或 rollup.config.ts）。

使用 SDK Plugin v5（遗留）

如果你需要继续使用带有 @strapi/pack-up 的旧构建系统，可以固定到 5.x 版本：

Yarn

yarn add @strapi/sdk-plugin@5

NPM

npm install @strapi/sdk-plugin@5

SDK 插件的 5.x 版本支持 packup.config.ts 用于自定义构建配置。不过，出于安全更新和简化配置的考虑，推荐使用 v6。

在变更时自动重新编译插件，并运行 yalc push --publish。

出于测试目的，将你的插件链接到现有应用以在真实环境下进行试验会非常方便。此命令旨在帮助你简化这一过程。

strapi-plugin watch:link

Option	Type	Description	Default
`-d, --debug`	-	启用带详细日志的调试模式	false
`--silent`	-	不记录任何日志	false

监视插件源代码是否有任何变更，并在每次变更时重新构建它。在实现插件并在应用中测试插件时很有用。

strapi-plugin watch

Option	Type	Description	Default
`-d, --debug`	-	启用带详细日志的调试模式	false
`--silent`	-	不记录任何日志	false

在发布插件之前验证插件的输出。

strapi-plugin verify

Option	Type	Description	Default
`-d, --debug`	-	启用带详细日志的调试模式	false
`--silent`	-	不记录任何日志	false