Storybook 插件 Storybook 背包版本切换器

切换背包版本

开发脚本

• yarn start 在观察模式下运行 babel 并启动 Storybook
• yarn build 构建并打包您的插件代码

从 TypeScript 切换到 JavaScript

不想使用 TypeScript？我们提供了一个方便的弹出命令：yarn eject-ts

这将把所有代码转换为 JS。这是一个破坏性的过程，因此建议您在开始编写任何代码之前运行它。

包含哪些内容？

插件代码位于 src 中。它演示了所有与插件相关的核心概念。这三个 基于 UI 的插件范式

• src/Tool.tsx
• src/Panel.tsx
• src/Tab.tsx

它们与插件本身一起在 src/manager.ts 中注册。

管理状态并与故事交互

• src/withGlobals.ts & src/Tool.tsx 演示了如何使用 useGlobals 来管理全局状态并修改故事的内容。
• src/withRoundTrip.ts & src/Panel.tsx 演示了使用通道进行双向通信。
• src/Tab.tsx 演示了如何使用 useParameter 来访问当前故事的参数。

您的插件可能使用其中一种或多种模式。您可以随意删除未使用的代码。相应地更新 src/manager.ts 和 src/preview.ts。

最后，在 src/constants.ts 中配置您的插件名称。

元数据

Storybook 插件列在 目录 中，并通过 npm 分发。目录通过查询 npm 注册表中的 package.json 中的 Storybook 特定元数据来填充。此项目已配置了示例数据。有关可用选项的更多信息，请参阅 插件元数据文档。

发布管理

设置

此项目配置为使用 auto 进行发布管理。它会生成一个变更日志，并将其推送到 GitHub 和 npm。因此，您需要配置对这两个平台的访问权限

• NPM_TOKEN 创建一个具有读取和发布权限的令牌。
• GH_TOKEN 创建一个具有 repo 范围的令牌。

然后打开您的 package.json 并编辑以下字段

• name
• author
• repository

本地

要在本地使用 auto，请在项目的根目录中创建一个 .env 文件，并将您的令牌添加到其中

GH_TOKEN=<value you just got from GitHub>
NPM_TOKEN=<value you just got from npm>

最后，**在 GitHub 上创建标签**。您将在将来修改包时使用这些标签。

npx auto create-labels

如果您在 GitHub 上查看，您现在将看到一组 auto 希望您使用的标签。使用这些标签来标记未来的拉取请求。

GitHub Actions

此模板附带已设置的 GitHub Actions，以便在有人推送到您的存储库时发布您的插件。

转到 设置 > 密钥，单击 新建存储库密钥，然后添加您的 NPM_TOKEN。

创建发布

要本地创建发布，您可以运行以下命令，否则 GitHub Actions 将为您进行发布。

yarn release

这将

• 构建并打包插件代码
• 更新版本
• 将发布推送到 GitHub 和 npm
• 将变更日志推送到 GitHub