feat: improve path auto-completion results #2765
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR implements an improved path auto-completion feature by refactoring the completion logic to use a new candidate type (CmpItem) and by enhancing path comparison utility functions. Key changes include:
- Refactoring the complete command in yazi-widgets and related modules to use CmpItem.
- Introducing new helper functions in yazi-shared for comparing OsStr values.
- Updating dependency definitions and module registrations to support the new completion API.
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| yazi-widgets/src/input/commands/complete.rs | Refactored command to use CmpItem and a TryInto conversion pattern. |
| yazi-widgets/Cargo.toml | Added yazi-proxy dependency required by the new completion logic. |
| yazi-shared/src/chars.rs | Added utility functions for OsStr comparisons. |
| yazi-proxy/src/options/cmp.rs | Introduced the new CmpItem struct for candidate handling. |
| yazi-proxy/src/input.rs | Updated completion function to work with CmpItem. |
| yazi-fm/src/main.rs | Contains commented-out debugging code that could be cleaned up. |
| yazi-fm/src/cmp/cmp.rs | Updated candidate display logic to use CmpItem's attributes. |
| yazi-core/src/cmp/commands/trigger.rs | Adapted directory reading and candidate sorting to use CmpItem. |
| yazi-core/src/cmp/commands/show.rs | Modified candidate matching to operate on CmpItem rather than strings. |
| yazi-core/src/cmp/cmp.rs | Updated caches and candidate list to store CmpItem instances. |
tmeijn
pushed a commit
to tmeijn/dotfiles
that referenced
this pull request
Jun 12, 2025
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [sxyazi/yazi](https://github.com/sxyazi/yazi) | minor | `v25.4.8` -> `v25.5.31` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>sxyazi/yazi (sxyazi/yazi)</summary> ### [`v25.5.31`](https://github.com/sxyazi/yazi/releases/tag/v25.5.31) [Compare Source](sxyazi/yazi@v25.5.28...v25.5.31) This is a maintenance release, focusing on bug fixes. #### What's Changed - fix: expose `ui.Wrap` by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2810 - fix: `forward --end-of-word` of the input should consider the mode's delta by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2811 - fix: make every effort to carry hidden states for dummy files by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2814 **Full Changelog**: sxyazi/yazi@v25.5.28...v25.5.31 ### [`v25.5.28`](https://github.com/sxyazi/yazi/releases/tag/v25.5.28) [Compare Source](sxyazi/yazi@v25.4.8...v25.5.28) #### Breaking Changes - `[manager]` is deprecated in favor of the new `[mgr]`. sxyazi/yazi#2803 - `tab_width` has been removed as it no longer needs to be set manually. sxyazi/yazi#2745 - `tab_active` and `tab_inactive` are moved under the new `[tabs]` section. sxyazi/yazi#2745 - `sixel_fraction` has been removed as it's no longer needed. sxyazi/yazi#2707 #### Deprecated - `ya.mgr_emit()`, `ya.app_emit()` and `ya.input_emit()` are deprecated. sxyazi/yazi#2653 - `ya.preview_widgets()` is deprecated. sxyazi/yazi#2706 - `Command:args()` is deprecated. sxyazi/yazi#2752 - The `ya pack` subcommand is deprecated. sxyazi/yazi#2770 - `LEFT`, `CENTER`, `RIGHT` on `ui.Line`, `ui.Text` are deprecated. sxyazi/yazi#2802 - `NONE`, `TOP`, `RIGHT`, `BOTTOM`, `LEFT`, `ALL` on `ui.Bar`, `ui.Border` are deprecated. sxyazi/yazi#2802 - `WRAP_NO`, `WRAP`, `WRAP_TRIM` on `ui.Text` are deprecated. sxyazi/yazi#2802 #### Redesign Tabs sxyazi/yazi#2745 decouples tabs from the header into an independent tab bar component to enhance UX: - A standalone single-line component increases the available space for displaying tabs. - Tab titles are displayed by default to increase recognizability. - Supports switching tabs via mouse for easier navigation. The new tab bar is only shown when there is more than one tab, ensuring no space is wasted for users who don't use tabs. https://github.com/user-attachments/assets/5ca33561-7558-4b9c-8b6a-9dfbc0bc8aa4 #### Calculate Real-Time Directory Size in Spotter sxyazi/yazi#2695 adds directory sizes to the `folder` spotter. The size is computed dynamically in real time and asynchronously, which means: - Every time a user clicks `<Tab>` on a directory, the latest size is calculated. - For large directories, real-time changes in size are reported to the user, with "(?)" appended at the end to indicate that the calculation is in progress. - If the user closes the spotter or switches directories using the left/right arrow keys, any ongoing calculations will be canceled to avoid wasting resources. Also, the computed directory size will be updated in the file list: - If the user sets `linemode = size`, the latest size will be shown on the right of the file line. - If the user sets `sort_by = size`, the file list will be sorted by the latest sizes (if necessary). https://github.com/user-attachments/assets/eb2981e6-3e02-4997-abfc-83cc456a1677 #### 9x Faster Sixel Image Preview sxyazi/yazi#2707 replaces the existing neural network quantization algorithm with Wu's Color Quantizer, which offers [better performance](https://github.com/Ivordir/quantette/blob/main/docs/Benchmarks%20and%20Accuracy.md#time) while [maintaining comparable quality](https://github.com/Ivordir/quantette/blob/main/docs/Benchmarks%20and%20Accuracy.md#accuracydssim). Old implementation (neural network via [`color_quant`](https://github.com/image-rs/color_quant), with default `sixel_fraction = 20`) – average 189.5763999ms: ```sh time: 190.025ms time: 191.054417ms time: 187.696792ms time: 188.060791ms time: 189.381958ms time: 191.618042ms time: 192.383125ms time: 190.511291ms time: 187.8395ms time: 187.193083ms ``` New implementation (Wu - sRGB via [`quantette`](https://github.com/Ivordir/quantette)) – average 20.9199916ms: ```sh time: 21.226458ms time: 20.719542ms time: 21.207583ms time: 20.815875ms time: 21.071291ms time: 21.273459ms time: 20.811792ms time: 20.723166ms time: 20.52675ms time: 20.824ms ``` #### [`piper.yazi` Plugin](https://github.com/yazi-rs/plugins/tree/main/piper.yazi) With [`piper.yazi`](https://github.com/yazi-rs/plugins/tree/main/piper.yazi), you can use the output of any shell command as preview content. This eliminates the need to write a separate plugin for each command, making the use of custom previewers much more convenient.  See https://github.com/yazi-rs/plugins/tree/main/piper.yazi#examples for more examples! #### Double Directory Size Calculation Speed sxyazi/yazi#2683 greatly improves directory computation performance by dividing the task into chunks and reusing existing threads. Directory sorting and file trashing will be observably twice as fast. Run the benchmark script against a 10.16GB folder 5 times in release mode: ```sh Old: elapsed 759.877791ms New: elapsed 364.802583ms Old: elapsed 734.5155ms New: elapsed 360.103375ms Old: elapsed 734.124167ms New: elapsed 365.662458ms Old: elapsed 733.27325ms New: elapsed 365.694042ms Old: elapsed 743.394875ms New: elapsed 364.455083ms ``` #### Input Component Now Supports Password Mode With sxyazi/yazi#2675, a new `obscure = true` option is available: ```lua local value = ya.input { title = "Password:", obscure = true, position = { "center", w = 50 }, } ``` https://github.com/user-attachments/assets/ff5b21f2-977b-4e9f-a279-e4cb15b51a57 #### Truncate Long Items in the File List sxyazi/yazi#2754, sxyazi/yazi#2759, and sxyazi/yazi#2778 add truncation support for long filenames in the file list and archive preview, and display file extensions at the end, ensuring that even if a filename is truncated, you can still know what file type it is by its extension. https://github.com/user-attachments/assets/0f1afbdb-17ec-410f-adea-e8b1d2ed6341 #### [`types.yazi` Plugin](https://github.com/yazi-rs/plugins/tree/main/types.yazi) For a long time, Yazi lacked a type definition file, which made plugin development very painful. Now, it's here! [`types.yazi`](https://github.com/yazi-rs/plugins/tree/main/types.yazi) provides type definitions for Yazi's Lua API, empowering an efficient plugin development experience. #### Improved Built-In Previewers - The `video` previewer now supports displaying embedded video covers, sxyazi/yazi#2640 - The `magick` previewer will respect the user's `image_alloc` and `image_bound` settings, to limit its maximum resource usage, sxyazi/yazi#2602, thanks to [@​ze0987](https://github.com/ze0987) - The `video` previewer will respect the user's `max_width` setting, sxyazi/yazi#2560, thanks to [@​ze0987](https://github.com/ze0987) #### Improve Path Auto-Completion Results The auto-completion results for interactive cd (key: `g` => `<Space>`) will now more closely match the user's input keywords. Done in sxyazi/yazi#2765 #### What's Changed - fix: reverse the mixing order of theme and flavor configuration by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2594 - feat: limit memory usage for previewing large images by [@​ze0987](https://github.com/ze0987) in sxyazi/yazi#2602 - fix: respect the user's `max_width` setting for the built-in video previewer by [@​ze0987](https://github.com/ze0987) in sxyazi/yazi#2560 - feat: allow custom exit code with `quit --code` by [@​Nicholas42](https://github.com/Nicholas42) in sxyazi/yazi#2609 - fix: ensure state synchronization even when the package update fails midway by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2613 - fix: do not change revision when package deployment fails by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2627 - feat: copy-on-write support for field caching by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2629 - feat: fall back to `CSI 16 t` when PowerShell OpenSSH returns a fake terminal size by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2636 - feat: support embedded cover for video preview by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2640 - fix: lazily update files to avoid triggering issues dependent on sort order by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2643 - feat: new `ya.emit()` API by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2653 - feat: fine-grained `peek` and `watch` by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2655 - feat: new `--no-dummy` option for `reveal` command by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2664 - feat: obscure input component for inputting passwords by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2675 - feat: increase the maximum allowed value of `sixel_fraction` to `30` by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2682 - perf: double directory size calculation speed by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2683 - feat: new `fs.calc_size()` API by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2691 - feat: promote `Id` to a first-class type by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2692 - feat: calculate real-time directory size in spotter by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2695 - feat: checks in `ya pub` and `ya emit` subcommands to verify receiver exists and has necessary abilities by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2696 - feat: add `s` and `S` keybinds in the input component by [@​hankertrix](https://github.com/hankertrix) in sxyazi/yazi#2678 - fix: no title is set when starts the first time by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2700 - refactor: move `tty` to the new `yazi-term` crate by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2701 - feat: show error when image preview fails by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2706 - feat!: 9x faster Sixel image preview by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2707 - fix: reset the cursor position with `arrow()` after deleting files by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2708 - fix: `ya pub-to 0` checks if any peer is able to receive the message by [@​mikavilpas](https://github.com/mikavilpas) in sxyazi/yazi#2697 - feat: add `--hovered` to the `copy` command by [@​hankertrix](https://github.com/hankertrix) in sxyazi/yazi#2709 - fix: missing a `hover` event after `cd` by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2719 - fix: detach background and orphan processes from the controlling terminal with `setsid()` by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2723 - fix: avoid tmux interfering with kitty graphical sequences by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2734 - fix: `windows-sys` missing a `Win32_Security` feature by [@​Kreijstal](https://github.com/Kreijstal) in sxyazi/yazi#2728 - feat: make `ui.Line` renderable by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2743 - feat!: redesign tabs by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2745 - refactor: deprecate the `Command:args()` method by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2752 - perf: avoid unnecessary memory allocation in `ya.truncate()` by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2753 - fix: icon rules mixing by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2755 - feat: show file extension for truncated file list items by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2759 - perf: remove intermediate variables in natural sorting algorithm to avoid unnecessary allocation by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2764 - feat: improve path auto-completion results by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2765 - fix: always try to create state directory before draining DDS data by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2769 - feat: truncate long paths in archive preview file list by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2778 - feat: add a `/` to the interactive cd auto-completion candidates by [@​ineu](https://github.com/ineu) in sxyazi/yazi#2777 - feat: make custom tab bar easier by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2782 - fix: update `rust-onig` to v6.5.1 for GCC 15 compatibility by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2794 - feat: new `ui.Align`, `ui.Wrap`, and `ui.Edge` by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2802 - refactor!: deprecate `[manager]` in favor of `[mgr]` by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2803 - chore: bump version to 25.5.28 by [@​sxyazi](https://github.com/sxyazi) in sxyazi/yazi#2804 #### New Contributors - [@​Nicholas42](https://github.com/Nicholas42) made their first contribution in sxyazi/yazi#2609 - [@​Kreijstal](https://github.com/Kreijstal) made their first contribution in sxyazi/yazi#2728 - [@​ineu](https://github.com/ineu) made their first contribution in sxyazi/yazi#2777 **Full Changelog**: sxyazi/yazi@v25.4.8...v25.5.28 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MC41MC4wIiwidXBkYXRlZEluVmVyIjoiNDAuNTAuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90Il19-->
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An implementation of the feature request: #2763
Closes #2763