VSCode WeChat Book
在 VS Code 底栏阅读微信读书。
VSCode WeChat Book 是一个 VS Code 插件,可以将微信读书的当前书籍正文同步到 VS Code 状态栏中显示。它支持绑定 API Key、选择书籍、更新网页登录态、自动拉取阅读进度、短句分页显示以及翻页同步进度。
适合想在写代码、学习、查资料时轻量阅读微信读书内容的用户。
功能特性
- 绑定微信读书
API Key
- 从书架中选择或重选当前阅读书籍
- 支持更新微信读书网页登录态:
Cookie 或 /web/book/read 的 cURL
- VS Code 启动后自动拉取阅读进度
- 在 VS Code 底栏按短句显示正文
- 正文章节懒加载,避免一次性抓取整本书
- 后台自动预缓存后续
5 章
- 翻页时可自动同步阅读进度到微信读书
- 进入阅读模式后支持方向键:左右翻句、上下翻章
- 支持老板键退出阅读模式并隐藏底栏内容
效果说明
正文会显示在 VS Code 底部状态栏中。
由于状态栏空间有限,插件会优先将正文切分为 50 字以内的短句进行显示。如果某一句本身较长,会尽量在合适的标点处截断,保证阅读体验更自然。
安装方式
目前请通过本地打包安装。
npm install
npm run package
然后在 VS Code 中安装生成的 .vsix 文件。
也可以通过命令行安装:
code --install-extension vscode-wechat-book-*.vsix
使用流程
1. 配置微信读书 API Key
打开 VS Code 命令面板,执行:
微信读书: 输入 API Key
然后粘贴以 wrk- 开头的微信读书 API Key。
2. 选择当前阅读书籍
继续在命令面板执行:
微信读书: 选择/重选当前阅读书籍
插件会读取你的书架列表,选择一本书后即可开始阅读。
选书完成后,插件会立即刷新底栏正文,并进入阅读模式。
3. 配置网页登录态
第一次读取正文时,插件会提示你粘贴微信读书网页版的登录态。
支持两种方式:
- 微信读书网页版的
Cookie
/web/book/read 请求对应的 cURL
后续如果登录态失效,可以随时执行:
微信读书: 更新登录态(Cookie / cURL)
常用命令
| 命令 |
说明 |
微信读书: 输入 API Key |
设置微信读书 API Key |
微信读书: 选择/重选当前阅读书籍 |
从书架选择当前阅读书籍 |
微信读书: 更新登录态(Cookie / cURL) |
更新网页版 Cookie 或 cURL |
微信读书: 刷新当前位置 |
重新加载当前阅读位置 |
微信读书: 上一句 |
手动跳到上一句 |
微信读书: 下一句 |
手动跳到下一句 |
微信读书: 上一章 |
手动跳到上一章开头 |
微信读书: 下一章 |
手动跳到下一章开头 |
微信读书: 老板键(隐藏) |
退出阅读模式并隐藏状态栏内容 |
阅读模式
当底栏正在显示正文时,插件会自动进入阅读模式。
阅读模式下:
- 只有编辑器文字区域处于焦点状态时,翻页和翻章快捷键才会生效
- 重新进入阅读模式或手动刷新当前位置时,会先同步一次远端阅读位置
- 左右方向键用于翻句
- 上下方向键用于翻章
- 老板键用于退出阅读模式并隐藏底栏
- 常见输入、删除、回车、粘贴、撤销等编辑操作会被拦截,避免误操作
如果你只是想重新同步到当前阅读位置,可以执行 微信读书: 刷新当前位置。
快捷键
macOS
| 快捷键 |
功能 |
Cmd + M |
退出阅读模式并隐藏底栏内容 |
Cmd + ; |
进入阅读模式 |
Left |
编辑器文字聚焦且处于阅读模式时:上一句 |
Right |
编辑器文字聚焦且处于阅读模式时:下一句 |
Up |
编辑器文字聚焦且处于阅读模式时:上一章 |
Down |
编辑器文字聚焦且处于阅读模式时:下一章 |
Windows
| 快捷键 |
功能 |
Ctrl + M |
退出阅读模式并隐藏底栏内容 |
Ctrl + Alt + ; |
进入阅读模式 |
Left |
编辑器文字聚焦且处于阅读模式时:上一句 |
Right |
编辑器文字聚焦且处于阅读模式时:下一句 |
Up |
编辑器文字聚焦且处于阅读模式时:上一章 |
Down |
编辑器文字聚焦且处于阅读模式时:下一章 |
配置项
| 配置项 |
默认值 |
说明 |
vscodeWechatBook.pageSize |
50 |
底栏单条显示的目标最大字数 |
可以在 VS Code 设置中搜索 vscodeWechatBook 修改配置。
阅读机制
插件不会在启动时一次性抓取整本书,而是采用章节懒加载机制:
- 启动后读取当前书籍和阅读进度
- 加载当前章节内容
- 将正文切分为适合状态栏展示的短句
- 后台预缓存后续
5 章
- 翻页时自动同步微信读书进度
这样可以减少请求压力,也能让插件启动更快。
登录态说明
微信读书正文接口需要网页版登录态。
如果正文读取失败,通常是以下原因:
- Cookie 过期
- cURL 内容不完整
- 微信读书网页版登录状态失效
- 当前书籍无法通过网页接口读取
- API Key 无效或权限不足
可以重新执行:
微信读书: 更新登录态(Cookie / cURL)
隐私说明
插件需要保存以下信息以正常工作:
- 微信读书
API Key
- 微信读书网页版
Cookie 或 cURL 中提取出的登录态
- 当前选择的书籍信息
- 当前阅读进度
这些信息仅用于本地插件功能,不会主动上传到第三方服务器。
请不要将包含 Cookie、API Key 的日志、截图或配置文件公开提交到 GitHub。
开发
克隆项目:
git clone https://github.com/Pay4att/vscode-wechat-book.git
cd vscode-wechat-book
安装依赖:
npm install
启动开发调试:
npm run compile
然后在 VS Code 中按 F5 启动 Extension Development Host。
打包插件:
npm run package
Roadmap
注意事项
本项目仅用于个人学习和效率工具场景。
请遵守微信读书相关服务条款,不要将本插件用于批量抓取、内容分发或其他非个人阅读用途。
仓库地址
GitHub:
https://github.com/Pay4att/vscode-wechat-book
License
MIT