ruvim

RuVim コマンド一覧

起動オプション（CLI, 現状）

• --help, --version
• -f（follow mode: ファイルを開いて末尾から tail -f 相当の追従モードで起動）
• --clean
• -d（diff mode placeholder, 未実装メッセージ表示）
• -q {errorfile}（quickfix startup placeholder。現状は未実装メッセージ表示）
• -S [session]（session startup placeholder, 未実装メッセージ表示）
• -R
• -M
• -Z
• -n（現状 no-op）
• -o[N], -O[N], -p[N]
• -V[N], --verbose[=N]
• --startuptime FILE
• --cmd {cmd}（user config 読み込み前に Ex 実行）
• -u {path|NONE}
• -c {cmd}
• +{cmd}, +{line}, +

補足（現状挙動）:

• cmd | ruvim
  • stdin を follow stream として開く（[stdin] バッファ）
  • Normal mode の Ctrl-c で stream 停止（上流プロセスには直接 SIGINT は送らない）
• Ctrl-z
  • 全モード共通で shell へ suspend（SIGTSTP）
  • suspend 前に terminal を cooked + main screen へ戻す
  • fg 復帰後は alt screen を再有効化し、画面を全面再描画する

Ex コマンド（builtin）

:w / :write

• 形式: :w [path]
• 現在バッファを保存
• path 指定時はそのパスに保存
• ! 対応: :w!（現状は保存メッセージに反映、権限昇格などは未実装）

:q / :quit

• 形式: :q, :q!
• 複数 window があるとき: current window を閉じる
• window が1つで tab が複数あるとき: current tab を閉じる
• 最後の window / tab のとき: エディタ終了
• 最後の window / tab で未保存変更がある場合、! なしでは拒否

:qa / :qall

• 形式: :qa, :qa!
• 全ウィンドウ/タブを無視して一括終了
• 未保存変更があるファイルバッファが存在する場合、! なしでは拒否

:wq

• 形式: :wq, :wq!, :wq [path]
• 保存して :q 相当（window / tab / app を閉じる）

:wqa / :wqall / :xa / :xall

• 形式: :wqa, :wqa!
• 変更のある全ファイルバッファを保存して一括終了

:e / :edit

• 形式: :e[!] [path]
• 引数あり: 別ファイルを開く
• 引数なし: 現在ファイルを再読込
• 未保存変更がある場合は ! なしで拒否
• :e! は未保存変更を破棄して開き直す（undo/redo もクリア）
• 大きいファイル（閾値以上）は段階読み込みになる場合がある
  • 読み込み中は statusline に [load/live]
  • デフォルトでは先頭 8MB を先に表示して、残りを後から追加
  • 閾値: RUVIM_ASYNC_FILE_THRESHOLD_BYTES
  • 先読みサイズ: RUVIM_ASYNC_FILE_PREFIX_BYTES

:help

• 形式: :help [topic]
• help 用の read-only バッファを開く（仮想バッファ）
• 例:
  • :help
  • :help regex
  • :help options
  • :help w

:commands

• 形式: :commands
• Ex コマンド一覧（alias 含む）を read-only バッファに表示

:bindings

• 形式: :bindings [mode]
• 現在バッファに対して有効な key binding 一覧を read-only バッファに表示
• layer ごとに表示:
  • buffer
  • filetype
  • app
• mode は任意（例: normal, insert, visual_line, command_line。短縮形 n, i, v, c なども可）

quickfix / location list（最小）

• :vimgrep /pattern/
  • 現在開いている file buffer 群を検索して quickfix list を作成
• :lvimgrep /pattern/
  • current window の current buffer を検索して location list を作成
• :copen / :cclose
  • quickfix list を read-only な qf バッファで開く / 閉じる
• :cnext / :cn, :cprev / :cp
  • quickfix 項目を前後移動して該当位置へジャンプ
• :lopen / :lclose
  • current window の location list を開く / 閉じる
• :lnext / :ln, :lprev / :lp
  • location list 項目を前後移動して該当位置へジャンプ
• :grep pattern [path...]
  • 外部 grep（grepprg）を実行して quickfix list を作成
  • シェル経由ではなく argv 配列で安全に実行（シェルインジェクション対策済み）
  • ワイルドカード（*.txt 等）は Ruby の Dir.glob で展開
  • -Z（restricted mode）では無効
• :lgrep pattern [path...]
  • 外部 grep（grepprg）を実行して location list を作成
  • :grep と同じセキュリティ仕様
• 一覧バッファ上で Enter : 選択項目へジャンプ（一覧ウィンドウから元の編集ウィンドウへ戻る）
• 現状の制限:
  • :make, :cfile, :lfile は未実装

:git

• 形式: :git <subcommand> [args...]
• Git 操作の統合インターフェース
• -Z（restricted mode）では無効
• サブコマンド:
  • blame : 現在ファイルの git blame を表示（read-only バッファ）
    • blame バッファ内: p 親コミットの blame / P 前の blame へ戻る / c コミット詳細
  • status : git status を表示
  • diff : git diff を表示
  • log : git log を表示
  • branch : ブランチ一覧を表示
    • branch バッファ内: Enter で :git checkout <branch> をコマンドラインにプリセット（確認ステップあり）
  • checkout <branch> : 指定ブランチへチェックアウト
  • commit : コミットメッセージ入力バッファを開く
  • grep <pattern> [args...] : git grep -n を実行、結果バッファで Enter ジャンプ
  • その他の未知サブコマンド: :! と同様に alternate screen でシェル実行（例: :git stash, :git rebase -i）
• Git バッファは Esc / Ctrl-c で閉じる
• Tab 補完: git help -a の出力から全サブコマンドを補完候補として提示（セッション内キャッシュ）

:gh

• 形式: :gh <subcommand> [args...]
• GitHub 連携の統合インターフェース
• -Z（restricted mode）では無効
• サブコマンド:
  • link : 現在ファイル/選択範囲の GitHub URL を生成してクリップボードにコピー
  • browse : 現在ファイルの GitHub URL をブラウザで開く
  • pr : 現在ブランチの PR ページをブラウザで開く
  • その他の未知サブコマンド: :! と同様に alternate screen でシェル実行（例: :gh issue list）
• Tab 補完: gh help の出力からサブコマンドを補完候補として提示（セッション内キャッシュ）

:rich

• 形式: :rich [format]
• Rich mode を開始 / 終了する（トグル）
• format に tsv または csv を指定可能（省略時は filetype / 内容から自動判定）
• 同一バッファ上で動作し、描画時にテーブル整形を適用する
• Rich mode では移動・検索・yank 等は使えるが、バッファ変更操作はブロックされる

• 区切り文字は `

  `（スペース+パイプ+スペース）

• 列幅は画面に見えている行だけから計算（大規模ファイルでも高速）
• Esc / Ctrl-C で Normal mode に戻る

:filter

• 形式: :filter [/pattern/]
• 現在の検索パターン（引数なし）または指定パターンにマッチする行だけを集めたフィルタバッファを作成
• フィルタバッファ上で再度 :filter や g/ を使うと再帰的に絞り込める
• Enter で元バッファの該当行へジャンプ（フィルタバッファは閉じる）
• :q でフィルタバッファを閉じて前のバッファに戻る
• 元バッファの filetype を引き継ぐ（TSV なら gr でテーブル表示可能）
• Normal mode では g/ キーバインドで実行可能

:follow

• 形式: :follow
• ファイルの follow mode をトグルする（tail -f 相当）
• follow 中はファイルへの追記がリアルタイムにバッファへ反映される
• カーソルが最終行にいる場合は末尾を自動追従（auto-scroll）
• カーソルが途中にある場合はスクロール位置を維持
• G で末尾に移動すれば追従が再開される
• :follow を再度実行すると停止
• Ctrl-C（ノーマルモード）で follow を停止
• statusline に [follow] と表示される（inotify 使用時は [follow/i]）
• ファイルが紐づいていないバッファではエラー
• 未保存の変更があるバッファでは follow 開始不可
• follow 中のバッファは変更不可（modifiable が false）
• ファイルが truncate された場合はメッセージを表示し監視を継続
• ファイルが削除された場合はメッセージを表示し、再作成を待って監視を再開
• follow 停止時、バッファ内容はそのまま保持（:e! で再読み込み可能）
• 監視方式: Linux では inotify（fiddle 経由）を優先し、使えない場合は polling にフォールバック
  • polling は exponential backoff（0.1s → 3s）で CPU 負荷を抑える

:command

• 形式: :command Name ex_body
• 形式: :command! Name ex_body（上書き）
• ユーザー定義 Ex コマンドを追加
• :command（引数なし）でユーザー定義コマンド一覧を表示

:ruby / :rb

• 形式: :ruby <code>
• 形式: :rb <code>
• Ruby コードを評価し、返り値をステータスに表示
• stdout / stderr に出力があった場合は [Ruby Output] 仮想バッファに表示（返り値も末尾に表示）
• 利用可能: ctx, editor, buffer, window

:r / :read（ファイル・コマンド出力の挿入）

• 形式: :r <file> または :r !<command>
• ファイルの内容またはシェルコマンドの stdout をカーソル行の下に挿入します
• 行番号指定可: :3r file.txt（3行目の下に挿入）
• :r !command で stderr が出た場合、最初の行をエラーメッセージとして表示します

:w !（バッファ内容をコマンドへパイプ）

• 形式: :w !<command> または :'<,'>w !<command>
• バッファ（または範囲指定された行）の内容をシェルコマンドの stdin に渡します
• 例: :w !wc -l（行数カウント）、:'<,'>w !sort（選択範囲をソート）

:!（shell 実行）

• 形式: :!<command>
• alternate screen を一時的に抜けて main screen 上で shell コマンドを同期実行します（Vim 互換）
• 実行後 “Press ENTER or type command to continue” を表示し、入力待ち後にエディタに復帰
• 完了後は shell exit N をステータス表示
• -Z（restricted mode）では無効

:run（コマンド実行＋結果バッファ）

• 形式: :run [command]
• シェルコマンドを実行し、出力を [Shell Output] バッファにストリーム表示（PTY 経由でリアルタイム）
• [Shell Output] バッファは read-only で、最大1つ（再利用される）
• stdout / stderr はマージされて表示
• コマンド中の % は現在のファイル名に展開される
• コマンド文字列はシェル引用符を保持（raw 解析）
• 変更のあるバッファは実行前に自動保存される
• 引数なしの場合:
  • そのバッファで直前に実行したコマンドがあればそれを再実行
  • なければ runprg オプションの値を使用
• バッファごとに実行履歴（直前のコマンド）を保持
• 実行中のコマンドはステータスラインに表示（[run] command、完了後は [run/exit N] command）
• Ctrl-C で実行中のプロセスを停止
• runprg オプション: ファイルタイプごとのデフォルト実行コマンド
  • Ruby: ruby -w %
  • Python: python3 %
  • C: gcc -Wall -o /tmp/a.out % && /tmp/a.out
  • C++: g++ -Wall -o /tmp/a.out % && /tmp/a.out
  • Scheme: gosh %
  • JavaScript: node %

:ls / :buffers

• 形式: :ls
• 形式: :buffers
• バッファ一覧をステータスに表示
• %=current, #=alternate, +=modified のフラグを含む

:bnext / :bn

• 形式: :bnext
• 次のバッファへ切替
• ! 対応（未保存変更を無視して切替）

:bprev / :bp

• 形式: :bprev
• 前のバッファへ切替
• ! 対応（未保存変更を無視して切替）

:buffer / :b

• 形式: :buffer <id|name|#>
• バッファ ID / 名前 / #（alternate）で切替
• ! 対応（未保存変更を無視して切替）

:bdelete / :bd

• 形式: :bdelete [id|name|#]
• 現在バッファ（または指定バッファ）を一覧から削除
• 表示中 window は別バッファへ切り替えられる
• ! 対応（未保存変更バッファを破棄）

:args

• 形式: :args
• 引数リスト（arglist）を表示
• 現在の引数は [filename] 形式で表示される

:next

• 形式: :next
• arglist の次の引数ファイルを開く
• エラー: 最後の引数で実行時

:prev

• 形式: :prev
• arglist の前の引数ファイルを開く
• エラー: 最初の引数で実行時

:first

• 形式: :first
• arglist の最初の引数ファイルを開く

:last

• 形式: :last
• arglist の最後の引数ファイルを開く

:split

• 形式: :split
• 現在 window を水平分割（簡易タイル）
• 同じ buffer を新しい window に表示

:vsplit

• 形式: :vsplit
• 現在 window を垂直分割（簡易タイル）
• 同じ buffer を新しい window に表示

:tabnew

• 形式: :tabnew [path]
• 新しいタブを作成
• path 指定時はそのファイルを開く

:tabnext / :tabn

• 形式: :tabnext
• 次のタブへ移動

:tabprev / :tabp

• 形式: :tabprev
• 前のタブへ移動

:tabs

• 形式: :tabs
• 全タブページの一覧を表示
• 各タブに含まれるウィンドウとバッファ名を表示
• 現在のタブ / ウィンドウは > マーカーで示す

:p / :print

• 形式: :{range}p
• 指定範囲の行を表示する
• :global のデフォルトコマンド

:nu / :number

• 形式: :{range}nu
• 指定範囲の行を行番号付きで表示する

:d / :delete

• 形式: :d [count], :{range}d
• 行を削除

:y / :yank

• 形式: :y [count], :{range}y
• 行をヤンク

:m / :move

• 形式: :{range}m {address}
• 行を指定アドレスの後ろに移動する
• :{range}m$ で末尾に移動、:{range}m0 で先頭に移動

:t / :copy / :co

• 形式: :{range}t {address}
• 行を指定アドレスの後ろにコピーする

:j / :join

• 形式: :{range}j
• 範囲内の行を結合する（空白で連結）

:> / :<

• 形式: :{range}>, :{range}<
• 行を shiftwidth 分だけ右/左にシフトする

:normal / :norm

• 形式: :{range}normal {keys}
• 各行で Normal mode コマンドを実行する
• 範囲指定時は各行にカーソルを移動して実行
• :g/pattern/normal A; のように :global と組み合わせて使える

内部コマンド（主なもの）

内部コマンドは主に key binding から使われ、RuVim::CommandRegistry に登録されます。

• cursor.left
• cursor.right
• cursor.up
• cursor.down
• cursor.line_start
• cursor.line_end
• cursor.first_nonblank
• cursor.buffer_start
• cursor.buffer_end
• cursor.word_forward
• cursor.word_backward
• cursor.word_end
• mode.insert
• mode.append
• mode.append_line_end
• mode.insert_nonblank
• mode.open_below
• mode.open_above
• mode.visual_char
• mode.visual_line
• window.split
• window.vsplit
• window.focus_next
• window.focus_left
• window.focus_right
• window.focus_up
• window.focus_down
• tab_new
• tab_next
• tab_prev
• mode.command_line
• mode.search_forward
• mode.search_backward
• buffer.delete_char
• buffer.delete_line
• buffer.delete_motion
• buffer.change_motion
• buffer.change_line
• buffer.yank_line
• buffer.yank_motion
• buffer.paste_after
• buffer.paste_before
• buffer.visual_yank
• buffer.visual_delete
• buffer.undo
• buffer.redo
• search.next
• search.prev
• editor.buffer_next
• editor.buffer_prev
• buffer.replace_char
• buffer.substitute_char
• buffer.swapcase_char
• buffer.join_lines
• buffer.indent_lines
• buffer.indent_motion
• buffer.visual_indent
• buffer.visual_select_text_object
• mode.visual_block
• cursor.page_up / cursor.page_down
• cursor.page_up.default / cursor.page_down.default
• cursor.page_up.half / cursor.page_down.half
• cursor.match_bracket
• window.scroll_up / window.scroll_down
• window.scroll_up.line / window.scroll_down.line
• window.cursor_line_top / window.cursor_line_center / window.cursor_line_bottom
• window.focus_or_split_left / window.focus_or_split_right / window.focus_or_split_up / window.focus_or_split_down
• normal.register_pending_start
• normal.operator_delete_start / normal.operator_yank_start / normal.operator_change_start / normal.operator_indent_start
• normal.replace_pending_start
• normal.find_char_forward_start / normal.find_char_backward_start / normal.find_till_forward_start / normal.find_till_backward_start
• normal.find_repeat / normal.find_repeat_reverse
• normal.change_repeat
• normal.macro_record_toggle / normal.macro_play_pending_start
• normal.mark_pending_start
• normal.jump_mark_linewise_pending_start / normal.jump_mark_exact_pending_start
• quickfix.next / quickfix.prev / quickfix.open
• stdin.stream_stop
• ui.clear_message
• rich.toggle

検索コマンド（Normal mode）

検索は Ex コマンドではなく、command-line prefix / ? を使う入力経路です。

• /pattern : 前方検索
• ?pattern : 後方検索
• n : repeat
• N : reverse repeat
• * / # : カーソル下の単語検索（単語境界）
• g* / g# : カーソル下の単語検索（部分一致）
• :vimgrep / :lvimgrep : 検索結果を quickfix/location list に積む
• :nohlsearch (:noh) : 検索ハイライトを一時的にクリア（次の検索で自動復帰）

:%s/.../.../[flags]

• バッファ全体置換（レンジ指定対応: :{range}s/.../.../）
• Ruby 正規表現 + Ruby 置換文字列を利用
• 対応フラグ: g（全置換）, i（大文字小文字無視）, I（大文字小文字区別）, n（置換せずマッチ数表示）, e（エラー抑制）
• c（確認）フラグ: y/n/a/q/l/Esc 対応

:global / :vglobal

• 形式: :[range]g/pattern/command, :[range]v/pattern/command
• g! は :vglobal と同義
• パターンにマッチする（:v の場合はマッチしない）全行に対して Ex コマンドを実行
• コマンド省略時は :p（print）扱い
• :global / :vglobal のフルネーム形式にも対応
• undo は一括（一回の u で全変更を元に戻せる）
• 行が削除された場合の行番号シフトを自動追跡

Operator-pending（Normal mode）

現状は delete / yank operator を実装:

• d + motion
• y + motion（現状 yy, yw）
• c + motion / cc
• 実装の内部コマンド: buffer.delete_motion
• dd は linewise delete として扱う

text object（現状）

• iw, aw, ip, ap（簡易）
• i", a", i`, a`（簡易）
• i), a), i], a], i}, a}（簡易）
• d, y, c から利用可能
• Visual mode からも利用可能（選択更新）

Visual mode

• v / V / Ctrl-v で characterwise / linewise / blockwise Visual mode
• buffer.visual_yank
• buffer.visual_delete
• blockwise は最小実装（矩形選択 + y/d）
• blockwise の text object 選択 / paste の Vim 互換挙動は未対応
• Ctrl-z で shell へ suspend（fg で復帰）

repeat（Normal mode）

• . : 直前変更の repeat（拡張版）
• 現状の対象:
  • x
  • dd, d{motion}
  • p, P
  • r<char>
  • i, a, A, I, o, O（Insert 入力列）
  • cc, c{motion}（text object を含む）
• macro 記録中に . を押した場合、内部で再生されるキーは macro に混ざらない

レジスタ（現状）

• unnamed register（"）、named register（"a.."z）、append（"A.."Z）
• black hole register（"_）
• yank register 0
• numbered delete registers 1-9（簡易回転）
• "+, "* は system clipboard register（利用可能環境のみ）
• delete / yank で更新
• p, P で paste（register prefix 対応）

Option / Ex（現状）

• :set, :setlocal, :setglobal
• 現状の接続済み option:
  • number（window-local / 行番号表示）
  • relativenumber（window-local / 相対行番号）
  • ignorecase / smartcase / hlsearch（global / 検索系）
  • tabstop（buffer-local / タブ展開幅）
  • filetype（buffer-local / 自動検出 + ftplugin 用）

実装ポリシー

• Ex コマンド名（:w など）と内部コマンド名（file_write / buffer.undo など）を分離
• builtin は Symbol ベースで RuVim::GlobalCommands のメソッドに実装
• 拡張用に Proc の登録も可能
• key binding は KeymapManager の layered resolution（filetype / buffer / mode / global）で解決
• XDG 設定ファイル（$XDG_CONFIG_HOME/ruvim/init.rb または ~/.config/ruvim/init.rb）から ConfigDSL 経由で command / ex command / key binding を追加可能

UI メモ（現状）

• Screen は行キャッシュを使った簡易差分描画を行う
• SIGWINCH + self-pipe + IO.select で入力待機中でもリサイズに即追従
• Ctrl-z suspend/fg 復帰後は Screen キャッシュを破棄し、全面再描画する
• command-line は履歴と Ex 補完（コマンド名 + 一部引数の文脈補完）を持つ
• Insert mode は Ctrl-n / Ctrl-p の buffer words 補完を持つ
• 文字幅は DisplayWidth の近似実装（tab 展開 + 一部全角幅2）

テスト（現状）

• Minitest
• test/buffer_test.rb
• test/dispatcher_test.rb
• test/keymap_manager_test.rb