VSCode配置Storybook开发环境 组件预览与测试教程【指南】

阿强姑娘_1854

阿强姑娘_1854

2026-05-24

608人浏览

原创

vscode不运行storybook,所有预览失败等问题90%源于npm run storybook未成功启动;需确认终端输出local: http://localhost:6006/,排查端口占用、构建错误、配置路径、hmr监听及隔离性问题。

vscode配置storybook开发环境 组件预览与测试教程【指南】

VSCode 本身不运行 Storybook,所有“预览失败”“跳转空白”“热更新不动”的问题,90% 都是因为 npm run storybook 根本没成功启动——先确认服务跑起来,再谈集成。

npm run storybook 启动后报 ERR_CONNECTION_REFUSED

这不是 VSCode 的错,是本地服务压根没绑定到端口。常见于端口被占、命令卡死或配置未生效。

  • 终端执行 npm run storybook 后,必须看到类似 Local: http://localhost:6006/ 的输出行;如果卡在 Building preview... 超过 90 秒,大概率构建失败,检查终端顶部是否有 ERROR 或依赖缺失提示
  • macOS/Linux 运行 lsof -i :6006,Windows 运行 netstat -ano | findstr :6006 查端口占用,杀掉对应 PID 后重试
  • .storybook/main.js 中可改端口(如 port: 6007),但改完必须重启服务,VSCode 不会自动感知变更
  • 某些 Vite + Storybook v7+ 项目默认用 storybook dev -p 6006,若 package.json 里还写着旧版 start-storybook,会直接报 command not found

装了 Storybook for VS Code 插件却没右键菜单

插件不自动注入菜单,它只根据 .storybook/main.js 的 stories 字段扫描文件路径——路径错、文件名错、导出名错,菜单就消失。

VSCode
VSCode

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

下载
  • stories 必须是数组,且 glob 要能覆盖你的文件位置,例如组件在 src/components/Button.stories.tsx,则 stories: ['../src/**/*.stories.@(js|jsx|ts|tsx)'] 才有效;写成 ['./src/**/*'] 或漏掉 **/ 就扫不到
  • 文件名必须严格匹配 .stories.(注意两个点),Button.story.tsx、button.stories.ts、Button.stories.test.tsx 全部不识别
  • 默认导出名必须和文件 basename 一致:Button.stories.tsx 要 export default Button;若用具名导出,需配 export const Button = { ... },否则插件无法关联到 Button.tsx
  • monorepo 中,插件只读取当前工作区根目录下的 .storybook/,子包里的配置无效,得在每个含 Storybook 的包里单独配

修改组件代码后 Storybook 不热更新

不是 VSCode 没保存,是 Storybook 的 HMR(热模块替换)链路断了——Vite 或 Webpack 的监听范围、overlay 设置、甚至 require() 写法都可能让它静默失效。

  • Vite 用户重点检查 vite.config.ts:若含 server.hmr.overlay = false 或 server.watch.ignored: [/node_modules/, /dist/] 里误加了 /src/,HMR 直接关闭
  • .storybook/main.js 中确保没覆盖 watchOptions,v7+ 默认开启,但手动设成 { ignored: ['**/node_modules/**'] } 是安全的;设成 { ignored: ['**'] } 就等于关监听
  • 禁止在 *.stories.tsx 里调用未导出的工具函数、或用 require('./utils') 动态导入——HMR 只能追踪 ES Module 静态导入链
  • 如果用了 preview.js(非 preview.ts),检查是否漏了 parameters: { docs: { autodocs: true } } 等配置,部分参数缺失会导致 HMR 初始化失败

VSCode 侧边栏预览打不开或显示空白

VSCode 的 Webview 只是加载一个已存在的 http://localhost:6006 页面,它不接管服务生命周期。预览失败 = 服务不可达 + 配置未对齐。

  • 必须在 .vscode/settings.json 里显式写 "storybook.previewUrl": "http://localhost:6006";不配这个,右键 “Open Preview to the Side” 会 fallback 到默认地址,大概率 404
  • “Open Story for Current File” 和 “Open Preview to the Side” 是两件事:前者跳转 URL,后者加载整个 Storybook UI;后者依赖前者生成的 URL 正确,所以先确保右键菜单能出来
  • Webview 加载缓慢或白屏,先在浏览器里手动打开 http://localhost:6006 确认服务可访问;如果浏览器也白屏,问题一定在 Storybook 构建层,不是 VSCode
  • 某些企业网络策略会拦截 localhost 的 WebSocket 连接(HMR 依赖它),此时即使页面渲染出来,改代码也不会刷新——需联系 IT 开放 ws://localhost:6006

最常被忽略的一点:Storybook 的隔离性完全由它自己的运行时沙箱保证,VSCode 插件只是个遥控器。哪怕所有跳转、预览、热更都看似正常,只要 .storybook/preview.js 里混入了主应用的全局状态初始化逻辑,组件就不是真隔离——这点没法靠插件检测,得人工 review。

相关文章

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

1175

18

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

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

2023.07.21

2352

3

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

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

2024.03.14

1809

12

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

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

2024.03.14

1627

8

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

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

2024.03.15

2507

12

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

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

2024.03.15

1778

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1222

10

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

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

2024.03.15

1076

8

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

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

2024.03.15

414

5

热门下载

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

精品课程

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