【VSCode】キーボードショートカットを編集してみる

VSCodeは様々なコマンドが定義されています。
コマンドの一部はキーボードからのショートカットキーで実行できます。
キーを押すだけで実行できるので、ラクチンですね。

しかしショートカットが設定されていないものは、メニューやコマンドパレットを経由して実行します。
たまに使うものなら気にならないのですが、よく使うものは手間に感じますね。

そこで今回は、ショートカットとして登録されていないコマンドにショートカットキーを登録したり、設定済みのコマンドを変更する方法をお伝えします。

VSCodeはキーボードショートカットを編集する画面が用意されています。
サクッと表示してみましょう。

メニュー：ファイル → ユーザー設定 → キーボードショートカット の順でクリックしていきます。

これで、キーボードショートカット編集画面が表示されます。

ここまでできれば、後は説明不要だと思いますが、一応使い方を解説していきます。

キーボードショートカット編集画面には、４つの項目があります。

「キーバインド」に何も表示されていないものは、ショートカットキーが登録されていません。
「キーバインド」または「いつ」の内容を変更すると、「ソース」は「規定」から「ユーザー」へ変更されます。

いつ(when)については、この記事のいつ（when)の値と条件演算子を見てください。

変更するコマンドは、キーボードショートカット編集画面内の検索欄で検索できます。

現在登録されているショートカットキーで、コマンドを検索することもできます。

検索欄の右側にあるキーボードアイコンをクリックします。
「キーを記録しています」が表示されている状態で、ショートカットキーをキーボードに入力します。

検索欄に入力したショートカットが文字で表示され、「キーバインド」と一致する項目が表示されます。

検索の終了は、再度キーボードアイコンを押すか、キーボードでescキーを入力します。

検索欄の文字を消そうとしてキーボードdeleteキーを押すと、deleteキーが検索候補になります。
「検索が終了しない！」とパニックになる人がたまにいる（僕です）ので、注意しましょう。

キーバインドの変更は、コマンドを選択して左側の鉛筆アイコンをクリックするか、項目上をダブルクリックします。

キー入力パネルが表示されます。
設定したいキーを入力して、エンターを押すと登録されます。

「既存のコマンドがこのキーボードを使用しています」と表示されているときは、ショートカットキーが重複しています。
重複していても、エンターを押すと登録されます。

間違えて登録したときは、現在登録されているショートカットキーでコマンド検索して修正しましょう。

キーボードショートカット編集画面で登録した内容は、keybindings.json に書き込まれています。

VSCodeを起動すると、規定値が読み込まれた後に keybindings.json の内容が上書きされます。

keybindings.jsonは、キーボードショートカット編集画面の「キーボードショートカットを開く」アイコンをクリックすると表示できます。

コマンド名がわかれば、手作業でキーボードショートカットを変更できますね。
ただし規定でショートカットが登録されているものは、変更前のキーからのコマンド削除が必要です。

次のようにコマンド名の前に "-" を記述すると削除になるようです。
"-" がないものは、追加ですね。

[
    {
        "key": "ctrl+s",
        "command": "editor.action.selectAll"
    },
    {
        "key": "ctrl+a",
        "command": "-editor.action.selectAll"
    }
]

変更したショートカットキーを規定に戻すときは、コンテキストメニューから「キーバインドのリセット」を実行します。

コマンドからショートカットキーを取り除きたいときは、コンテキストメニューから「キーバインドの削除」を実行します。

全てを規定値に戻したいときは、全ての変更した項目に「キーバインドのリセット」を実行します。

「それはめんどうだ！」という人は、keybindings.jsonを開いて内容を全て消去後、上書きします。
ラクチンなので、こちらがおススメ。

キーボードショートカット編集画面の「いつ」項目は様々なコンテキスト（ここでは変数のようなもの）を指定でき、条件演算子で細かい条件付けができます。
一覧で挙げておきます。

条件演算子

「いつ」項目は、次のような条件演算子が使用できます。

{ "abc.def":{ 
      "test.js" : true ,
      "test2.js" : false
   } 
}

"when": "resourceFilename in config.abc.def"

コンテキスト

VS Codeのドキュメントで挙げられている、「いつ」項目で使用できるコンテキストの一覧です。

キーボードショートカット編集画面にはこれ以外にも設定されていますが、一部はVSCode内部で使用するのが目的で将来変更される可能性があるようです。

エディター関連

エクスプローラー関連

エディター ウィジェット関連

デバッガ―関連

OS判定

リスト関連

モード関連

リソース関連

統合ターミナル関連

タイムライン ビュー関連

拡張機能関連

グローバルUI関連

グローバルエディターUI関連

構成設定の値

setteing.jsonなどで設定されている構成設定の名前の前に "config."を付けることで いつ（when)の値として使用できます。

例：

editor.autoIndent → config.editor.autoIndent

キーボードショートカット編集画面は引数が必要なコマンドの設定ができませんが、keybindings.jsonを直接編集することで引数を渡すことができます。

引数は、"args"で指定します。

次のコードは、Ctrl+Shift+Alt+pを押すと5行スクロールするショートカット定義です。

[
    {
        "key": "Ctrl+Shift+Alt+p",
        "command": "editorScroll",
        "args": { 
            "to": "down",
            "by": "line",
            "value": 5
        },
    },
]

コマンドについては、次のリンク先を読んでみてください。

■https://code.visualstudio.com/api/references/commands