网文助手（Writer Helper）
面向网络小说写作场景的 VS Code 扩展，提供“写作仪表盘、状态栏统计、元数据高亮、AI 助理”等能力，帮助你保持专注与节奏。
核心功能
元数据高亮与管理
- 支持四类元数据：角色、世界、技能、物品。
- 名称匹配兼容中文（不使用单词边界），以不同颜色高亮；可为每项添加备注。
- 可通过命令快速开/关高亮，便于专注排版或校对。
- 支持自定义绑定【角色设定、世界设定、技能设定等】文档，默认通过如【张三】进行绑定。
写作仪表盘
- 显示当前文档字数、今日码字速度（字/小时）、写作/发呆时长。
- 项目级“插件激活”开关（默认关闭），开启后开始统计并在面板与状态栏同步更新。
- 面板左侧展示扩展版本、作者邮箱与微信交流群二维码入口，便于沟通与反馈。
状态栏统计
- 实时显示字数、速度（每小时）与时长，写作节奏一目了然。
配置面板:
- 标签页组织：人物设定、世界设定、技能设定、物品设定、场景设定、AI 助助配置等。
- 即时保存：修改后自动持久化到工作区设置与配置文件,可自定义你的文档，通过匹配符号自动识别元数据。
- AI 内联菜单：可按语言白名单显示（如
markdown, plaintext），避免在代码文件干扰写作。
AI 助理
- 续写命令支持“偏好选择”（如叙事推进、情感渲染等），作为系统提示影响输出风格。
- 可在“AI 助助配置”中设置模型名称、API 地址与密钥，调整 System 提示词。
- 支持 AI 扩写、AI 改写、AI 续写、自定义描写等功能
快速开始
- 打开 VS Code，进入侧栏“Writer Helper”视图，打开“写作仪表盘”。
- 在仪表盘左上卡片点击“启用插件”，开始统计写作数据。
- 点击仪表盘中的“打开元数据文档/配置”进入配置面板，维护角色、世界、技能、物品与备注。
- 使用命令面板搜索并执行：
Writer Helper: 打开配置（writerHelper.openConfig）Writer Helper: 重置今日统计（writerHelper.resetDailyStats）Writer Helper: 切换元数据高亮（writerHelper.toggleMetadataHighlight）
配置说明
工作区设置
writerHelper.enabled：是否启用本项目统计与高亮（默认 false）。
AI 助助配置（在“AI 助助配置”页）：
- 模型与接口：设置模型名称、
API URL 与 API Key。
- System 提示词：用于控制 AI 的整体写作风格与约束。
- 内联菜单语言白名单：仅在指定语言（如
markdown, plaintext）显示 AI 内联入口。
交流与反馈
- 邮箱：
184425506@qq.com
- 微信交流群：见仪表盘左侧二维码（或直接打开
resources/wechat_qun.jpg）。
开发与调试
- 使用 VS Code 打开本项目，按
F5 以“扩展开发主机”运行进行调试。
- 如需构建，请使用项目的包管理器安装依赖并按需运行编译脚本（例如
pnpm install 后运行对应构建任务）。
已知注意事项
- 直接用静态方式打开 Webview HTML（例如从文件系统预览）会看到
{{scriptUri}} 等占位符未替换，这是预期行为；在 VS Code 扩展中会被正确替换，不影响实际功能。
版本记录
0.0.3
- 仪表盘显示扩展版本、邮箱与微信群入口；支持点击缩略图打开二维码文件。
- 新增 AI 续写偏好 QuickPick，影响系统提示词；新增内联菜单语言白名单配置。
0.0.1
- 初始发布：元数据管理与备注、字体色高亮、写作仪表盘、状态栏统计、项目级激活开关。
自动化发布（GitHub Actions）
- 已内置工作流：
.github/workflows/release.yml。
- 触发方式：推送格式为
v* 的 tag（例如 v1.0.0）。
- 工作流步骤：
- 使用 pnpm 安装依赖并构建（
pnpm run package）。
- 使用
vsce package 生成 *.vsix，并作为构件与 Release 资产上传。
- 若在仓库 Secrets 设置
VSCE_TOKEN，将自动执行 vsce publish 发布到 VS Code Marketplace。
使用指南
- 确保
package.json 的 version 与 tag 名称一致（如 1.0.0 对应 v1.0.0）。
- 在 GitHub 仓库设置 Secrets：
VSCE_TOKEN：在 VSCode Marketplace 生成的 Personal Access Token。
- 推送 tag：
git tag v1.0.0 && git push origin v1.0.0- 或在 GitHub UI 上创建新 tag 与 Release。
工作流会自动将 README 中的图片链接重写为可访问的绝对地址（通过 --baseContentUrl 与 --baseImagesUrl）。
| |
