跳到主要内容

从工具包迁移

@grafana/toolkit 工具现在已经 弃用。如果你仍然使用 @grafana/toolkit 来搭建和开发插件，请按照本指南迁移到我们最新的插件工具。

警告

我们的插件工具使用 ReactJS。我们 不支持 用 Angular 编写的插件。

迁移到 create-plugin 工具的优势​

  • 更灵活：使用 create-plugin，你可以更好地控制你的插件及其依赖项。额外的控制意味着可以更容易地定制工具来满足你的特定需求。
  • 更快的开发：create-plugin 拥有开箱即用的开发环境，与 grafana-toolkit 相比，可以显著减少开发时间。
  • 改进的测试功能：create-plugin 的 GitHub 工作流可以轻松地测试插件，并在你将更改推送到 GitHub 时自动运行单元测试和端到端测试。
  • 技术支持：grafana-toolkit 工具已弃用，不再受 Grafana 支持。
  • 更好的文档：create-plugin 的文档比 grafana-toolkit 更全面，也更容易找到。

将你的插件迁移到 create-plugin​

  1. 备份所有当前文件。我们建议你将插件代码存储在 Git 仓库中，并在干净的分支上运行命令，以便你可以轻松识别迁移命令所做的更改。

  2. 在现有插件的根目录（包含 package.json 文件的地方）运行以下命令。

npx @grafana/create-plugin@latest migrate
  1. 按照出现的提示操作。请参阅以下列表，了解每个潜在提示的详细信息。

提示​

运行 migrate 命令时，会显示以下提示。由于这些提示具有破坏性，因此它们的默认值为 no。

以下文件将被覆盖。您要继续吗？​

选择 y 以替换插件目录中的以下文件和文件夹，或者在它们不存在时创建它们。

myplugin-directory/
├── .config/
├── .eslintrc
├── .nvmrc
├── .prettierrc.js
├── docker-compose.yaml
├── jest-setup.js
├── jest.config.js
└── tsconfig.json

以下文件是必需的。我们可以为您搭建它们吗？​

选择 y 以确保插件目录中存在 CHANGELOG.md 文件。

以下文件可能不再需要。您是否同意我们删除它们？​

选择 y 以删除插件目录中的以下文件和文件夹。

myplugin-directory/
├── Dockerfile
├── docker-compose.yml
├── webpack/
├── .webpack/
└── .prettierrc

您是否要更新 package.json 中的以下依赖项？​

选择 y 以更新提示中列出的所有 npm 依赖项。该命令故意避免更新 @grafana npm 依赖项，以减少迁移过程中的潜在冲突。

您是否要删除以下可能不再需要的 NPM 依赖项？​

选择 y 以删除 package.json 中找到的以下 npm 依赖项。

{
  "devDependencies": {
-   "ts-loader": "*",
-   "babel-loader": "*",
-   "@grafana/toolkit": "*"
  }
}

您是否要更新 package.json 中的脚本？所有使用 grafana-toolkit 的脚本都将被替换。​

此步骤会更新 package.json 文件中的任何 npm 脚本，以匹配最新的配置。所有以前使用 grafana-toolkit 的脚本都将被替换。

下一步​

迁移命令运行完成后，请执行以下步骤。

  1. 检查引入的更改，然后安装前端依赖项。

  2. 运行 package.json 中的每个 npm 脚本，以确认插件可以构建、测试和签名。

如果插件对工具包配置（例如 webpack）进行了定制，请参考 扩展配置，了解如何更新它们。

如果插件可以构建，但 Jest 测试存在问题，请参阅有关 es 模块的 Jest 高级配置 问题。

有关其他问题的帮助，请访问 Slack 或 社区论坛。