TodoReview 插件无法安装或使用,首要确认 Package Control 是否成功安装;若未就位,需执行指定 HTTPS 安装命令并校验系统时间;安装后需正确配置 patterns 和 pattern_names;扫描失效常因文件未加入项目、路径含中文/空格或语法类型不匹配;高亮依赖主题或 Highlight 插件,TodoReview 本身不控制颜色。

TodoReview 插件装不上?先确认 Package Control 已就位
很多人卡在第一步:按 Ctrl+Shift+P 输入 Install Package,结果提示“command not found”。这不是 TodoReview 的问题,是 Package Control 根本没装成功。
验证方式:菜单栏 Preferences → Package Control 能点开,说明已就位;如果灰色或报错,得重装。Linux/macOS/Windows 通用安装命令(粘贴进控制台 Ctrl+` 执行):
import urllib.request,os,hashlib; h = '6f4c264a24d933ce70df5dedcf1dcaee' + 'ebe013ee18cced0ef93d5f746d80ef60'; pf = 'Package Control.sublime-package'; ipp = sublime.installed_packages_path(); urllib.request.install_opener(urllib.request.build_opener(urllib.request.ProxyHandler())); by = urllib.request.urlopen('https://packagecontrol.io/'+ pf.replace(' ', '%20')).read(); dh = hashlib.sha256(by).hexdigest(); print('Error validating download (got %s instead of %s), please try manual install' % (dh, h)) if dh != h else open(os.path.join(ipp, pf), 'wb').write(by)- 注意 URL 已从
http升级为https,旧版镜像站多数失效 - 执行后无报错、不闪退、重启编辑器后菜单出现
Package Control项,才算真正就绪 - 若失败,优先检查系统时间是否准确(证书校验依赖 NTP 同步)
安装 TodoReview 后没反应?检查 keywords 和 pattern_names 配置
装完插件,按 Ctrl+P 输入 TodoReview: Project Files 却没结果,或列表为空——大概率是默认配置没覆盖你的代码风格。
打开 Preferences → Package Settings → TodoReview → Settings - User,填入明确的 patterns:
{
"patterns": {
"todo": "(?i)\bTODO\b",
"fixme": "(?i)\bFIXME\b",
"note": "(?i)\bNOTE\b"
},
"pattern_names": ["todo", "fixme", "note"]
}-
patterns里每个 key 对应一个正则,\b是单词边界,防匹配到TODO_LIST这类变量名 -
pattern_names必须显式列出你要启用的 key,空数组或缺失字段会导致扫描静默失效 - 正则中的
(?i)表示忽略大小写,否则todo小写不会被识别 - Linux/macOS 用户注意 JSON 中反斜杠要双写:
\b,单写会解析失败
扫描出来了但不跳转?确认文件是否被纳入项目 scope
命令执行后弹出列表,上下键能选中条目,但回车没反应——常见原因是当前文件没被 Sublime 视为“项目内文件”。
- 单独打开一个 .py 文件,TodoReview 默认只扫该文件,不跨文件;必须通过
Project → Add Folder to Project把整个目录加进来 - 确保文件路径不含中文或空格(尤其 Windows 下路径含中文时,部分版本会丢掉文件句柄)
- 如果用
subl /path/to/project命令行启动,且路径末尾带斜杠(如subl ./myproject/),TodoReview 才能正确识别根目录 - 检查状态栏右下角显示的语法类型是否为
Python、JavaScript等有效类型;若显示Plain Text,TodoReview 可能跳过该文件
高亮不显示颜色?别指望 TodoReview 自己画色
TodoReview 只负责生成 keyword.other.todo 这类 scope,它本身不控制颜色。如果你换的是极简主题(比如默认的 Monokai),可能根本没定义这个 scope 的样式。
- 最快验证法:临时切换到
Color Scheme → Monokai Bright或Ayucia,立刻能看到高亮 - 不想换主题?直接装
Highlight插件,在Settings - User里配"scope":"comment"+"regex":"\b(TODO|FIXME)\b",绕过 scope 依赖 - 别在 TodoReview 设置里瞎调
color字段——它压根不支持该参数,文档里也没有
TodoReview 的核心价值是跨文件索引和键盘快速跳转,不是视觉反馈。真要一眼看见 TODO,靠 Highlight 插件配 regex 更稳;想批量处理任务,才需要依赖它的列表输出能力。别把两个职责混在一起调,容易浪费半小时反复试错。


















