VSCode怎么配置Storybook开发_VSCode Storybook组件文档与预览配置

落晨吖_6243

落晨吖_6243

2026-05-26

894人浏览

原创

VSCode本身不运行Storybook,所有预览失败问题90%源于服务未启动;必须先执行npm run storybook确认终端输出Local: http://localhost:6006/,再排查端口占用、main.js配置、文件命名与导出一致性。

vscode怎么配置storybook开发_vscode storybook组件文档与预览配置

VSCode 本身不运行 Storybook,所有“预览失败”“跳转 404”“热更新不动”的问题,90% 都是因为 npm run storybook 根本没成功跑起来——先确认服务在终端里真起来了,再谈配置。

为什么点「Open Preview」还是 ERR_CONNECTION_REFUSED

这不是插件坏了,是本地 Storybook 进程压根没启动或启动失败。

  • 必须在项目根目录执行 npm run storybook(或 yarn storybook),且终端输出中明确出现 Local: http://localhost:6006/ —— 没这行,后面全白搭
  • 如果卡在 Building preview 超过 90 秒,大概率是依赖解析失败或 TypeScript 类型检查阻塞,可加 --no-manager-cache 重试
  • ERR_CONNECTION_REFUSED 时立刻查端口:macOS/Linux 运行 lsof -i :6006,Windows 运行 netstat -ano | findstr :6006,杀掉占用进程
  • 端口可改,但必须同步改两处:.storybook/main.js 中的 port: 6007,以及 .vscode/settings.json 中的 "storybook.previewUrl": "http://localhost:6007"

右键没有「Open Story for Current File」选项

插件不是“装了就生效”,它靠 .storybook/main.js 里的 stories 字段扫描文件路径,路径错、后缀错、导出名错,菜单直接消失。

  • stories 必须是数组格式,例如:stories: ['../src/**/*.stories.@(js|jsx|ts|tsx)'] —— 注意 **/ 和括号语法,漏一个字符就扫不到
  • 文件名必须严格匹配:Button.stories.tsx ✅,Button.story.tsx ❌,button.stories.tsx ❌(大小写敏感)
  • 默认导出名必须和组件名一致:Button.stories.tsx 里要 export default Button 或 export const Button = { ... },否则插件无法关联到 Button.tsx
  • monorepo 场景下,插件只认当前工作区根目录的 .storybook/,子包里的配置无效;需在每个含 Storybook 的包内单独配

修改代码后 Storybook 不热更新

不是 VSCode 的锅,是 Storybook 的 HMR(热模块替换)被关了或监听范围错了,尤其 Vite 用户容易踩坑。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • Vite 构建(Storybook v7+ 默认)需确认 .storybook/main.js 启用了 watchOptions,且没被覆盖
  • 检查项目根目录的 vite.config.ts:若存在 server.hmr.overlay = false 或 server.watch.ignored: [/node_modules/, /dist/] 里误加了 /src/,HMR 就会静默失效
  • 终端若出现 HMR disconnected 或 Failed to load module,优先看这行错误前后的 timestamp 和上下文,不是刷新页面能解决的
  • 禁止在 *.stories.tsx 里调用未导出的工具函数、用 require() 动态导入、或写副作用逻辑(如 useEffect(() => { fetch(...) })),这些都会断连 HMR

想在 VSCode 侧边栏直接预览组件,不是打开浏览器

VSCode 原生不渲染网页,所谓“内嵌预览”只是用 Webview 加载你已启动的 http://localhost:6006 页面,所以一切依赖服务可用 + URL 正确。

  • 装好官方插件 Storybook for VS Code 后,在命令面板(Cmd+Shift+P / Ctrl+Shift+P)输入 Storybook: Open Preview 或 Storybook: Open Preview to the Side
  • 必须提前在 .vscode/settings.json 中写死预览地址:"storybook.previewUrl": "http://localhost:6006",否则 Webview 加载空白
  • 预览页跳转到 404?不是插件问题,是 Storybook 自身没注册该 story ID——回头检查文件名、glob 路径、导出名三者是否完全一致
  • Webview 不支持 DevTools 调试,真要断点请用 .vscode/launch.json 配 Chrome 附加调试,url 设为 http://localhost:6006,webRoot 设为 "${workspaceFolder}"

最常被忽略的一点:所有配置都依赖 .storybook/main.js 文件真实存在且语法合法。哪怕多一个逗号,npm run storybook 可能静默失败,终端也不报错,只卡在构建阶段——建议每次改完 main.js 都手动运行一次命令验证。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1495

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

3192

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

2069

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1747

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2627

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1858

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1282

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1136

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

534

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程