feat: make the hover state for reveal, sort, and hidden commands stable (#2657)

Author: sxyazi

cspell.json

@@ -1 +1 @@
-{"version":"0.2","language":"en","words":["Punct","KEYMAP","splitn","crossterm","YAZI","peekable","ratatui","syntect","pbpaste","pbcopy","oneshot","Posix","Lsar","XADDOS","zoxide","cands","Deque","precache","imageops","IFBLK","IFCHR","IFDIR","IFIFO","IFLNK","IFMT","IFSOCK","IRGRP","IROTH","IRUSR","ISGID","ISUID","ISVTX","IWGRP","IWOTH","IWUSR","IXGRP","IXOTH","IXUSR","libc","winsize","TIOCGWINSZ","xpixel","ypixel","ioerr","appender","Catppuccin","macchiato","gitmodules","Dotfiles","bashprofile","vimrc","flac","webp","exiftool","mediainfo","ripgrep","indexmap","indexmap","unwatch","canonicalize","serde","fsevent","Ueberzug","iterm","wezterm","sixel","chafa","ueberzugpp","Konsole","Überzug","pkgs","pdftoppm","poppler","singlefile","jpegopt","EXIF","rustfmt","mktemp","nanos","xclip","xsel","natord","Mintty","nixos","nixpkgs","SIGTSTP","SIGCONT","SIGCONT","mlua","nonstatic","userdata","metatable","natsort","backstack","luajit","Succ","Succ","cand","fileencoding","foldmethod","lightgreen","darkgray","lightred","lightyellow","lightcyan","nushell","msvc","aarch","linemode","sxyazi","rsplit","ZELLIJ","bitflags","bitflags","USERPROFILE","Neovim","vergen","gitcl","Renderable","preloaders","prec","Upserting","prio","Ghostty","Catmull","Lanczos","cmds","unyank","scrolloff","headsup","unsub","uzers","scopeguard","SPDLOG","globset","filetime","magick","magick","prefetcher","Prework","prefetchers","PREWORKERS","conds","translit","rxvt","Urxvt","realpath","realname","REPARSE","hardlink","hardlinking","nlink","nlink","linemodes","SIGSTOP","sevenzip","rsplitn","replacen","DECSET","DECRQM","repeek","cwds","tcsi","Hyprland","Wayfire","SWAYSOCK","btime","nsec","codegen","gethostname","fchmod","fdfind","Rustc","rustc","ffprobe","vframes","luma","obase","outln","errln","tmtheme","twox","cfgs","fstype","objc","rdev","runloop","exfat","rclone","DECRQSS","DECSCUSR","libvterm","Uninit","lockin","rposition"],"flagWords":[]}
+{"version":"0.2","language":"en","flagWords":[],"words":["Punct","KEYMAP","splitn","crossterm","YAZI","peekable","ratatui","syntect","pbpaste","pbcopy","oneshot","Posix","Lsar","XADDOS","zoxide","cands","Deque","precache","imageops","IFBLK","IFCHR","IFDIR","IFIFO","IFLNK","IFMT","IFSOCK","IRGRP","IROTH","IRUSR","ISGID","ISUID","ISVTX","IWGRP","IWOTH","IWUSR","IXGRP","IXOTH","IXUSR","libc","winsize","TIOCGWINSZ","xpixel","ypixel","ioerr","appender","Catppuccin","macchiato","gitmodules","Dotfiles","bashprofile","vimrc","flac","webp","exiftool","mediainfo","ripgrep","indexmap","indexmap","unwatch","canonicalize","serde","fsevent","Ueberzug","iterm","wezterm","sixel","chafa","ueberzugpp","Konsole","Überzug","pkgs","pdftoppm","poppler","singlefile","jpegopt","EXIF","rustfmt","mktemp","nanos","xclip","xsel","natord","Mintty","nixos","nixpkgs","SIGTSTP","SIGCONT","SIGCONT","mlua","nonstatic","userdata","metatable","natsort","backstack","luajit","Succ","Succ","cand","fileencoding","foldmethod","lightgreen","darkgray","lightred","lightyellow","lightcyan","nushell","msvc","aarch","linemode","sxyazi","rsplit","ZELLIJ","bitflags","bitflags","USERPROFILE","Neovim","vergen","gitcl","Renderable","preloaders","prec","Upserting","prio","Ghostty","Catmull","Lanczos","cmds","unyank","scrolloff","headsup","unsub","uzers","scopeguard","SPDLOG","globset","filetime","magick","magick","prefetcher","Prework","prefetchers","PREWORKERS","conds","translit","rxvt","Urxvt","realpath","realname","REPARSE","hardlink","hardlinking","nlink","nlink","linemodes","SIGSTOP","sevenzip","rsplitn","replacen","DECSET","DECRQM","repeek","cwds","tcsi","Hyprland","Wayfire","SWAYSOCK","btime","nsec","codegen","gethostname","fchmod","fdfind","Rustc","rustc","ffprobe","vframes","luma","obase","outln","errln","tmtheme","twox","cfgs","fstype","objc","rdev","runloop","exfat","rclone","DECRQSS","DECSCUSR","libvterm","Uninit","lockin","rposition","resvg"]}

yazi-boot/src/actions/debug.rs

@@ -93,6 +93,7 @@ impl Actions {
 		writeln!(s, "    zoxide        : {}", Self::process_output("zoxide", "--version"))?;
 		#[rustfmt::skip]
 		writeln!(s, "    7zz/7z        : {} / {}", Self::process_output("7zz", "i"), Self::process_output("7z", "i"))?;
+		writeln!(s, "    resvg         : {}", Self::process_output("resvg", "--version"))?;
 		writeln!(s, "    jq            : {}", Self::process_output("jq", "--version"))?;
 
 		writeln!(s, "\nClipboard")?;

yazi-core/src/mgr/commands/hover.rs

@@ -3,7 +3,6 @@ yazi_macro::mod_flat!(
 	close
 	create
 	hardlink
-	hover
 	link
 	open
 	paste

yazi-core/src/mgr/commands/mod.rs

@@ -21,8 +21,8 @@ impl Mgr {
 			self.watcher.trigger_dirs(&[self.current()]);
 		}
 
-		self.watch(());
 		self.peek(false);
+		self.watch(());
 		self.update_paged((), tasks);
 
 		tasks.prework_sorted(&self.current().files);

yazi-core/src/mgr/commands/refresh.rs

@@ -30,10 +30,12 @@ impl Mgr {
 		}
 
 		render!(self.yanked.catchup_revision(false));
+		self.active_mut().apply_files_attrs();
+
 		if revision != self.current().files.revision {
-			self.active_mut().apply_files_attrs();
-			self.hover(None);
+			self.active_mut().hover(None);
 			self.peek(false);
+			self.watch(());
 			self.update_paged((), tasks);
 		}
 	}

yazi-core/src/mgr/commands/update_files.rs

@@ -36,8 +36,10 @@ impl Tab {
 			}
 		}
 
-		MgrProxy::hover(None, self.id);
+		self.hover(None);
 		MgrProxy::peek(false);
+		MgrProxy::watch();
+
 		render!();
 	}
 }

yazi-core/src/tab/commands/arrow.rs

@@ -27,8 +27,9 @@ impl Tab {
 
 		self.current.repos(hovered.as_ref());
 		if self.hovered().map(|f| f.urn()) != hovered.as_ref().map(|u| u.as_urn()) {
-			MgrProxy::hover(None, self.id);
+			self.hover(None);
 			MgrProxy::peek(false);
+			MgrProxy::watch();
 		}
 
 		render!();

yazi-core/src/tab/commands/filter_do.rs

@@ -15,8 +15,9 @@ impl Tab {
 		self.apply_files_attrs();
 
 		if hovered.as_ref() != self.hovered().map(|f| &f.url) {
-			MgrProxy::hover(hovered, self.id);
+			self.hover(hovered);
 			MgrProxy::peek(false);
+			MgrProxy::watch();
 		} else if self.hovered().is_some_and(|f| f.is_dir()) {
 			MgrProxy::peek(true);
 		}

yazi-core/src/tab/commands/hidden.rs

@@ -0,0 +1,44 @@
+use yazi_dds::Pubsub;
+use yazi_macro::render;
+use yazi_shared::{event::CmdCow, url::{Url, Urn}};
+
+use crate::tab::Tab;
+
+struct Opt {
+	url: Option<Url>,
+}
+
+impl From<CmdCow> for Opt {
+	fn from(mut c: CmdCow) -> Self { Self { url: c.take_first_url() } }
+}
+impl From<Option<Url>> for Opt {
+	fn from(url: Option<Url>) -> Self { Self { url } }
+}
+
+impl Tab {
+	#[yazi_codegen::command]
+	pub fn hover(&mut self, opt: Opt) {
+		if let Some(u) = opt.url {
+			self.hover_do(u);
+		} else {
+			self.current.arrow(0);
+		}
+
+		// Publish through DDS
+		Pubsub::pub_from_hover(self.id, self.hovered().map(|h| &h.url));
+	}
+
+	fn hover_do(&mut self, url: Url) {
+		// Hover on the file
+		if let Ok(p) = url.strip_prefix(self.cwd()) {
+			render!(self.current.hover(Urn::new(p)));
+		}
+
+		// Turn on tracing
+		if self.hovered().is_some_and(|h| h.url == url) {
+			// `hover(Some)` occurs after user actions, such as create, rename, reveal, etc.
+			// At this point, it's intuitive to track the location of the file regardless.
+			self.current.trace = Some(url.urn_owned());
+		}
+	}
+}