tmux-fuzzy-motion 0.0.4 → 0.0.7

package/README.ja.md

@@ -2,20 +2,23 @@
 
 [English README](./README.md)
 
-`tmux-fuzzy-motion` は、`tmux copy-mode` 内で素早くカーソル移動するための
-CLI です。現在の viewport からジャンプ対象を抽出し、fuzzy search で絞り込み、
+`tmux-fuzzy-motion` は、tmux pane 内で素早くカーソル移動するための CLI です。
+現在の viewport からジャンプ対象を抽出し、fuzzy search で絞り込み、
 大文字の hint で移動できます。英字のローマ字 query に対しては Migemo による
 日本語マッチも行います。
 
 ## 特徴
 
 - `tmux copy-mode` 内で動作
+- `start` は copy mode の外から起動しても自動で copy mode に入る
+- `start --scope all` は current window の visible pane 全体を対象にできる
 - 現在の viewport から URL、path、filename、symbol、一般的な単語を抽出
 - `fzf` による fuzzy match
 - `jsmigemo` による英字 query の Migemo マッチ
 - overlay 描画時も pane の色を維持
+- 外部 daemon を再利用し、matcher と Migemo の起動コストを常駐側へ寄せる
 - 単一キーの大文字 hint で素早く選択
-- query は対象 pane 内に描画し、終了時に元の pane を復元
+- UI は tmux popup で表示し、常駐用の scratch window を作らない
 
 ## 動作要件
 
@@ -51,10 +54,36 @@ npx tmux-fuzzy-motion@latest doctor
 `tmux.conf` に次を追加してください。
 
 ```tmux
-bind-key -T copy-mode-vi s run-shell -b 'tmux-fuzzy-motion start #{pane_id} #{client_tty}'
-bind-key -T copy-mode s run-shell -b 'tmux-fuzzy-motion start #{pane_id} #{client_tty}'
+bind-key -T copy-mode-vi s run-shell 'tmux-fuzzy-motion start #{pane_id} #{client_tty}'
+bind-key -T copy-mode s run-shell 'tmux-fuzzy-motion start #{pane_id} #{client_tty}'
 ```
 
+copy mode の外からも起動したい場合は、root table にも bind を追加します。
+
+```tmux
+bind-key s run-shell 'tmux-fuzzy-motion start #{pane_id} #{client_tty}'
+```
+
+current window の visible pane 全体から選びたい場合は、`--scope all` を付けた bind を追加します。
+
+```tmux
+bind-key S run-shell 'tmux-fuzzy-motion start --scope all #{pane_id} #{client_tty}'
+```
+
+`start` サブコマンドを経由せずに tmux から直接 popup を開きたい場合は、次の設定も使えます。
+
+```tmux
+bind-key -T copy-mode-vi s run-shell -C "display-popup -E -B -x '##{popup_pane_left}' -y '##{popup_pane_top}' -w '#{pane_width}' -h '#{pane_height}' 'tmux-fuzzy-motion popup-live #{pane_id}'"
+bind-key -T copy-mode s run-shell -C "display-popup -E -B -x '##{popup_pane_left}' -y '##{popup_pane_top}' -w '#{pane_width}' -h '#{pane_height}' 'tmux-fuzzy-motion popup-live #{pane_id}'"
+```
+
+> [!NOTE]
+> 後述の手順の`2.`で`'tmux-fuzzy-motion start %25 /dev/ttys000' returned 127`のようなエラーが表示される場合は以下のようにrun-shell環境のPATHに`tmux-fuzzy-motion`を含める必要があります。
+>
+> ```tmux
+> set-environment -g PATH "/path/to/node/bin:$PATH"
+> ```
+
 設定変更後は tmux を reload します。
 
 ```bash
@@ -63,13 +92,15 @@ tmux source-file ~/.tmux.conf
 
 ## 使い方
 
-1. `copy-mode` に入る
-2. `s` を押す
-3. 小文字や記号で query を入力する
-4. fuzzy match で候補を絞り込む
-5. 英字 query の場合は Migemo による日本語候補も対象になる
-6. 大文字 hint を押して即座に移動する
-7. `Esc` または `Ctrl-[` でキャンセルする
+1. `tmux-fuzzy-motion start` を bind したキーを押す
+2. `--scope current`（default）は current pane のみを対象にし、pane がまだ `copy-mode` でなければ先に `copy-mode` に入る
+3. `--scope all` は current window の visible pane 全体を popup に合成して対象にする
+4. 小文字や記号で query を入力する
+5. fuzzy match で候補を絞り込む
+6. 英字 query の場合は Migemo による日本語候補も対象になる
+7. 大文字 hint を押して即座に移動する
+8. `--scope all` で選択した場合は、該当 pane を active にして必要なら `copy-mode` に入ってから移動する
+9. `Esc` または `Ctrl-[` でキャンセルする
 
 ## 入力キー
 
@@ -83,11 +114,18 @@ tmux source-file ~/.tmux.conf
 ## コマンド
 
 ```text
-tmux-fuzzy-motion start <pane-id> <client-tty>
+tmux-fuzzy-motion start [--scope current|all] <pane-id> <client-tty>
+tmux-fuzzy-motion popup-live <pane-id>
 tmux-fuzzy-motion doctor
 ```
 
-`input` は `start` から内部的に使うサブコマンドです。
+`popup` と `daemon` は内部サブコマンドです。`popup-live` は `display-popup`
+から直接起動する設定向けです。
+
+`--scope`:
+
+- `current`: current pane のみを対象にする。default
+- `all`: current window の visible pane 全体を対象にする
 
 ## Doctor
 
@@ -133,9 +171,10 @@ pnpm check
 
 ## 制約
 
-- 対象は現在の viewport のみ
-- `copy-mode` 専用
+- 対象は各 pane の現在の viewport のみ
+- `--scope all` の対象は current window の visible pane のみ
+- zoom 中の `--scope all` は見えている pane のみを対象にする
 - query 入力は ASCII 寄り
 - combining character の完全な扱いは未保証
-- overlay は一時的な tmux pane を swap して表示し、終了時に元へ戻す
-- query は pane 内の最下行右端に描画する
+- `display-popup` が必要なため、tmux 3.2 以上が必須
+- query は popup の最下行右端に描画する

package/README.md

@@ -2,7 +2,7 @@
 
 [日本語版はこちら](./README.ja.md)
 
-`tmux-fuzzy-motion` is a CLI for quick cursor jumps inside `tmux copy-mode`.
+`tmux-fuzzy-motion` is a CLI for quick cursor jumps in tmux panes.
 It scans the current viewport, extracts jump targets, filters them with fuzzy
 search, and lets you jump with uppercase hints. Roman queries can also match
 Japanese text through Migemo.
@@ -10,12 +10,15 @@ Japanese text through Migemo.
 ## Features
 
 - Works inside `tmux copy-mode`
+- `start` can also be launched outside copy-mode and enters copy-mode automatically
+- `start --scope all` can target every visible pane in the current window
 - Extracts URLs, paths, filenames, symbols, and general words from the current viewport
 - Supports fuzzy matching with `fzf`
 - Supports Migemo matching for alphabetic queries via `jsmigemo`
 - Preserves pane colors while drawing the overlay
+- Reuses an external daemon process so matcher and Migemo startup stay warm
 - Uses single-key uppercase hints for fast selection
-- Renders the query inside the target pane and restores the original pane after finishing
+- Opens the UI in a tmux popup instead of creating a persistent scratch window
 
 ## Requirements
 
@@ -51,10 +54,39 @@ npx tmux-fuzzy-motion@latest doctor
 Add these bindings to your `tmux.conf`:
 
 ```tmux
-bind-key -T copy-mode-vi s run-shell -b 'tmux-fuzzy-motion start #{pane_id} #{client_tty}'
-bind-key -T copy-mode s run-shell -b 'tmux-fuzzy-motion start #{pane_id} #{client_tty}'
+bind-key -T copy-mode-vi s run-shell 'tmux-fuzzy-motion start #{pane_id} #{client_tty}'
+bind-key -T copy-mode s run-shell 'tmux-fuzzy-motion start #{pane_id} #{client_tty}'
 ```
 
+If you also want to launch it outside copy-mode, add a binding in the root
+table as well:
+
+```tmux
+bind-key s run-shell 'tmux-fuzzy-motion start #{pane_id} #{client_tty}'
+```
+
+If you want to search across every visible pane in the current window, add a
+binding with `--scope all`.
+
+```tmux
+bind-key S run-shell 'tmux-fuzzy-motion start --scope all #{pane_id} #{client_tty}'
+```
+
+If you want tmux to open the popup directly without going through the `start`
+subcommand, use this instead:
+
+```tmux
+bind-key -T copy-mode-vi s run-shell -C "display-popup -E -B -x '##{popup_pane_left}' -y '##{popup_pane_top}' -w '#{pane_width}' -h '#{pane_height}' 'tmux-fuzzy-motion popup-live #{pane_id}'"
+bind-key -T copy-mode s run-shell -C "display-popup -E -B -x '##{popup_pane_left}' -y '##{popup_pane_top}' -w '#{pane_width}' -h '#{pane_height}' 'tmux-fuzzy-motion popup-live #{pane_id}'"
+```
+
+> [!NOTE]
+> If you see an error like `'tmux-fuzzy-motion start %25 /dev/ttys000' returned 127` at step 2 below, you need to add `tmux-fuzzy-motion` to the PATH in the run-shell environment:
+>
+> ```tmux
+> set-environment -g PATH "/path/to/node/bin:$PATH"
+> ```
+
 Reload tmux after editing the config:
 
 ```bash
@@ -63,13 +95,18 @@ tmux source-file ~/.tmux.conf
 
 ## Usage
 
-1. Enter `copy-mode`.
-2. Press `s`.
-3. Type a query in lowercase or symbols.
-4. Narrow the candidates with fuzzy matching.
-5. For alphabetic queries, Migemo also expands roman input to Japanese matches.
-6. Press an uppercase hint to jump immediately.
-7. Press `Esc` or `Ctrl-[` to cancel.
+1. Press the key bound to `tmux-fuzzy-motion start`.
+2. `--scope current` (the default) targets only the current pane and enters
+   copy-mode first if needed.
+3. `--scope all` targets every visible pane in the current window by composing
+   them into a single popup.
+4. Type a query in lowercase or symbols.
+5. Narrow the candidates with fuzzy matching.
+6. For alphabetic queries, Migemo also expands roman input to Japanese matches.
+7. Press an uppercase hint to jump immediately.
+8. In `--scope all`, the selected pane becomes active and enters copy-mode if
+   needed before the cursor moves.
+9. Press `Esc` or `Ctrl-[` to cancel.
 
 ## Input Keys
 
@@ -83,11 +120,18 @@ tmux source-file ~/.tmux.conf
 ## Commands
 
 ```text
-tmux-fuzzy-motion start <pane-id> <client-tty>
+tmux-fuzzy-motion start [--scope current|all] <pane-id> <client-tty>
+tmux-fuzzy-motion popup-live <pane-id>
 tmux-fuzzy-motion doctor
 ```
 
-`input` is an internal subcommand used by `start`.
+`popup` and `daemon` are internal subcommands. `popup-live` is intended for
+direct `display-popup` bindings.
+
+`--scope`:
+
+- `current`: target only the current pane. This is the default.
+- `all`: target every visible pane in the current window.
 
 ## Doctor
 
@@ -133,9 +177,10 @@ pnpm check
 
 ## Limitations
 
-- Targets are limited to the current viewport
-- Designed for `copy-mode` only
+- Targets are limited to the current viewport of each pane
+- `--scope all` targets only visible panes in the current window
+- Zoomed windows with `--scope all` only target the pane that is visible
 - Query input is ASCII-oriented
 - Exact behavior for combining characters is not fully guaranteed
-- The overlay swaps in a temporary tmux pane and restores the original pane when it exits
-- The query is drawn on the bottom row inside the pane, aligned to the right edge
+- Requires `display-popup`, so tmux 3.2 or later is mandatory
+- The query is drawn on the popup's bottom row, aligned to the right edge