feat: ya.hide() plugin API (#792)

cspell.json

@@ -1 +1 @@
-{"language":"en","flagWords":[],"version":"0.2","words":["Punct","KEYMAP","splitn","crossterm","YAZI","unar","peekable","ratatui","syntect","pbpaste","pbcopy","ffmpegthumbnailer","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","nvim","indexmap","indexmap","unwatch","canonicalize","serde","fsevent","Ueberzug","iterm","wezterm","sixel","chafa","ueberzugpp","️ Überzug","️ Überzug","Konsole","Alacritty","Überzug","pkgs","paru","unarchiver","pdftoppm","poppler","prebuild","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","imagesize","Upserting","prio","Ghostty","Catmull","Lanczos","cmds","unyank","scrolloff"]}
+{"version":"0.2","flagWords":[],"language":"en","words":["Punct","KEYMAP","splitn","crossterm","YAZI","unar","peekable","ratatui","syntect","pbpaste","pbcopy","ffmpegthumbnailer","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","nvim","indexmap","indexmap","unwatch","canonicalize","serde","fsevent","Ueberzug","iterm","wezterm","sixel","chafa","ueberzugpp","️ Überzug","️ Überzug","Konsole","Alacritty","Überzug","pkgs","paru","unarchiver","pdftoppm","poppler","prebuild","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","imagesize","Upserting","prio","Ghostty","Catmull","Lanczos","cmds","unyank","scrolloff","headsup"]}

yazi-adaptor/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yazi-adaptor"
-version = "0.2.3"
+version = "0.2.4"
 edition = "2021"
 license = "MIT"
 authors = [ "sxyazi <[email protected]>" ]
@@ -9,8 +9,8 @@ homepage = "https://yazi-rs.github.io"
 repository = "https://github.com/sxyazi/yazi"
 
 [dependencies]
-yazi-config = { path = "../yazi-config", version = "0.2.3" }
-yazi-shared = { path = "../yazi-shared", version = "0.2.3" }
+yazi-config = { path = "../yazi-config", version = "0.2.4" }
+yazi-shared = { path = "../yazi-shared", version = "0.2.4" }
 
 # External dependencies
 anyhow = "^1"

yazi-boot/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yazi-boot"
-version = "0.2.3"
+version = "0.2.4"
 edition = "2021"
 license = "MIT"
 authors = [ "sxyazi <[email protected]>" ]
@@ -9,8 +9,8 @@ homepage = "https://yazi-rs.github.io"
 repository = "https://github.com/sxyazi/yazi"
 
 [dependencies]
-yazi-config = { path = "../yazi-config", version = "0.2.3" }
-yazi-shared = { path = "../yazi-shared", version = "0.2.3" }
+yazi-config = { path = "../yazi-config", version = "0.2.4" }
+yazi-shared = { path = "../yazi-shared", version = "0.2.4" }
 
 # External dependencies
 clap = { version = "^4", features = [ "derive" ] }

yazi-config/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yazi-config"
-version = "0.2.3"
+version = "0.2.4"
 edition = "2021"
 license = "MIT"
 authors = [ "sxyazi <[email protected]>" ]
@@ -9,7 +9,7 @@ homepage = "https://yazi-rs.github.io"
 repository = "https://github.com/sxyazi/yazi"
 
 [dependencies]
-yazi-shared = { path = "../yazi-shared", version = "0.2.3" }
+yazi-shared = { path = "../yazi-shared", version = "0.2.4" }
 
 # External dependencies
 anyhow = "^1"

yazi-config/preset/yazi.toml

@@ -192,3 +192,5 @@ sort_reverse = false
 
 [log]
 enabled = false
+
+[headsup]

yazi-config/src/headsup/headsup.rs

@@ -0,0 +1,34 @@
+use serde::{Deserialize, Deserializer};
+
+use crate::MERGED_YAZI;
+
+#[derive(Debug)]
+pub struct Headsup {
+ // TODO: remove this once Yazi 0.3 is released --
+ pub disable_exec_warn: bool,
+}
+
+impl Default for Headsup {
+ fn default() -> Self { toml::from_str(&MERGED_YAZI).unwrap() }
+}
+
+impl<'de> Deserialize<'de> for Headsup {
+ fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+ where
+ D: Deserializer<'de>,
+ {
+ #[derive(Deserialize)]
+ struct Outer {
+ headsup: Shadow,
+ }
+ #[derive(Deserialize)]
+ struct Shadow {
+ #[serde(default)]
+ disable_exec_warn: bool,
+ }
+
+ let outer = Outer::deserialize(deserializer)?;
+
+ Ok(Self { disable_exec_warn: outer.headsup.disable_exec_warn })
+ }
+}

yazi-config/src/headsup/mod.rs

@@ -0,0 +1,3 @@
+mod headsup;
+
+pub use headsup::*;

yazi-config/src/keymap/control.rs

@@ -1,9 +1,10 @@
-use std::{borrow::Cow, collections::VecDeque};
+use std::{borrow::Cow, collections::VecDeque, sync::atomic::Ordering};
 
 use serde::{Deserialize, Deserializer};
 use yazi_shared::event::Cmd;
 
 use super::Key;
+use crate::DEPRECATED_EXEC;
 
 #[derive(Debug, Default)]
 pub struct Control {
@@ -61,6 +62,9 @@ impl<'de> Deserialize<'de> for Control {
  #[derive(Deserialize)]
  struct VecCmd(#[serde(deserialize_with = "super::run_deserialize")] Vec<Cmd>);
 
+ if shadow.exec.is_some() {
+ DEPRECATED_EXEC.store(true, Ordering::Relaxed);
+ }
  let Some(run) = shadow.run.or(shadow.exec) else {
  return Err(serde::de::Error::custom("missing field `run` within `[keymap]`"));
  };

yazi-config/src/lib.rs

@@ -2,6 +2,7 @@
 
 use yazi_shared::{RoCell, Xdg};
 
+pub mod headsup;
 pub mod keymap;
 mod layout;
 mod log;
@@ -23,12 +24,17 @@ pub(crate) use pattern::*;
 pub(crate) use preset::*;
 pub use priority::*;
 
+// TODO: remove this once Yazi 0.3 is released --
+pub static DEPRECATED_EXEC: std::sync::atomic::AtomicBool =
+ std::sync::atomic::AtomicBool::new(false);
+
 static MERGED_YAZI: RoCell<String> = RoCell::new();
 static MERGED_KEYMAP: RoCell<String> = RoCell::new();
 static MERGED_THEME: RoCell<String> = RoCell::new();
 
 pub static LAYOUT: RoCell<arc_swap::ArcSwap<Layout>> = RoCell::new();
 
+pub static HEADSUP: RoCell<headsup::Headsup> = RoCell::new();
 pub static KEYMAP: RoCell<keymap::Keymap> = RoCell::new();
 pub static LOG: RoCell<log::Log> = RoCell::new();
 pub static MANAGER: RoCell<manager::Manager> = RoCell::new();
@@ -49,6 +55,7 @@ pub fn init() {
 
  LAYOUT.with(Default::default);
 
+ HEADSUP.with(Default::default);
  KEYMAP.with(Default::default);
  LOG.with(Default::default);
  MANAGER.with(Default::default);
@@ -60,4 +67,18 @@ pub fn init() {
  INPUT.with(Default::default);
  SELECT.with(Default::default);
  WHICH.with(Default::default);
+
+ // TODO: remove this once Yazi 0.3 is released --
+ if !HEADSUP.disable_exec_warn && DEPRECATED_EXEC.load(std::sync::atomic::Ordering::Relaxed) {
+ println!(
+ r#"
+WARNING: `exec` will be deprecated in the next major version v0.3 and replaced by `run`.
+
+Please replace all `exec = ...` with `run = ...`, in your `yazi.toml` and `keymap.toml`.
+
+---
+Add `disable_exec_warn = true` to your `yazi.toml` under `[headsup]` to suppress this warning.
+"#
+ );
+ }
 }

yazi-config/src/open/opener.rs

@@ -1,5 +1,9 @@
+use std::sync::atomic::Ordering;
+
 use serde::{Deserialize, Deserializer};
 
+use crate::DEPRECATED_EXEC;
+
 #[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct Opener {
  pub run: String,
@@ -47,6 +51,9 @@ impl<'de> Deserialize<'de> for Opener {
  let shadow = Shadow::deserialize(deserializer)?;
 
  // TODO: remove this once Yazi 0.3 is released --
+ if shadow.exec.is_some() {
+ DEPRECATED_EXEC.store(true, Ordering::Relaxed);
+ }
  let run = shadow.run.or(shadow.exec).unwrap_or_default();
  // TODO: -- remove this once Yazi 0.3 is released
 

yazi-config/src/plugin/rule.rs

@@ -1,7 +1,9 @@
+use std::sync::atomic::Ordering;
+
 use serde::{Deserialize, Deserializer};
 use yazi_shared::{event::Cmd, Condition};
 
-use crate::{Pattern, Priority};
+use crate::{Pattern, Priority, DEPRECATED_EXEC};
 
 pub struct PluginRule {
  pub id: u8,
@@ -50,6 +52,9 @@ impl<'de> Deserialize<'de> for PluginRule {
  #[derive(Deserialize)]
  struct WrappedCmd(#[serde(deserialize_with = "super::run_deserialize")] Cmd);
 
+ if shadow.exec.is_some() {
+ DEPRECATED_EXEC.store(true, Ordering::Relaxed);
+ }
  let Some(run) = shadow.run.or(shadow.exec) else {
  return Err(serde::de::Error::custom("missing field `run` within `[plugin]`"));
  };

yazi-core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yazi-core"
-version = "0.2.3"
+version = "0.2.4"
 edition = "2021"
 license = "MIT"
 authors = [ "sxyazi <[email protected]>" ]
@@ -9,13 +9,13 @@ homepage = "https://yazi-rs.github.io"
 repository = "https://github.com/sxyazi/yazi"
 
 [dependencies]
-yazi-adaptor = { path = "../yazi-adaptor", version = "0.2.3" }
-yazi-boot = { path = "../yazi-boot", version = "0.2.3" }
-yazi-config = { path = "../yazi-config", version = "0.2.3" }
-yazi-plugin = { path = "../yazi-plugin", version = "0.2.3" }
-yazi-proxy = { path = "../yazi-proxy", version = "0.2.3" }
-yazi-scheduler = { path = "../yazi-scheduler", version = "0.2.3" }
-yazi-shared = { path = "../yazi-shared", version = "0.2.3" }
+yazi-adaptor = { path = "../yazi-adaptor", version = "0.2.4" }
+yazi-boot = { path = "../yazi-boot", version = "0.2.4" }
+yazi-config = { path = "../yazi-config", version = "0.2.4" }
+yazi-plugin = { path = "../yazi-plugin", version = "0.2.4" }
+yazi-proxy = { path = "../yazi-proxy", version = "0.2.4" }
+yazi-scheduler = { path = "../yazi-scheduler", version = "0.2.4" }
+yazi-shared = { path = "../yazi-shared", version = "0.2.4" }
 
 # External dependencies
 anyhow = "^1"