寻求WebStorm/VSCode通用的注释高亮关键词共享定义文件
你完全可以通过共享项目级的编辑器配置文件,让团队成员无需手动设置就能获得统一的TODO、FIXME这类注释关键词高亮效果。针对你们团队常用的VSCode和WebStorm,我整理了具体的实现方案:
VSCode 配置方案
VSCode支持通过项目内的配置文件共享编辑器设置,把以下文件加入版本控制,团队成员拉取代码后就能自动生效:
- 创建项目级高亮配置
在项目根目录新建.vscode/settings.json文件,添加自定义的注释高亮规则:
{ "editor.tokenColorCustomizations": { "textMateRules": [ { "scope": "comment.todo", "settings": { "foreground": "#FF9800", "fontStyle": "bold" } }, { "scope": "comment.fixme", "settings": { "foreground": "#F44336", "fontStyle": "bold italic" } } ] } }
这里的scope对应注释中的关键词,你可以根据需要添加更多规则(比如NOTE:、BUG:等),颜色和样式也可以自定义调整。
- 推荐团队安装扩展(可选)
如果想要更强大的TODO管理功能(比如侧边栏汇总、快速跳转),可以创建.vscode/extensions.json推荐团队安装todo-tree扩展:
{ "recommendations": [ "gruntfuggly.todo-tree" ] }
这个扩展会自动识别注释中的TODO/FIXME,并且支持和上面的高亮配置联动。
WebStorm 配置方案
WebStorm可以通过共享检查配置文件来统一TODO规则,步骤如下:
- 配置自定义TODO规则
打开WebStorm的Settings > Editor > Inspections > TODO,点击右侧的+按钮添加自定义模式:
- 比如添加
TODO:,设置描述为待办事项,选择喜欢的颜色和样式(比如橙色加粗) - 再添加
FIXME:,设置描述为需要修复的问题,选择红色加粗斜体
导出配置并共享
配置完成后,点击Inspections面板右上角的齿轮图标,选择Export to File,将配置保存为todo-highlight-profile.xml,然后把这个文件放在项目根目录的.idea/inspectionProfiles/文件夹下(如果没有这个文件夹就手动创建)。团队成员导入配置
团队成员拉取代码后,打开WebStorm的Settings > Editor > Inspections,点击齿轮图标选择Import from File,选择项目中的todo-highlight-profile.xml即可生效。如果你们把.idea/inspectionProfiles/加入版本控制,WebStorm会自动加载这个配置,无需手动导入。
跨编辑器通用补充
如果想要更统一的体验,建议团队约定好关键词的格式(比如统一用全大写的TODO:、FIXME:,或者带上作者标识TODO: [张三]),这样不管用哪个编辑器,规则都能一致匹配。
内容的提问来源于stack exchange,提问作者Tim

