跳转到主要内容

从工具包迁移

@grafana/toolkit 工具现已 弃用。如果您仍然使用 @grafana/toolkit 来构建和开发插件，请遵循此指南以迁移到我们最新的插件工具。

警告

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

迁移到 create-plugin 工具的好处​

  • 更灵活：使用 create-plugin，您可以更好地控制插件及其依赖项。这种额外的控制使您能够更轻松地自定义工具以适应您的特定需求。
  • 更快的开发：create-plugin 提供了开箱即用的开发环境，与使用 grafana-toolkit 相比，可以显著缩短开发时间。
  • 改进的测试能力：使用 create-plugin GitHub 工作流程轻松测试插件，这些工作流程会在您将更改推送到 GitHub 时自动运行单元和端到端测试。
  • 技术支持：由于 grafana-toolkit 已弃用，因此不再由 Grafana 支持。
  • 更好的文档：与 grafana-toolkit 相比，create-plugin 的文档更全面且更容易发现。

将您的插件迁移到 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 或 社区论坛 上寻求帮助。