コマンドライン編集機能 Zsh Line Editor を使いこなす

Zsh Line Editorってご存じですか。

皆さん使っているであろう、「Ctrl-A で行頭に移動、Ctrl-E で行末に移動」とかのアレである。zsh の持つコマンドライン編集機能を ZLE（Zsh Line Editor）と呼ぶ。ZLE でコマンドライン操作体系として Emacs ライクなものと vi ライクなものが選択できるようになっている。また、ZLE ではデフォルトで 4 つのキーマップ（キー割り当ての集合）が開放されている。

• emacs（Emacs ライクなキーマップ）
• viins（vi のインサートモードのキーマップ）
• vicmd（vi のコマンドモードのキーマップ）
• .safe（カスタマイズが禁止されているキーマップ）

これらとは別に main というキーマップがあり、ZLE では main に紐付いたキーマップをデフォルトキーマップとして使用する。
zsh では最初はコマンドライン編集機能を持たない .safe キーマップを選択した状態で起動される。コマンドライン編集機能を利用するには emacs か viins かを選択しなければならない。

$ bindkey -e    # emacs キーマップを選択

または

$ bindkey -v    # viins キーマップを選択

そしてこれによって選択したキーマップが main として設定される。

多くの人は emacs キーマップを使っているだろう。もしくは vi モードの存在すら知らずに過ごしているだろう。viins ならびに vicmd はライフチェインジングなほど便利な機能なので紹介する。

vi ライクなインターフェース

上で紹介したように vi ライクなコマンドライン編集機能のインターフェースを利用するには、

$ bindkey -v    # viins キーマップを選択

として viins キーマップを選択する必要がある。vi/Vim でいう「挿入（インサート）モード」と「コマンドモード」を行き来して操作する。よって、vi ライクな編集モードを選択した場合、viins と vicmd の両キーマップを使い分けることになる。

コマンドラインを開始したときの状態は viins モードになる。このモードは文字挿入が主目的で、文字削除程度の編集しかできない。そこで vicmd モードである。

viins

viins は vi/Vim の挿入モードにもあるように、打ち込んだ文字がそのまま表示される。つまり、なにか意味のある操作を行うには修飾キーが必要となる。

機能はすべて vi/Vim に似せたものとなっている。

viins は emacs モードのように文字入力が可能であるが、^A（カーソルを行頭へ移動）や ^E（カーソルを行末に移動）などは定義されていないので使用できない。

vicmd

viins キーマップから ESC（^[）をタイプすると vi/Vim のコマンドモードを模した vicmd モードに移行する。

マークやバッファ系のコマンドなどは省略したが、上にあるコマンド（ウィジェット）が vicmd モードで利用できるものになる。

さて、これらは非常に便利である。以下の gif アニメをみれば簡単にコマンドラインで操作ができる。

カスタマイズ

便利には便利なのだが、vi/Vim においても .vimrcファイルでカスタマイズするようにより良いキーバインドにすることが望ましい。例えば、viins において emacs ライクなキーバインドを利用しようと思っても ^Aなどは未定義である。

また、使用できるキー機能（ウィジェット）は決め打ちではない。ユーザによって拡充することも可能である。

viins と emacs

viins モードと emacs モードの共通点は、打鍵したものがすぐ表示されるモードであること。文字入力に特化している。加えて、何か特別の操作をするにはコントロールキーなどの修飾キーが必要であること。そして viins にはそれらのキーカスタマイズがされていない。
viins モードに emacs モードのいいところを取り込めば、emacs モードとしての機能すらも持つ viins モードと、強力な編集操作体系を持つ vicmd モードが組み合わされば、vi ライクなインターフェースはコマンドライン編集機能としてとても有力なキーマップになる。

viins を emacs モードの如くカスタマイズして、より良い CLI ライフを提供するコードがこちら。

bindkey -M viins '\er'history-incremental-pattern-search-forward
bindkey -M viins '^?'  backward-delete-char
bindkey -M viins '^A'  beginning-of-line
bindkey -M viins '^B'  backward-char
bindkey -M viins '^D'  delete-char-or-list
bindkey -M viins '^E'  end-of-line
bindkey -M viins '^F'  forward-char
bindkey -M viins '^G'  send-break
bindkey -M viins '^H'  backward-delete-char
bindkey -M viins '^K'kill-line
bindkey -M viins '^N'  down-line-or-history
bindkey -M viins '^P'  up-line-or-history
bindkey -M viins '^R'history-incremental-pattern-search-backward
bindkey -M viins '^U'  backward-kill-line
bindkey -M viins '^W'  backward-kill-word
bindkey -M viins '^Y'  yank

ウィジェット

ZLE で機能している accept-lineなどの単位のことをウィジェットという。ZLE では独自の関数を作りウィジェットとして登録することにより、好きなように機能拡張することができる。

ウィジェットの作り方は以下だ。

1. ウィジェットに登録するためのシェル関数を定義する
2. 作ったシェル関数をウィジェットに登録する
3. キーへ割り当てる（任意）

実際に作るとこんな感じになる。例えば pecoを使ったヒストリ補完を作ってみるとしよう。

# 1. ウィジェットに登録するためのシェル関数を定義する
peco-select-history(){# peco があるかないかで分岐する# なければ違うアプローチをするiftype"peco">/dev/null 2>&1;thenBUFFER=$(history 1| sort -k1,1nr | perl -ne 'BEGIN { my @lines = (); } s/^\s*\d+\s*//; $in=$_; if (!(grep {$in eq $_} @lines)) { push(@lines, $in); print $in; }'| peco --query "$LBUFFER")CURSOR=${#BUFFER}# peco で選んでる最中に Enter を押した瞬間実行する
        zle accept-line
        # 画面をクリアする
        zle clear-screen
    else# バージョンによって条件分岐するために使用するモジュールを開放する
        autoload -Uz is-at-least

        # 4.3.9 以降ではインクリメンタルパターンサーチが出来るので、それを利用する# なければデフォルトでマッピングされているものを利用するif is-at-least 4.3.9;then# zsh -la <widget> とすることで、widget に完全一致するウィジェットが# 存在する場合、返却値 0 で終了する
            zle -la history-incremental-pattern-search-backward && bindkey "^r"history-incremental-pattern-search-backward
        elsehistory-incremental-search-backward
        fifi}# 2. 作ったシェル関数をウィジェットに登録する
zle -N peco-select-history

# 3. キーへ割り当てる（任意）
bindkey '^r' peco-select-history

シェル関数さえ書いてしまえば簡単に好きな機能を実現できる。
それと少し説明で、ウィジェット内で有用な決め打ちの変数が存在する。

他にもたくさんあるのだが、よく利用されるものだけを紹介した。これによって、簡単にやりたいことがウィジェットとして実現できる。

より高度なカスタマイズ

Visual mode の実装

vi/Vim にはヴィジュアルモードという操作体系がある。簡単に文字列を反転させまとめて処理することができる。しかし、Zsh Line Editorに実装されているものは Insert mode（viins）と Command mode（vicmd）のみである（※）。

そこで、簡単な Visual mode を実装した ZLE キーマップを追加した。キーマップ名は vivis である。

• b4b4r07/zsh-vimode-visual ❤ GitHub

これによって、従来通りの viins と vicmd の行き来に加え、vivis という新モードが追加され使用することができる。

実は、デフォルトで 4 つのキーマップが開放されていたが、このキー割り当ての領域をユーザによって拡張することが簡単にできる。

$ bindkey -N new_keymap

vivis

vicmd モードで vまたは Vキー押下で vivis モードに移行する。特に Vでは vivli という行全体を意味するモードに分けているが、ここらへんの実装は変わっていくかもしれない。また、ウィジェット名やキーも変わっていくかもしれない。これについては、公式の README を参照して欲しい。

テキストオブジェクト

Vim にはテキストオブジェクトという文字加工に役立つ便利な概念がある。'や "によって囲われた文字列・単語をひとつのハンク（かたまり）と見なしてくれるのだ。これによって Vim の編集モードでは "内の文字列などに対し、簡単に変更したり削除したりすることができる。

詳しくは Vim を開いて、

:help text-objects

とすればいい。

これを zsh に実現するプラグインがある。

• hchbaw/opp.zsh

  • zshでvimのtext-objects(もどき)をしたい
  • zshでvimのsurround.vim(もどき)をしたい

既に zsh には cwといった簡単なものは実装されている（ので bindkey -vとした時点ですぐに使用できる）。しかし、このプラグインを利用することでそれらに加えて、ciwや ci"を使うことができる。この便利さはあなたが Vimmer なら説明する必要はないでしょう。

※ zsh 5.0.8から autoloadによって高度なテキストオブジェクトが開放された

• zsh 5.0.8 will have vim-like textobjects in vi mode
• zshでvimのtext-objectライクな操作をする

zsh プラグイン

zsh 5.0.8 の機能拡充によってプラグインではなく、zsh の機能として高度なテキストオブジェクトや visual モードを使用できるようになったが少し欠点があった。それは他のプラグインに干渉することだ。

zsh でのテキストオブジェクトでは "などの字句解析にノイズが交じるとうまく判定できないようだ。例えば有名な zsh プラグインに Fish ライクなシンタックスハイライトを提供する zsh-syntax-highlightingがある。この色付けにはエスケープシーケンス的なものを使っているのだが、visual モードにて字句解析をするときにそれがノイズとなり狂いをもたらしている（と思う）。

しかし、上で紹介した 2 つのプラグイン実装である、

• hchbaw/opp.zsh
• b4b4r07/zsh-vimode-visual

これらを使えば、テキストオブジェクトとビジュアルモードの両方を実現できる（ただし、visual モード時のテキストオブジェクト viw/vi"などは使用できない。しかし zsh visual では使用できる。ここらへんうまく出来ないものか）。

プロンプト

ここまで説明してきて、ZLE の emacs モードと比べて vi モードは有用なものであるとしてきた。しかし唯一、不便なことがある。それは現在のモードが分からないことだ。

emacs モードと比べ、vi モードはモードが複数ある。いま viins なのか vicmd なのか、それともプラグインによって拡張された vivis なのか分からなくなるのだ（残念ながら bindkey -vとしただけじゃモード表示はしてくれない）。

その解決には、プロンプトが適役である。

autoload -Uz colors; colors
autoload -Uz add-zsh-hook
autoload -Uz terminfo

terminfo_down_sc=$terminfo[cud1]$terminfo[cuu1]$terminfo[sc]$terminfo[cud1]
left_down_prompt_preexec(){
    print -rn -- $terminfo[el]}
add-zsh-hook preexec left_down_prompt_preexec

function zle-keymap-select zle-line-init zle-line-finish
{case$KEYMAP in
        main|viins)PROMPT_2="$fg[cyan]-- INSERT --$reset_color";;
        vicmd)PROMPT_2="$fg[white]-- NORMAL --$reset_color";;
        vivis|vivli)PROMPT_2="$fg[yellow]-- VISUAL --$reset_color";;esacPROMPT="%{$terminfo_down_sc$PROMPT_2$terminfo[rc]%}[%(?.%{${fg[green]}%}.%{${fg[red]}%})%n%{${reset_color}%}]%# "
    zle reset-prompt
}

zle -N zle-line-init
zle -N zle-line-finish
zle -N zle-keymap-select
zle -N edit-command-line

プロンプトはコマンドラインを実行する（accept-line）たびに、表示内容を一新する。それにより、モードも毎回チェックして更新することが出来る。

これによって実現できるプロンプトがこれだ。

-- NORMAL --は vicmd モードを指し、-- INSERT --は viins モードを指す。プラグインによるモードも解釈するようになっていて -- VISUAL --とでる。Vim そのものだ。

また、このプロンプトの実現には RPROMPT（右プロンプト）は使っていないので、ユーザの設定領域は確保してある。

• vi-mode (oh-my-zsh)
• make my zsh prompt show mode in vi mode
• How do I customize zsh's vim mode?
• zsh vi mode status line

まとめ

長々と zsh（ZLE）の vi モードについて取り扱った。より拡張してくれるプラグイン実装を使ったり、キー設定をすることでより便利なエディットが可能になる。Vimmer は特に導入して試してみる価値がある！！！！！！

あ、それと、長い設定例が続いたため、記事内のコードをまとめた ZLE vi mode のリポジトリを作成しました。

• b4b4r07/zle-vimode ❤ GitHub

ダウンロードして sourceすればプロンプトから何からいい感じに動きます。Antigenユーザなら、

$ antigen bundle b4b4r07/zle-vimode

でいけます。お試しあれ。