Skip to main content

Module hints

Module hints 

Source
Expand description

Single source of truth for the modal status-bar / overlay key hints (issue #39). Each modal mode declares its keys exactly once here; view renders both the bottom status bar and the in-overlay hint rows from these tables, and the consistency test below drives every hinted key through the real handler — so a hint can never claim a key the handler ignores, nor drift from it during a refactor.

The rebindable List-mode shortcuts are deliberately NOT here: they derive straight from the Keymap plus KeyAction::label, which is their own single source of truth.

Structs§

Hint
One status-bar / overlay hint: the on-screen key text and what it does.

Functions§

checkout_hints
Checkout branch-picker hints.
compose_ai_hints
PR-compose AI auto-fill controls (the first overlay hint row).
compose_edit_hints
PR-compose editing controls (the second overlay hint row, and the status bar). Enter advances the field (or inserts a newline in the body).
confirm_create_hints
Confirm-create dialog hints: y creates a worktree for the branch row and switches into it; any other key cancels (issue #47).
confirm_delete_branch_hints
Confirm-delete-branch dialog hints: y deletes the branch row’s local branch; any other key cancels (issue #53).
confirm_hints
Confirm-remove dialog hints (any non-y key cancels; Esc is the prompt).
confirm_init_submodules_hints
Confirm-init-submodules dialog hints (issue #50): Enter/y (the default) initializes recursively, n/Esc leaves them uninitialized.
confirm_quit_hints
Confirm-quit dialog hints (issue #46 overhaul): y quits and abandons the running background jobs, any other key cancels.
confirm_stale_base_hints
Confirm-stale-base dialog hints (issue #56): u updates the base, p proceeds off it as-is, any other key cancels.
create_hints
Create-worktree prompt hints.
filter_hints
Filter-mode hints (typing narrows the list; ↑/↓ move within it).
format_hint_row
Formats a hint slice into an overlay row, e.g. ↑/↓: options Enter: next / submit Esc: cancel.
help_hints
Help-overlay hints.
pr_picker_hints
PR-picker hints.