通过修改Packages/User/Context.sublime-menu文件可添加右键菜单项,需确保JSON格式正确、路径准确、command存在且context条件满足,支持caption、command、args及context字段实现动态显示与参数传递。

如何通过 Context.sublime-menu 添加右键菜单项

Sublime Text 的右键菜单由 JSON 格式的 Context.sublime-menu 文件控制,它位于插件目录或用户包路径下。修改这个文件是添加自定义右键选项最直接、最稳定的方式。

关键点:该文件必须放在正确路径才能生效,且结构必须是合法 JSON 数组,每个菜单项是对象,含 caption(显示文字)和 command(触发命令)字段。

  • 用户级路径(推荐):Packages/User/Context.sublime-menu
  • 插件级路径(适合打包分发):Packages/YourPluginName/Context.sublime-menu
  • 菜单项中 command 值对应 Sublime 内置命令名或插件注册的命令名,如 copytoggle_commentmy_custom_command
  • 支持 args 字段传参,例如 "args": {"characters": "\n"} 可用于自定义插入内容

常见错误:菜单不出现或点击无响应

右键菜单失效通常不是语法问题,而是路径、作用域或命令不可用三类原因导致。

  • Context.sublime-menu 文件名大小写必须完全匹配,不能写成 context.sublime-menuContext.Sublime-Menu
  • 未指定 context 字段时,菜单项默认全局可见;但若加了 "context": [{"key": "selection_empty", "operator": "equal", "operand": false}],则只在有选中文本时显示——容易误以为“没生效”,其实是条件不满足
  • 调用的 command 不存在(比如拼错为 coppy),Sublime 不报错,只是静默忽略。可用 Ctrl+Shift+P 输入命令名验证是否存在
  • 使用了插件命令但插件未启用或未正确安装(比如 SideBarEnhancementsside_bar_files_open_with 在插件禁用后会失效)

实用示例:快速插入时间戳和复制相对路径

这两个功能高频且无需额外插件,适合新手练手。注意命令参数和上下文判断逻辑。

[
    {
        "caption": "Insert Timestamp",
        "command": "insert_snippet",
        "args": {
            "contents": "${1:$(date +%Y-%m-%d %H:%M:%S)}"
        }
    },
    {
        "caption": "-",
        "command": "noop"
    },
    {
        "caption": "Copy Relative Path",
        "command": "copy_path",
        "args": {"relative": true}
    }
]

说明:

  • insert_snippet 是 Sublime 内置命令,contents 中的 $(date ...) 是 Shell 扩展语法,在 macOS/Linux 下有效;Windows 需改用 ${1:$(cmd /c date /t)}(兼容性差,建议用插件替代)
  • copy_path 是 Sublime 4.4+ 内置命令,"relative": true 表示相对于当前项目根目录;若无项目,则回退到文件所在文件夹
  • "caption": "-" 是分隔线,noop 是空操作命令,必须存在才能渲染

进阶控制:按文件类型或光标位置动态显示菜单

context 字段可实现精准控制,避免菜单项污染。Sublime 提供多个内置 key,常用组合能覆盖大多数场景。

  • "key": "selector" + "operator": "equal" + "operand": "source.python":仅在 Python 文件中显示
  • "key": "selection_empty" 判断是否有选中内容;"key": "has_selection" 是等效写法
  • "key": "preceding_text" 可检查光标前字符,比如匹配 "operand": "\\." 实现“在点号后右键才显示方法补全”类逻辑
  • 多个 context 条件是 AND 关系,需全部满足才显示;如需 OR,需拆成多个相同 caption 的菜单项,各自配不同 context

复杂逻辑(如“仅在 Markdown 文件的代码块内显示”)需要结合 selectorscope 检查,这时建议先用 Ctrl+Shift+P → Developer: Show Scope Name 查看当前光标处的完整 scope 字符串。