Scholar Writing Assistant

Scholar Writing Assistant 是一个面向中文法学学术写作的 VS Code / CodeArts 插件。它把 Markdown 手稿、法学引注、中文排版、修辞诊断、提示词管理和写作技能调度放在同一个编辑器工作流里。

当前文档对应代码版本：0.1.3。

核心能力

• 中文排版：空白清理、中英文间距、智能引号配对。
• 法学引注：选区引注格式化、全文引注诊断与格式化。
• 学术分析：Workspace LLM 快捷入口、Direct request、Prompt Studio、选区改写、论证审计、模板导入。
• 写作技能：内置 Claude Scholar Skills，可继续导入本地技能目录，并根据选中文本生成技能 prompt。
• 修辞工具：修辞动作标注、句型检索、写作仪表盘。
• Flow Engine：语域断裂检测、语流预期检验，帮助检查段落从具体事实跳回抽象论断时是否缺少过渡。
• 导出：Markdown 手稿导出为 Word .docx。

快速开始

npm install
npm run build
npm test
node test/test-basic.js

在 VS Code 或 CodeArts 中打开本目录，按 F5 启动扩展开发宿主。也可以运行：

bash final-verify.sh

主界面

安装插件后，VS Code 左侧 Activity Bar 会出现 Scholar 图标。打开后可以看到 Workspace (Dashboard)、LLM Inspector、Diagnostics、Flow Engine、Library 五个视图。Library 把原先的 Skills / Templates / Prompts 合并成一个三段式树视图。

Workspace 顶部提供 LLM 操作区，可直接发送自由请求、打开 Prompt Studio、进入 API 设置或跳转到 LLM Inspector。LLM Inspector 会显示当前 LLM 设置、最近一次最终发送给模型的 prompt、请求状态和返回结果落点，也可以直接输入一次自由请求。

韵律引擎（可选）

编辑器实时诊断中的句长、并列、否定堆叠和嵌套提示默认走插件自带的 fallback 实现：依赖少、零配置即可用，但精度低于完整版（hanyu-prosody-lab）。

若你拥有 hanyu-prosody-lab 源码，可以在 VS Code 设置里指向它的 engine/ 目录：

• 设置项：writingAgent.prosody.enginePath
• 取值：完整版 engine/ 目录的绝对路径，例如 /Users/<you>/path/to/hanyu-prosody-lab/prosody-diagnose/engine
• 留空时使用 fallback。

修改设置后插件会自动重启 sidecar，无需重载窗口。

常用命令

• Scholar: Format Document (中文排版)
• Scholar: Format Selected Citation (法学引注)
• Scholar: Format All Citations in Document
• Scholar: Ask LLM (自由请求)
• Scholar: Prompt Studio (学术分析)
• Scholar: 改写/审计选中文本
• Scholar: Writing Dashboard (写作仪表盘)
• Scholar: Detect Register Shifts (语域断裂检测)
• Scholar: Expect-Next Flow Check (语流预期检验)
• Scholar: Save Prompt (保存提示词)
• Scholar: Export to Word (.docx)

快捷键

• Cmd/Ctrl + Shift + ;：格式化当前 Markdown 文档。
• Cmd/Ctrl + Shift + C：格式化选中引注。
• Cmd/Ctrl + Shift + K：根据选区调度写作技能。
• Cmd/Ctrl + Shift + T：打开 Prompt Studio。
• Cmd/Ctrl + Shift + R：改写或审计选中文本。
• Cmd/Ctrl + Shift + E：导出 Word。
• Cmd/Ctrl + Shift + D：打开写作仪表盘。
• Cmd/Ctrl + Shift + '：对选中句子运行语流预期检验。

API 配置

在 VS Code 设置中配置：

需要调用 LLM 的功能包括 Prompt Studio、选区改写、修辞动作识别、语域断裂检测和语流预期检验。

验证与打包

npm run build
npm test
node test/test-basic.js
npm run package:vsix

构建链路说明：

• npm run compile：运行 TypeScript 编译，输出 out/，用于类型检查和 smoke test。
• npm run bundle：用 esbuild 将 VS Code 扩展入口打包为 dist/extension.js。
• npm run build：先 compile，再 bundle，也是调试和发布前的默认构建命令。
• npm run package:vsix：运行 vscode:prepublish，生成只包含 bundle、资源文件和 Python sidecar 的 VSIX。

VSIX 产物路径：

dist/scholar-writing-assistant-<version>.vsix

发布包边界：

• 包含：dist/extension.js、resources/、python/、README.md、LICENSE、package.json。
• 不包含：src/、out/、test/、node_modules/、.vscode/、本地脚本和旧调试文件。

项目结构

• src/core/formatEngine/：中文排版、引号、引注。
• src/core/promptStudio/：学术分析模板。
• src/core/skillDispatcher/：本地技能导入与 prompt 生成。
• src/core/flowEngine/：语域断裂与语流预期检验。
• src/providers/：VS Code 命令、TreeView、webview、diagnostics。
• resources/：webview 静态资源和内置 Claude Scholar Skills。
• test/：Vitest 单元测试和 smoke test。

许可证

MIT