Storybook 插件组件 AI 文档

此插件将为您提供有关显示组件的文档。因此，您的代码库的新用户可以阅读如何使用它

开发脚本

• 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 并编辑以下字段

• 名称
• 作者
• 存储库

本地

要在本地使用 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 操作将为您进行发布。

yarn release

这将

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