Trinka Markdown/LaTeX Linter
在 VS Code 中使用 Trinka Grammar Check API 检查 Markdown 和 LaTeX 文件中选中的英文段落,
并通过 Problems(问题)面板展示建议,支持对单条建议快速“应用(Apply)”或“拒绝(Reject)”。
功能
- 检查选中的段落(Markdown / LaTeX)中的英语语法与风格问题
- 将建议以 Diagnostics(问题)形式显示在 Problems 面板
- 在问题上通过 CodeAction(小灯泡)直接应用或拒绝单条建议
- 支持把 API Key 存入设置或 Secret 存储
安装(开发者)
- 克隆仓库并进入目录
git clone <repo-url>
cd writing-skill
- 安装依赖并编译
npm install
npm run build
- 在 VS Code 中按 F5 启动扩展主机进行调试
使用
- 打开 Markdown 或 LaTeX 文件,选中要检查的英文段落。
- 运行命令面板(Ctrl+Shift+P),执行
Trinka: Set API Key 设置 API Key(可选择保存到设置或 Secrets)。
- 运行
Trinka: Check Selection(也可使用快捷键 Alt+Shift+C,如果已配置)。
- 建议会以问题形式显示在 Problems 面板,点击问题旁的小灯泡可看到 “Apply” 或 “Reject” 操作。
开发说明
- 入口文件:
src/extension.ts。
- Trinka 网络客户端:
src/trinka.ts,使用 Node 内置 https 发起请求。
- TypeScript 配置在
tsconfig.json,使用 npm run build(等同于 tsc -p ./)进行编译。
常用命令:
# 编译 TypeScript
npm run build
# 打包 vsix
npm run vsce:package
# 发布(需要设置 VSCE_PAT secret)
npm run vsce:publish
发布到 Marketplace(CI)
仓库包含一个 GitHub Actions 工作流,用于在 push 到 main 分支时使用 VSCE_PAT 发布扩展。请在 GitHub 仓库的 Secrets 中配置 VSCE_PAT。
已知问题与限制
- 多条建议可能重叠时,目前采用简单的绝对偏移存储并在应用或拒绝后对后续建议重新计算偏移,极端重叠场景可能出现不准确替换。
- 目前仅在选区内检查段落(需要手动选中)。
贡献
欢迎提交 issue 或 PR,讨论改进建议合并策略、UI 展示或其他功能增强。
写作技巧
Trinka Markdown/LaTeX Linter
在 VS Code 中使用 Trinka Grammar Check API 检查 Markdown 和 LaTeX 文件中选中的英文段落,并可选择应用或拒绝建议。
安装与开发
- 运行
npm install 安装依赖(TypeScript、@types/vscode、node-fetch 等)。
- 运行
npm run build 编译 TypeScript
- 在 VS Code 中按 F5 运行扩展调试主机。
使用
- 在命令面板中运行
Trinka: Set API Key 输入 API Key。
- 选中 Markdown 或 LaTeX 文件中的英文段落,运行
Trinka: Check Selection。
- 在侧边面板预览建议,点击
Apply All 或 Reject。
注意
- 该实现为最小可用版本,可能需要更好的合并策略和多条建议的处理。
writing-skill
===============
写作技巧
| |