必须通过 package control 安装 todoreview,手动解压无效;需项目方式打开含 .todoconfig 的文件夹,配置 file_extensions 支持 .vue/.ts 等后缀,并统一缩进、编码与注释格式。

安装 TodoReview 插件必须走 Package Control,别手动拖文件
TodoReview 不支持直接下载 ZIP 解压到 Packages 目录——那样插件无法注册命令、不响应 Ctrl+Shift+P 调用,且后续更新失效。
- 先确认已装
Package Control:按Ctrl+Shift+P(Win/Linux)或Cmd+Shift+P(Mac),输入Install Package,能出现选项即已就位 - 输入
Package Control: Install Package→ 等待列表加载完成 → 搜索TodoReview→ 点击安装 - 安装后无需重启,但必须以「项目方式」打开文件夹(
File → Open Folder…),否则插件默认不激活扫描
为什么装完没反应?大概率缺 .todoconfig 或没开项目
TodoReview 默认只在有 .todoconfig 文件的项目根目录下工作,不是全局扫描器。空文件也行,但必须存在。
- 在你项目的最外层文件夹里新建一个文件,命名为
.todoconfig(注意开头的点,无后缀) - 确保 Sublime 是通过
Open Folder…打开整个目录,而不是双击单个文件或用Open File - 按
Ctrl+Shift+P输入TodoReview: Toggle测试是否响应;无反应就回头检查上面两点
扫描不到 .vue/.ts 文件?file_extensions 必须显式加通配符
默认配置只认 *.js、*.py 这类常见后缀,.vue、.ts、.jsx 全被跳过,不是插件“不支持”,是根本没扫到文件。
- 进
Preferences → Package Settings → TodoReview → Settings - 在右侧用户设置中补全
file_extensions,例如:{ "file_extensions": ["*.js", "*.ts", "*.vue", "*.jsx", "*.html", "*.py"] } - ⚠️ 注意写法:
vue或.vue无效,必须是*.vue;删掉原有项会导致 Python/HTML 也失效
点击 TODO 条目跳转错行?缩进混用和 BOM 是元凶
跳转偏移不是插件 bug,而是它依赖文本行号计算,一旦文件含 BOM、Tab+空格混用、或注释格式不规整(比如 //TODO: 紧贴无空格),行号就对不上。
- 统一用空格缩进(推荐 2 或 4 个),禁用 Tab(可在
View → Indentation → Convert Indentation to Spaces一键转换) - 团队约定注释格式为:
// TODO: xxx(冒号后跟空格),避免//TODO:或// TODO:(前面多空格) - 用
File → Reopen with Encoding → UTF-8清除潜在 BOM,尤其 Windows 下生成的文件容易带
TodoReview 就会漏报或跳歪,问题反而更难定位。











