[[📒Articles]] > [[📒2024 Articles]] ![[2024-07-17.webp|cover-picture]] [[AutoHotkey]]で[[Neovim]]の魅力を一層引き出し、高みを目指す3つの方法を紹介します。 > [!info] > この記事は [[Vim駅伝]] #2024/07/17 の 参加記事です。 ## はじめに 私は[[Windows]]の[[WSL]]にインストールした[[Ubuntu]]で[[Neovim]]を利用しており、ターミナルは[[Windows Terminal]]を使っています。今でこそほぼ不自由なく快適に使えていますが、当初はいくつかの不満を抱えていました。 - `^`や`、`"`などの記号を打つのが大変 - 最上段の数字キーをミスなくスムーズにタイプできない (特に2桁以上の場合) - `Shift+Space`や`Ctrl+Enter`など、一部の組み合わせキーを割り当てできない 特に1つ目と2つ目は、[[Neovim]]や[[Vim]]を使われている方、もしくは[[VSCode]]など他の[[IDE]]でVimキーバインドを使われている方であれば、一度は感じたことがあるのではないでしょうか。 本記事では、これらの問題を[[AutoHotkey]]を使ってどのように乗り越えたかを紹介していきます。 > [!hint] Windows以外のOSをお使いの方へ > 今回の内容は[[AutoHotkey]]ではなくてもキーマップ系のツールであれば対応できる内容も多いと思います。各[[OS]]のキーマップ系ツールに置き換えてお読みください。 ### 特に読んでほしい読者 - 『[[Vim]]? [[Neovim]]? [[AutoHotkey]]があればいらないだろ？』と思っている[[AutoHotkey]]使いの方 - 『[[AutoHotkey]]? [[Vim]]や[[Neovim]]を使いなよ。ヌルイなぁ...』と思っている[[Vimmer]]の方 - [[Vim]]や[[Neovim]]を使った編集の速度や正確性を追求したい方 - [[Vimmer]]になってから腱鞘炎に悩まされている方 ## AutoHotkeyとは [[AutoHotkey]]は[[Windows]]で動く最強のキーハックツールです。キーボードやマウスのデバイス入力をトリガーに、別のキー操作を割り当てたり、プログラムで任意の処理を実行することができます。 <div class="link-card"> <div class="link-card-header"> <img src="https://autohotkey.com/favicon.ico" class="link-card-site-icon"/> <span class="link-card-site-name">www.autohotkey.com</span> </div> <div class="link-card-body"> <div class="link-card-content"> <p class="link-card-title">AutoHotkey</p> <p class="link-card-description"> Free keyboard macro program. Supports hotkeys for keyboard, mouse, and joystick. Can expand abbreviations as you type them (AutoText). </p> </div> </div> <a href="https://www.autohotkey.com/"></a> </div> 本記事では、[[AutoHotkey]]のサンプルコードをあわせて掲載しますが、文法などの説明はスコープ対象外とします。また、サンプルコードの掲載元は以下のリポジトリとなります。 <div class="link-card"> <div class="link-card-header"> <img src="https://github.githubassets.com/favicons/favicon.svg" class="link-card-site-icon"/> <span class="link-card-site-name">GitHub</span> </div> <div class="link-card-body"> <div class="link-card-content"> <p class="link-card-title">GitHub - tadashi-aikawa/spinal-reflex-bindings-template</p> <p class="link-card-description">This repository is the Autohotkey KeyCustomized Project which is applicable to only mine. - ta ... </p> </div> <img src="https://opengraph.githubassets.com/05a70e75eb7c90d0002708a6a17051bf5f9c62eeac2b583937d123ebba296aa0/tadashi-aikawa/spinal-reflex-bindings-template" class="link-card-image" /> </div> <a href="https://github.com/tadashi-aikawa/spinal-reflex-bindings-template"></a> </div> ## AutoHotkeyを使って操作を楽にする それでは、3つのユースケースに対するソリューションを[[AutoHotkey]]のコード例を交えて紹介していきます。 > [!caution] > 本記事のソースコードは[[AutoHotkey]]のv1に対応しています。最新バージョンのv2ではありません。 ### 記号の入力を楽にする #### 課題 [[Neovim]]では頻繁に記号キーを使います。しかし、記号キーは修飾キーとの同時押しが必要であったり、数値キーのある最上段キーに配置されているなど、指の負荷も大きく間違いやすい場所に位置しています。 たとえば、以下の操作を想定してみましょう。 1. 冒頭のコメントアウトを削除する 2. ダブルクォーテーションの中を大文字にする ![[2024-07-16_case1.webm]] 実際に押したキーは `^dawgUi"$3h.` です。記号がいくつかあり、通常のキーボードでは以下の動きになります。 ![[keyboard_case1_before.png]] 左手が悲鳴を上げそうな構成ですね。 #### ソリューション 以下のような条件を満たす記号の入力には[[2キーバインド]]を設定します。条件と度合いによってはすべて満たすものもあれば、1つだけしか満たさないものもあります。 - Shiftと同時押しが発生する - 左手のみで入力する - 利用頻度がそこそこ高い [[Prefixキー]]には`;`を使っています。 | 記号 | キーバインド設定 | | ---- | ---------------- | | `^` | `;` -> `a` | | ` | `;` -> `f` | | `#` | `;` -> `d` | | `!` | `;` -> `z` | | `&` | `;` -> `g` | | `~` | `;` -> `h` | | `_` | `;` -> `l` | | `"` | `;` -> `m` | | `'` | `;` -> `v` | | `%` | `;` -> `p` | これらは[[Neovim]]の[[Leaderキー]]で設定するのではなく、[[AutoHotkey]]で設定します。なぜなら、**[[AutoHotkey]]で設定すれば、[[Neovim]]の設定、[[Vim]]や他の[[Vimキーバインド]]を用いたエディタの設定を変更せず、あらゆる場所でこのキーバインドが使用できるから**です。 > [!question]- [[Prefixキー]]にセミコロンを使う理由は? > 以下2つの条件を満たしているからです。 > > - ホームポジションで素早く入力できる > - 単押しで使わなければいけない機会が多くない > - コーディングの場合は[[フォーマッター]]補完に頼れることが多い ([[Rust]]除く) > - [[Neovim]]の `f` や `t` のリピートは[[flash.nvim]]を使えば代用できる > - 最悪Ctrlとの同時押しならそこまで苦でもない > - セミコロンの後に連続してキーを入力することはほとんどない この設定をしたうえで先ほどのユースケースを考えてみましょう。 実際に押したキーは `;adawgUi;m;f3h.` になります。『キーの数が増えてないか...?』と思うかもしれません...がその分布をご覧ください。 ![[keyboard_case1_after.png]] ブラインドタッチ難易度の高い最上段キーや、左手のみのShiftキー同時押し回数、同時押し回数のいずれも減少しています。 | 項目数 | 本対応前 | 本対応後 | | ------------------ | -------- | -------- | | 最上段キー | 4 | 1 | | 左手のみの同時押し | 2 | 0 | | 同時押し | 3 | 1 | | キー | 12 | 15 | 地味な違いですが、長い時間[[Neovim]]を使っていると、操作の正確性や指の疲れに直結してきますので侮れません。左手 子薬中指の腱鞘炎リスクも激減すると思います。 #### AutoHotkeyのコード例 [[Prefixキー]]が`;`であるかの判定は `2K` 関数を作って判定しています。 ```autohotkey ;【概要】2キーバインドのキーかどうかを判定します ;【引数】Prefixキー ;【戻値】boolean 2K(prefix) { return (A_PriorHotKey = "quot; . prefix) } ``` あとは、キーバインド設定で条件分岐を書けばOK。 ```autohotkey $a:: if (2K(";")) { send {^} } else { send a } return ``` ### 行単位の操作を楽にする #### 課題 [[Neovim]]を使っているとファイルの中を移動しまくって高速で編集することがあると思います。たとえば以下のファイルを整形するシーンを考えてみてください。 ![[Pasted image 20240716201413.png]] 『第1章』と『第2章』のセクションが逆転してしまっており、これを入れ替えるケースを考えます。解は無限に存在すると思いますが、ここでは[[flash.nvim]]と`}`を使う戦略を想定してみます。(どちらか片方でもいいのですが、せっかくなので...) ![[2024-07-16_case2.webm]] 鮮やかな操作に思えるかもしれませんが、このような操作は少し反射神経と頭のリソースを奪われます。なぜなら、[[flash.nvim]]の候補に対してアルファベットやEnterで移動できる箇所が表示されるのは、**[[flash.nvim]]に設定された[[Leaderキー]]を押したあと**だからです。 ![[Pasted image 20240716203724.png|frame]] *この表示が出るのは `s#` を押したあと* 操作のフィードバックを見なくても操作したいのであれば、もっと確度の高い移動手段を使うべきです。常に見えており、操作前から把握でき、ジャンプ先が一意になる方法... と言えば行番号指定ジャンプでしょう。 ![[2024-07-16_case2-2.webm]] 目に見えぬ達人の所業... 針をも縫う正確さと瞬間移動に等しい圧倒的スピードは、行単位の編集であれば敵なしだと思います。しかし、この方法にも1つ弱点があります。**キーを素早く押すのが難しい**のです。 先ほど入力したキーは `43G2dap36Gp` です。これをキーボードの分布で確認してみましょう。 ![[Pasted image 20240716205004.png]] 左手だけの同時押しは必ず発生しますし、当然ですが入力するキーはほとんど最上段です。ミスもしやすく指も疲れます。先ほどの動画でお見せしたようなスピードを安定して出すのは難易度が高いと思います。今はまだ2桁なのでいいですが、行数が3桁になるともはや行番号を打つだけで一苦労だと思います。 > [!note] > `vim.wo.relativenumber = true` オプションで現在行からの相対行を表示する方法もありますが、複数行上下への移動が少し楽になるだけで本質的なソリューションではないと思っています。また、移動するまで、その更に次に移動したい行番号が分からないので[[flash.nvim]]と同様の課題があります。 #### ソリューション 押しにくければ押しやすくすればいい。問題となっている2種類のキーについて以下のようなソリューションでアプローチします。 - 数値キー - ホームポジションの右側に**仮想テンキー**を作成する - `Shift + G` - 仮想テンキー有効時に`G`を押したら`Shift + G`とする 仮想テンキーは以下のような配置となっています。私の環境では `無変換` -> `R` という順で2つのキーを入力したら仮想テンキーが有効になるようにしています。 ![[Pasted image 20240716210413.png]] この設定で先ほどのユースケースを考えてみましょう。 実際に押したキーは `無変換rj.g2dap無変換r.lgp` になります。例によってキー数は増えていますが、改めて分布をご覧ください。 ![[Pasted image 20240716211018.png]] ほぼすべてがホームポジションに収まり、同時押しキーは0です。これなら先ほどの操作でも素早くミスなく続けることができます。 | 項目数 | 本対応前 | 本対応後 | | --------- | ---- | ---- | | 最上段キー | 5 | 1 | | 左手のみの同時押し | 2 | 0 | | 同時押し | 2 | 0 | | キー | 11 | 15 | > [!note] > 仮想テンキーモードで`G`を押すと、仮想テンキーモードから脱却します。これは行ジャンプ直後に続けてもう一度行ジャンプを繰り返すケースはほぼないからです。 #### AutoHotkeyのコード例 詳細を載せると本筋から逸れてしまうので、雰囲気だけお伝えします。[[🦉Spinal reflex bindings template]]では[[Neovim]]と同様にモードという概念を取り入れており、5つのモードが存在します。 | 省略表記 | モード名 | 概要 | | -------- | ------------- | -------------------------------- | | N | NORMALモード | Windowsの普通の状態 | | E | EDITモード | Vimの[[ノーマルモード]]相当 | | R | RANGEモード | Vimの[[ビジュアルモード]]相当 | | M | MOUSEモード | マウスカーソル操作に特化状態 | | S | SPECIALモード | ウィンドウ移動・テンキー・その他 | 以下はコードの断片を寄せ集めたスニペットです。先ほどの操作では①②で仮想テンキーを有効にし、③のように数字を入力、④で行ジャンプしています。 ```autohotkey ;----- モード切替 ----- ; 無変換キー $vk1C:: if (mode(_MODE.NORMAL)) { ; ① NORMALモード時に無変換キーが押されたら、EDITモードへ移行 setMode(_MODE.EDIT) } else { setMode(_MODE.NORMAL) setIME(false) } return ;[N] rキー ;[EMR] SPECIALモードに切り替え ;[S] EDITモードに切り替え $r:: if (modes("N")) { send r } else if (modes("EMR")) { ; ② EDITモード時にrキーが押されたら、SPECIALモードへ移行 setMode(_MODE.SPECIAL) } else if (modes("S")) { setMode(_MODE.EDIT) } return ;[N] mキー (; -> ") ;[ER] 日本語入力OFF + モードをNORMALに変更 ;[S] 1キー $m:: if (modes("N")) { if (2K(";")) { send " } else { send m } } else if (modes("ER")) { setIME(false) setMode(_MODE.NORMAL) } else if (modes("S")) { ; ③ SPECIALモード時にmキーが押されたら、1を入力 if (isTerminal() || isUbuntu()) { send 1 } else { send {Numpad1} } } return ;[N] gキー (; -> &)(Obsidian: C-j -> 全文検索) ;[EM] RANGEモードに切り替え ;[R] EDITモードに切り替え ;[S] G+NORMALモードに切り替え(Vimジャンプ用) $g:: if (modes("N")) { if (2K(";")) { send & } else if (AP("Obsidian") && 2K("^j")) { send ^g } else { send g } } else if (modes("EM")) { setMode(_MODE.RANGE) } else if (modes("R")) { setMode(_MODE.EDIT) } else if (modes("S")) { ; ④ SPECIALモード時にgキーが押されたら、Shift+G入力後にNORMALモードへ send G setMode(_MODE.NORMAL) } return ``` モードの取得や変更に関するコードは [ModeController.ahk](https://github.com/tadashi-aikawa/spinal-reflex-bindings-template/blob/master/ModeController.ahk) をご覧ください。 #### AutoHotkeyの設定をした筆者の操作動画 せっかくなのでリアルにどれくらいのスピードが出るのか撮影してみました。 ![[2024-07-16_21h30_26.webm]] 右下に `Special` というラベルが表示されているときがSPECIALモードのときです。先ほどの動画は[[VHS (CLI)|VHS]]というターミナル自動操作&録画ツールを使ったものですが、ほぼ同じ速度が出せているのではないでしょうか。 ### 割り当てできない組み合わせキーを割り当てる #### 課題 [[Neovim]]の制限、[[Neovimプラグイン]]の設定制限、[[OS]]や[[ターミナル]]の環境によって、一部のキーバインドを設定できないことがあります。少なくとも私の環境/知識では以下2つのキーを設定できませんでした。 - `Ctrl+Enter` - `Shift+Space` この2種類のキーは[[IDE]]で頻繁に使うキーです。前者は新しいタブやウィンドウを開く用途で... 後者は[[Hippie completion]]で利用していたため、これらのキーバインドが使えないのは致命的でした。 #### ソリューション [[AutoHotkey]]で**ターミナルを操作中に限り、**`Ctrl+Enter`と`Shift+Space`を別のキーに割り当てます。 | キー | 割り当てる別キー | | ------------- | ---------------- | | `Ctrl+Enter` | `F12` | | `Shift+Space` | `Shift+F6` | その上で[[Neovim]]にキーバインドを設定します。私が[[Neovim]]を使っているときは必ず[[ターミナル]]を使っているので常にこのキーバインドが有効になります。 ```lua { "stevearc/oil.nvim", keys = { { "<Space>o", ":Oil<CR>", silent = true }, }, opts = { skip_confirm_for_simple_edits = true, keymaps = { ["<C-s>"] = "actions.select_split", -- Ctrl+Enterで垂直分割で選択 ["<F12>"] = "actions.select_vsplit", }, view_options = { show_hidden = true, }, }, } ``` ```lua local u = require("utils") -- Hippie completion if u.is_windows then vim.keymap.set("i", "<S-F6>", "<C-x><C-p>") else -- Ubuntu(WSL)ではS-F6がF18となるため vim.keymap.set("i", "<F18>", "<C-x><C-p>") end ``` > [!attention] > 割り当てるキーは[[Neovim]]起動中に絶対利用しないキーにしましょう。 #### AutoHotkeyのコード例 ターミナル(≒[[Neovim]])かどうかの判定は `isTerminal` 関数をつくって判定しています。 ```autohotkey ;【概要】指定されたプロセスがアクティブであるか ;【引数】name: プロセス名 ;【戻値】true / false isActiveProcess(name) { ; ① pNameには WindowsTerminal.exe などが入る pName := getSettingsValue("ProcessName", name) WinGet, ahk_process, ProcessName, A return pName == ahk_process } ;【概要】指定されたウィンドウがターミナルか (ゆるい判定..minttyはgit bashかな...) ;【戻値】true / false isTerminal() { return isActive("mintty") || isActiveProcess("terminal") || isActiveProcess("wezterm") } ``` あとは通常のキーマップで、ターミナル(≒[[Neovim]])起動中は指定のマッピングをするだけです。 ```autohotkey ;[N] Ctrl+Enterキー (ターミナルの場合はCtrl+Enterが使えないのでF12で代用) $^Enter:: if (modes("N")) { if (isTerminal()) { ; ② ターミナル(≒Neovim)起動中ならF12 send {F12} } else { send ^{Enter} } } return ;Shift+Spaceキー (ターミナルの場合はShift+Spaceが使えないのでShift+F6 or F18(WSL)で代用) $+Space:: if (isTerminal()) { ; ③ ターミナル(≒Neovim)起動中ならShift+F6 ; WSLだとF18になる send +{F6} } else { send +{Space} } return ``` ## まとめ [[Neovim]]を使っていると直面する課題に対して、[[AutoHotkey]]を使った3つのソリューションを紹介しました。特に、1つ目と2つ目のソリューションは[[Neovim]]以外の[[Vimキーバインド]]ツールでも活用できます。(例: [[VSCode]]、[[IntelliJ IDEA]]、[[Obsidian]]) [[Neovim]]の編集効率は、記号キーや数字キーを使いこなすことで大きく上がるケースがそれなりにあります。しかし、それらのキーが押しづらいためか、実際は`hjkl`キーを押しっぱなしにして移動したり、`wb`キーの複数回押しで妥協?するシーンを少なからず見かけます。編集スピードという点ではそれで十分なのかもしれません。ですが、せっかく[[Neovim]]という素晴らしいエディタを使っているのですから、七色の編集操作を楽しんだり、更なる効率の高みを目指すのもまた一興ではないでしょうか。 え、[[macOS]]なので[[AutoHotkey]]は使えないですって？ お後がよろしいようで🙇