文档 命令面板

Sublime Merge 命令面板中可用的命令由以 .sublime-commands 结尾的文件定义。命令文件使用 JSON,顶层结构为数组。每个命令都是一个 JSON 对象。

示例

以下是一个 .sublime-commands 文件格式的示例。

[
    {
        "caption": "View: Toggle Side Bar",
        "command": "toggle_side_bar"
    },
    {
        "caption": "Checkout Branch…",
        "command": "checkout_branch",
    },
    {
        "caption": "Checkout Remote Branch…",
        "command": "checkout_branch",
        "args": { "local_refs": false, "remote_refs": true }
    },
]

条目

每个命令面板条目需要两个键,"caption""command"。要向命令传递参数,可以指定 "args" 键。

"caption" 值必须是字符串,用于指定在命令面板中显示的文本。"command" 值也必须是字符串,用于指定要执行的命令的名称。

查看所选提交树的条目

{
    "caption": "View Tree",
    "command": "view_tree"
}

args 值必须是对象,每个键都是要传递给命令的参数的名称。

推送当前分支的条目,但提示用户选择选项

{
    "caption": "Push...",
    "command": "push",
    "args": {"prompt": true}
}

用户条目

用户可以通过在 Packages/User/ 目录中创建一个名为 Default.sublime-commands 的文件来向其命令面板添加条目。

例如,以下将创建一个清理当前仓库的条目。

[
    {
        "caption": "Cleanup Repo",
        "command": "git",
        "args": {"argv": ["gc"]}
    }
]