2023年4月06日
Emacsの魅力といえばカーソル移動、バッファ移動を含めた補完UIです。元祖はanythingで僕はhelmが出た後もずいぶん長く使っていました。melpaからanythingが削除されて、helmに移動した後も、使い勝手はanythingに極力近づけて利用していました。
そんなhelmも時代的に移行が囁かれてきたので、試しによくある補完UIの構成を試してみます。
helmからconsultベースの構成に移行して唯一不満があるのは
consult-buffer
でバッファを一覧を表示して、不必要なバッファを削除できないことです。helmの場合はhelm-mini
バッファを表示て、buffer-run-kill-persistent(C-c d)
で削除できたので便利でした。embarkは使い方がむずかしそうだったので、私は利用していません。
それ以外はおおむね満足しています。
先に完成済みのコードをまとめておきます。
;; エコーエリア内で入力の補完をサポートする
(use-package vertico
:ensure t
:init
;; 補完候補を最大15行まで表示する
(setq vertico-count 15)
(vertico-mode))
;; find-file時に上のディレクトリに戻るのをサポートする
(use-package extensions/vertico-directory
:straight (:type built-in)
:after vertico
:ensure nil
:bind (:map vertico-map
("C-l" . vertico-directory-up)
("\\d" . vertico-directory-delete-char)))
;; 対話型コマンドを利用しやすくする
(use-package consult
:ensure t
:bind
(("C-x C-a" . consult-buffer) ;; anythingの名残でC-x C-aにバインド
("M-g M-g" . consult-goto-line) ;; goto-lineをconsult-goto-lineに置き換え
("C-c s" . consult-line) ;; バッファ内をキーワードで検索
("C-c o" . consult-outline))) ;; ファイルのアウトラインになりうる項目へ移動
;; 最近開いたファイルを参照
(use-package recentf
:config
(setq recentf-max-saved-items 15) ;; consult-bufferに表示する最近使ったファイルの最大表示数
(setq recentf-exclude '(".recentf" "^/ssh:")) ;; recentfの履歴に含ませないファイルリスト
(setq recentf-auto-cleanup 'never) ;; recentfの履歴を削除しない
(setq recentf-auto-save-timer
(run-with-idle-timer 30 t 'recentf-save-list)) ;; バッファを開いて30秒以上したら履歴に登録
(recentf-mode 1)
;; recentf の メッセージをエコーエリア(ミニバッファ)に表示しない
;; (*Messages* バッファには出力される)
(defun recentf-save-list-inhibit-message:around (orig-func &rest args)
(setq inhibit-message t)
(apply orig-func args)
(setq inhibit-message nil)
'around)
(advice-add 'recentf-cleanup :around 'recentf-save-list-inhibit-message:around)
(advice-add 'recentf-save-list :around 'recentf-save-list-inhibit-message:around)
)
;; verticoの絞り込みにあいまい検索を追加
(use-package orderless
:ensure t
:custom
(completion-styles '(orderless basic))
(completion-category-overrides '((file (styles basic partial-completion)))))
;; consultのリストなどにメタ情報を表示する
(use-package marginalia
:ensure t
:init
(marginalia-mode))
vertico
verticoは補完UIの1つです。主にユーザーと対話的エコーエリアで操作するコマンドを良い感じにしてくれます。
よく使いそうな場面を紹介します。
yank-pop
はEmacsでテキストを切り取ったり、コピーした情報を貼り付ける機能でM-y
で起動します。Verticoはコピー、切り取り履歴もサポートします。クリップボードの絞り込みと選択が便利になっています。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/6e3f40f8-d193-4e8e-baae-888ec895285f/yankpop.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T075948Z&X-Amz-Expires=3600&X-Amz-Signature=46ea25fd30d65937d092f39b1f3eb0276b6106c6a110843e06f168c40e781a53&X-Amz-SignedHeaders=host&x-id=GetObject)
find-file
はファイルを探し開くコマンドでC-x C-f
で起動します。エコーエリアに候補となるディレクトリとファイルが表示され、ディレクトリを移動して任意のファイルを選びエンターで開けます。verticoは入力の補完でTabが機能します。入力、候補の選択もかなり良い感じになります。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/6a468bc2-724d-465f-b2db-e089215f575e/findfile.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T075948Z&X-Amz-Expires=3600&X-Amz-Signature=a49396345efa2bf6710c8c6906c32629b5b50f7fbccef4fa172917e7c7070d82&X-Amz-SignedHeaders=host&x-id=GetObject)
switch-to-buffer
は開いているバッファを切り替えるためのコマンドでC-x b
を使って起動します。verticoを使っていると、エコーエリアに移動できるバッファがリストで表示されるので、ファイル名をタイプしたり、C-n
、C-p
でカーソルを移動させて目的のバッファに切り替えます。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/359b7ab4-43ce-47c5-8287-059851e53c80/switchbuffer.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T075948Z&X-Amz-Expires=3600&X-Amz-Signature=3928b510bc95a24cb8c47c7594600dffa65f5ffcf678c931cda017ddc5df648f&X-Amz-SignedHeaders=host&x-id=GetObject)
他にも対話型なら大体verticoがサポートしてくれます。
vertico-directory
find-file
でファイルを探すときに1つ上のディレクトリに戻る方法がvertico単体だとかなりいけてないです。ディレクトリを下るときはTabで候補が補完されます。一方で、上に上がろうとすると、デリートキーを連打しなくてはなりません。helmはC-l
またはデリートキーで上の階層に移動できました。vertico-directory
はfind-fileのディレクトリ移動をサポートする拡張機能です。C-l
で1つ上の階層にサクサク移動できるのでディレクトリ移動が楽になります。consult
consultはEmacsが提供する対話型コマンドをその名の通り相談しやすくしてくれます。verticoはあくまで入力の補完をサポートしています。consultはEmacsコマンド全体をサポートする意味合いが強いです。
consultはかなり多くの機能を提供しています。全てを説明するのは難しいのでよく使うコマンド4つを紹介します。それ以外はgithubのReadmeを読むと良いでしょう。
consult-buffer
helmやanythingでいうところのmini-bufferにあたるのがこれです。デフォルトでは現在開いているバッファのリストしか表示されませんが、カスタマイズすることで、最近開いたファイル、ブックマークしたファイルを表示できます。
多くのサイトでは
C-x b
のswitch-to-buffer
を上書きを紹介しています。私はずっとhelmを使っていたのでC-x C-a
にバインドしています。consult-goto-line
consult-goto-line
は目的の行数にジャンプする機能を強化します。
本来のgoto-line
はエコーエリアで目的の行数をタイプし、エンターを押すことで移動します。一方で、consult-goto-line
は行数を入力すると、エディタにプレビューが表示されます。大変便利で、移動しようと思った場所が違った場合は、エコーエリアの行数を削除して別の数字を入力すればそっちが候補として表示されます。目的の場所が定まったらエンターを押せば移動できます。Gitの差分を見ていて、編集したいときに行数を覚えておくだけで、すぐに目的のコードに移動できるのは便利です。consult-line
consult-line
はバッファ内を検索し、該当するテキストをリストで表示し、プレビューを表示しながら、目的の行へ移動するのをサポートしてくれます。これとよく似たEmacsの標準コマンドはisearch-forward
になります。こっちは絞り込みが弱かったり、プレビューがありません。consult-outline
consult-outline
はファイルの見出しをざっくり候補として表示し移動できるようにしてくれます。特にMarkdownで文章を書いている場合に利用します。各ヘッダーをリスト化して表示するので、簡単に目的の文章へ飛ぶことができます。consult-bufferに最近使ったファイルを表示
init.el
にrecentf-mode
の設定を記述すれば、自動的にconsult-buffer
に開いたファイルの履歴が載るようになります。設定自体は、僕もよくわからなかったので、こちらの記述を参考にさせてもらいました。
recentfの設定を書いて
consult-buffer
を実行すると、最近利用したファイルの一覧がバッファ一覧の下に表示されます。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/18692901-a0f6-4d39-bfba-a58dd5782676/recentf.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T075948Z&X-Amz-Expires=3600&X-Amz-Signature=ecd498a618e33f180d18762780600515bfce6f67d11aca13ed3255e38ade8689&X-Amz-SignedHeaders=host&x-id=GetObject)
bookmarkを表示
Emacsは標準機能でBookmarksがあり、バッファの任意の場所をブックマークできます。ブックマークはエディタを閉じた後でも残っており、いつでも目的のブックマークにconsult-bufferでジャンプできます。
emacsのbookmarkに関する基本的なコマンドはこちらに詳しく書いてあります。
試しに.
init.el
の適当な行をブックマークします。
M-x bookmark-set
対話が始まるので、ブックマーク名をタイプしてエンターを押します。ブックマークを登録して、
M-x consult-buffer
を起動すると、一番下に登録したブックマークが表示されます。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/ac698a88-cf0a-4481-a362-5eb1aabd8e3f/bookmark.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T075948Z&X-Amz-Expires=3600&X-Amz-Signature=ee81234d4bb72e230ae1ba217435be5ea6e4a33c7b703d06e4c32e23f9521adb&X-Amz-SignedHeaders=host&x-id=GetObject)
ブックマークを削除する場合は
M-x bookmark-delete
で対象のブックマークを選ぶだけです。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/8850db13-ee62-4b9e-88f5-abe941d6c20d/deletebookmark.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T075948Z&X-Amz-Expires=3600&X-Amz-Signature=5f9b2c4793e95fdbd9b82b3bff69a8f2e99fdf17cf399ae0a970b9630c22dc95&X-Amz-SignedHeaders=host&x-id=GetObject)
絞り込みにあいまい検索する
標準のVerticoでは対話的に候補を絞り込むときに、絞り込みは先頭からマッチするものしか入力できません。例えば
M-x
でbook del
と入力してもbookmark-delete
は補完候補として出てきません。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/45445158-59dd-455f-a784-2f05ae3e7f93/mismatch.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T075948Z&X-Amz-Expires=3600&X-Amz-Signature=3f99caafceb1b83a8fabc38cb3bb9532c567a14c5450e6dc982462e11d617c7b&X-Amz-SignedHeaders=host&x-id=GetObject)
orderlessを入れると、スペースであいまい検索が可能になります。
![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/1b4aec14-9476-4081-a06e-744c3d953c4f/orderlessmatch.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T075948Z&X-Amz-Expires=3600&X-Amz-Signature=5ceb6012a623e1c8dc3f0bd2758b2efab07d39e841c31a9eef68d0e0aef7084d&X-Amz-SignedHeaders=host&x-id=GetObject)
メタ情報の表示
consult-buffer
でリストを表示したり、M-x
でコマンドを実行しようとしたときに、より多くのメタ情報を表示してくれるのがmarginalia
です。marginalia
が無い状態でバッファーを表示すると、このようにシンプルです。![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/f852bf57-b340-4f06-8a2d-87eaf60f61df/plain.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T075948Z&X-Amz-Expires=3600&X-Amz-Signature=51e3e1e719e145b2b7e392eed2a4d72f710106b4b0f32f08a8f41d1c66ebd94b&X-Amz-SignedHeaders=host&x-id=GetObject)
メタ情報がありの表示。
![article image](https://prod-files-secure.s3.us-west-2.amazonaws.com/a3d79190-572a-4604-a045-8b27c534a5b2/bfde2e42-9386-4f8a-ba2e-4476901387f6/marginalia.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240727%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240727T075948Z&X-Amz-Expires=3600&X-Amz-Signature=987b748d1db72e82381ca43d93e5ea3e0cc5a3199fe8f1f0614ea2d49f8d7200&X-Amz-SignedHeaders=host&x-id=GetObject)
まとめ
Emacsの補完UIは時代と共にトレンドとなるパッケージは変化するけれども、GUIエディタにはないカーソル移動、ファイル移動の体験ができて、今後もずっと残っていてほしい機能です。
![profile image](/prof.jpg)
Ted
大学でコンセンサスアルゴリズムを研究。卒業後ベンチャー企業に入社してフルスタックでWebサービスを開発。現在は大手IT企業に転職し、プログラミングを行っている。AIにプログラマーの仕事を奪って欲しいと願っている。