Sublime导入自定义规则实现TODO高亮的方法

落萱同学_6011

落萱同学_6011

2026-10-30

858人浏览

原创

Highlight插件通过正则匹配文本内容与作用域上下文,5分钟生效,不依赖主题、不修改语法、不卡大文件;需正确配置scope为comment、使用\b单词边界、style设为fill,并验证正则是否命中。

sublime导入自定义规则实现todo高亮的方法

用 Highlight 插件配正则是最稳路径

别折腾语法文件或 color scheme,Highlight 插件直接在渲染层加样式,5 分钟生效,不依赖主题、不修改原语法、不卡大文件。它匹配的是文本内容 + 作用域上下文,不是纯字符串替换。

操作步骤:

  • 按 Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(macOS),输入 Package Control: Install Package,搜 Highlight 并安装
  • 再按 Ctrl+Shift+P,输入 Preferences: Highlight Settings – User,打开用户配置
  • 填入以下内容(注意 JSON 格式,双反斜杠是必须的):
{
  "highlights": [
    {
      "name": "todo_fixme",
      "scope": "comment",
      "regex": "\b(TODO|FIXME)\b",
      "style": "fill",
      "color": "hsl(48, 100%, 85%)"
    }
  ]
}

关键点:scope 必须设为 comment,否则会误中字符串里的 "TODO";\b 是单词边界,防 TODO_LIST 被连带匹配;style 选 fill 比 underline 更易识别。

为什么不能只靠 TodoReview 显示颜色

TodoReview 只负责扫描和列表,它生成的 keyword.other.todo scope 能不能显示颜色,完全取决于当前 color scheme 是否定义了该 scope 的规则。多数轻量主题(如 Default、Adaptive)根本没写这一条,所以你看到的还是默认注释灰。

验证方法:

  • 打开 Preferences → Color Scheme,临时换用 Monokai 或 Ayucia,如果 TODO 突然变黄,说明问题出在主题缺失规则,不是插件没起作用
  • 不想换主题?那就别指望 TodoReview 驱动高亮——它不控制渲染,只提供数据
  • 非要硬连,得确保其设置里有 "pattern_names": ["todo"],且 patterns 正则写对,例如 "todo": "(?i)\bTODO\b",否则 scope 根本打不上

正则写错的典型症状和排查法

配完没反应?先看状态栏:把光标停在 TODO 上,如果右下角没显示 regex match,说明正则压根没命中。

Cutout.Pro老照片上色
Cutout.Pro老照片上色

Cutout.Pro老照片上色是一款AI图片处理工具,Cutout.Pro 推出的黑白图片上色功能。

下载

常见错误:

  • 漏掉双反斜杠:"TODO" 在 JSON 里会被解析成 "bTODOb",必须写 "\bTODO\b"
  • scope 错设成 source 或留空:会导致匹配进字符串、变量名甚至 JSON key 里
  • 用了 .* 或 .:Sublime 正则引擎不优化回溯,开个 5MB 日志文件就卡死
  • 没加行首锚定但想限定注释内:比如 // TODO 和 /* TODO */ 共存时,建议用 "^\s*//\s+(TODO|FIXME)\b" 锁定单行注释场景

自定义语法方案适合什么人

只有当你需要把 TODO 当作语言级关键字(比如让 Ctrl+Click 跳转、或被 LSP 识别),才值得写 .sublime-syntax 文件。它要改作用域链路,涉及 embed、push、pop 规则,且每种语言都得单独配。

举个最小可用例子(JavaScript-TODO.sublime-syntax):

%YAML 1.2
---
name: JavaScript (TODO)
file_extensions:
  - js
scope: source.js
contexts:
  main:
    - include: scope:source.js
    - match: '\b(TODO|FIXME)\b'
      scope: comment.todo.js

然后还得在 color scheme 里加一条:"scope": "comment.todo.js", "foreground": "hsl(48, 100%, 50%)"。两头都要动,出错难定位——除非你在做团队统一开发规范,否则没必要。

真正容易被忽略的是:scope 名必须严格匹配 color scheme 中的定义,多一个点、少一个后缀都不生效;而且一旦语法文件有 YAML 语法错误,Sublime 会静默降级回用原语法,连报错都不给。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

sublime todo高亮 sublime

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

2026.10.28

40

16

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

2026.10.28

20

15

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

2026.10.28

40

10

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

120

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

80

10

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

2026.10.22

80

15

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

2026.10.22

40

10

PHP时间戳漏洞修复教程
PHP时间戳漏洞修复教程

本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。

2026.10.22

80

25

Golangci-lint配置文件与规则设置
Golangci-lint配置文件与规则设置

本专题聚焦Golangci-lint YAML配置文件,讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置,便于团队统一检查标准。

2026.10.22

40

15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程