加入直播会议:周四,美国东部时间上午 11 点,Storybook 9 发布及问答会
文档
Storybook 文档

创建复现

一个可复现的测试用例可以帮助你定位问题的根源,这是解决问题的第一步!本页概述了如何进行设置以创建复现。

为什么要创建复现?

一个可复现的测试用例是分享导致 bug 的特定条件集的绝佳方式。它允许维护者和社区验证、缩小问题原因的范围,并帮助你解决问题。

先决条件

确保你已具备以下条件:

初始设置

首先,打开终端并运行以下命令:

npx storybook@next sandbox

你可以在命令中附加模板名称以获取筛选结果(例如,npx storybook@next sandbox react)。

接下来,选择你想要使用的模板:

Storybook reproduction generator template

最后,输入复现的存放位置:

Storybook reproduction location

如果你没有为复现提供完整路径,它将在当前目录中生成。

如果一切正常,你应该已经在本地环境中设置好了一个功能完整的 Storybook。

第三方依赖和插件

在添加代码之前,安装并配置所有必要的包。例如,如果你在使用 CSS 框架(例如,Tailwind)时遇到问题,你应该安装并配置它。

安装并配置任何与问题相关的 Storybook 插件(例如,@storybook/addon-a11y)。

添加故事

任何 Storybook 复现都离不开故事。为了更快地帮助解决你的问题,我们鼓励你包含最少量的能够重现问题的故事。

托管

完成工作后,你需要托管你的复现。首先登录 GitHub.com 并创建一个新的仓库

github repository for reproductions

然后,按照 GitHub 的说明设置仓库。

github repository instructions

别忘了将your-username替换为你自己的账户名。

发布

检查复现的一个绝佳方法是将其部署到线上。我们推荐Chromatic,这是一个由 Storybook 维护者创建的免费发布服务。它允许你在云端安全可靠地部署和托管你的复现。

使用 Chromatic 时的有用资源

提交问题

最后,在Storybook 问题跟踪器中创建你的问题,按照所需步骤操作,并提供问题的详细描述。添加 GitHub 仓库和已部署的复现,以帮助分类处理。