From 1ede8bd35314d85021db0ca98f23dd4ea44eb9fa Mon Sep 17 00:00:00 2001 From: Jackson Moore Date: Thu, 17 Sep 2026 19:36:37 +0200 Subject: Add README --- yazi-enter.yazi/README.txt | 109 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 yazi-enter.yazi/README.txt (limited to 'yazi-enter.yazi/README.txt') diff --git a/yazi-enter.yazi/README.txt b/yazi-enter.yazi/README.txt new file mode 100644 index 0000000..6454872 --- /dev/null +++ b/yazi-enter.yazi/README.txt @@ -0,0 +1,109 @@ +YAZI-ENTER + +Find an entry in the current Yazi view and activate the Hovered match. +Matching, cursor movement, directory entry, and file opening use Yazi's +built-in actions. + +REQUIREMENTS + +- Yazi 26.9.1. +- Yazi's bundled Lua runtime. + +The runtime contract is verified against Yazi 26.9.1. Review compatibility +before using a later Yazi release. Find behavior runs entirely through Yazi's +native finder. + +INSTALLATION + +Copy this directory with its name unchanged into the plugins directory of the +active Yazi configuration: + +Unix-like systems: + + ~/.config/yazi/plugins/yazi-enter.yazi/main.lua + +Windows: + + %AppData%\yazi\config\plugins\yazi-enter.yazi\main.lua + +When YAZI_CONFIG_HOME is set, use its plugins directory. The installed entry +file must be named main.lua. The plugin uses keymap actions as its full setup. + +KEYMAP SETUP + +Add one or more bindings to keymap.toml in the active Yazi configuration. This +example gives the plugin priority on Yazi's standard forward and backward find +keys and activates either entry type: + + [[mgr.prepend_keymap]] + on = "/" + run = "plugin yazi-enter -- either --smart" + desc = "Find next and activate" + + [[mgr.prepend_keymap]] + on = "?" + run = "plugin yazi-enter -- either --previous --smart" + desc = "Find previous and activate" + +Use one TOML keymap form consistently. If the file already has an +[mgr] prepend_keymap array, add equivalent mapping objects to that array. +Restart Yazi after changing the plugin or keymap files. + +Choose any keys and any of these actions: + +Forward search: + + plugin yazi-enter -- directory --smart + plugin yazi-enter -- file --smart + plugin yazi-enter -- either --smart + +Backward search: + + plugin yazi-enter -- directory --previous --smart + plugin yazi-enter -- file --previous --smart + plugin yazi-enter -- either --previous --smart + +MODES + +- directory: Enter the Hovered match when it is a directory. +- file: Open the Hovered match when it is a file entry. +- either: Enter a directory or open a file entry according to its type. + +The native finder searches every entry type in each mode. The mode controls +the action after submission. A type mismatch produces a zero-action result. +File opening targets only the Hovered match and uses the current Yazi opener +rules. Persistent selections stay separate from that target. + +OPTIONS + +- --previous searches in current-then-backward order and wraps. +- --smart uses smart case: lowercase patterns are case-insensitive, and a + pattern with an uppercase character is case-sensitive. +- --insensitive uses case-insensitive matching when --smart is disabled. + +Matching is case-sensitive when both case options are disabled. Smart case has +priority when both case options are enabled. Bare options enable their value. +The values true, false, yes, and no are also accepted. + +USAGE + +Open a configured binding, enter a query, and use the configured input submit +key. The default submit key is Enter. The default cancel keys are Esc and +Ctrl-c. The prompt uses the active Yazi input theme, input keymap, and shared +input history. + +Queries are unanchored Rust regular expressions. Plain text normally acts as a +substring query. Escape regular-expression characters when they must be +literal. During typing, a malformed expression can be corrected in the same +prompt. + +A successful query moves the cursor with Yazi's native find behavior. Submit +applies the complete final query before activation. An empty query, a query +with zero matches, a malformed submitted expression, or a mode/type mismatch +produces a zero-action result. Cancel keeps the latest successful finder state. +Yazi's find_arrow bindings, normally n and N, can continue through that finder +state. + +Directory activation uses Yazi's enter action. File activation uses Yazi's +hovered-only open action, including chooser mode, MIME handling, opener rules, +and task handling. -- cgit v1.2.3