feat: add a next property to the preloader rules to allow running multiple preloaders (#1058)

Author: sxyazi

Diff for: Cargo.lock

@@ -13,7 +13,7 @@ yazi-config = { path = "../yazi-config", version = "0.2.5" }
 yazi-shared = { path = "../yazi-shared", version = "0.2.5" }
 
 # External dependencies
-anyhow       = "1.0.83"
+anyhow       = "1.0.86"
 arc-swap     = "1.7.1"
 base64       = "0.22.1"
 color_quant  = "1.1.0"

Diff for: flake.lock

@@ -13,7 +13,7 @@ yazi-dds    = { path = "../yazi-dds", version = "0.2.5" }
 yazi-shared = { path = "../yazi-shared", version = "0.2.5" }
 
 # External dependencies
-anyhow     = "1.0.83"
+anyhow     = "1.0.86"
 clap       = { version = "4.5.4", features = [ "derive" ] }
 crossterm  = "0.27.0"
 md-5       = "0.10.6"
@@ -22,7 +22,7 @@ tokio      = { version = "1.37.0", features = [ "full" ] }
 toml_edit  = "0.22.13"
 
 [build-dependencies]
-anyhow                = "1.0.83"
+anyhow                = "1.0.86"
 clap                  = { version = "4.5.4", features = [ "derive" ] }
 clap_complete         = "4.5.2"
 clap_complete_fig     = "4.5.0"

Diff for: yazi-adaptor/Cargo.toml

@@ -12,7 +12,7 @@ repository  = "https://github.com/sxyazi/yazi"
 yazi-shared = { path = "../yazi-shared", version = "0.2.5" }
 
 # External dependencies
-anyhow      = "1.0.83"
+anyhow      = "1.0.86"
 arc-swap    = "1.7.1"
 crossterm   = "0.27.0"
 globset     = "0.4.14"

Diff for: yazi-cli/Cargo.toml

@@ -80,12 +80,12 @@ suppress_preload = false
 [plugin]
 
 preloaders = [
-	{ name = "*", cond = "!mime", run = "mime", multi = true, prio = "high" },
+	{ name = "*", cond = "!mime", run = "mime", next = true, multi = true, prio = "high" },
 	# Image
-	{ mime = "image/svg+xml",  run = "magick" },
-	{ mime = "image/heic",     run = "magick" },
-	{ mime = "image/jxl",      run = "magick" },
-	{ mime = "image/*",        run = "image" },
+	{ mime = "image/svg+xml", run = "magick" },
+	{ mime = "image/heic",    run = "magick" },
+	{ mime = "image/jxl",     run = "magick" },
+	{ mime = "image/*",       run = "image" },
 	# Video
 	{ mime = "video/*", run = "video" },
 	# PDF
@@ -102,10 +102,10 @@ previewers = [
 	# JSON
 	{ mime = "application/json", run = "json" },
 	# Image
-	{ mime = "image/svg+xml",  run = "magick" },
-	{ mime = "image/heic",     run = "magick" },
-	{ mime = "image/jxl",      run = "magick" },
-	{ mime = "image/*",        run = "image" },
+	{ mime = "image/svg+xml", run = "magick" },
+	{ mime = "image/heic",    run = "magick" },
+	{ mime = "image/jxl",     run = "magick" },
+	{ mime = "image/*",       run = "image" },
 	# Video
 	{ mime = "video/*", run = "video" },
 	# PDF

Diff for: yazi-config/Cargo.toml

@@ -23,10 +23,10 @@ impl Open {
 		P: AsRef<Path>,
 		M: AsRef<str>,
 	{
-		let is_folder = mime.as_ref() == MIME_DIR;
+		let is_dir = mime.as_ref() == MIME_DIR;
 		self.rules.iter().find_map(|rule| {
 			if rule.mime.as_ref().is_some_and(|p| p.match_mime(&mime))
-				|| rule.name.as_ref().is_some_and(|p| p.match_path(&path, is_folder))
+				|| rule.name.as_ref().is_some_and(|p| p.match_path(&path, is_dir))
 			{
 				let openers = rule
 					.use_

Diff for: yazi-config/preset/yazi.toml

@@ -6,25 +6,25 @@ use serde::Deserialize;
 #[derive(Debug, Deserialize)]
 #[serde(try_from = "String")]
 pub struct Pattern {
-	inner:     globset::GlobMatcher,
-	is_star:   bool,
-	is_folder: bool,
+	inner:   globset::GlobMatcher,
+	is_dir:  bool,
+	is_star: bool,
 }
 
 impl Pattern {
 	#[inline]
 	pub fn match_mime(&self, str: impl AsRef<str>) -> bool { self.inner.is_match(str.as_ref()) }
 
 	#[inline]
-	pub fn match_path(&self, path: impl AsRef<Path>, is_folder: bool) -> bool {
-		is_folder == self.is_folder && (self.is_star || self.inner.is_match(path))
+	pub fn match_path(&self, path: impl AsRef<Path>, is_dir: bool) -> bool {
+		is_dir == self.is_dir && (self.is_star || self.inner.is_match(path))
 	}
 
 	#[inline]
-	pub fn any_file(&self) -> bool { self.is_star && !self.is_folder }
+	pub fn any_file(&self) -> bool { self.is_star && !self.is_dir }
 
 	#[inline]
-	pub fn any_dir(&self) -> bool { self.is_star && self.is_folder }
+	pub fn any_dir(&self) -> bool { self.is_star && self.is_dir }
 }
 
 impl TryFrom<&str> for Pattern {
@@ -42,7 +42,7 @@ impl TryFrom<&str> for Pattern {
 			.build()?
 			.compile_matcher();
 
-		Ok(Self { inner, is_star: b == "*", is_folder: b.len() < a.len() })
+		Ok(Self { inner, is_dir: b.len() < a.len(), is_star: b == "*" })
 	}
 }
 

Diff for: yazi-config/src/open/open.rs

@@ -1,12 +1,9 @@
 mod plugin;
-mod props;
-mod rule;
-mod run;
+mod preloader;
+mod previewer;
 
 pub use plugin::*;
-pub use props::*;
-pub use rule::*;
-#[allow(unused_imports)]
-pub use run::*;
+pub use preloader::*;
+pub use previewer::*;
 
 pub const MAX_PRELOADERS: u8 = 32;

Diff for: yazi-config/src/pattern.rs

@@ -3,13 +3,13 @@ use std::path::Path;
 use serde::Deserialize;
 use yazi_shared::MIME_DIR;
 
-use super::PluginRule;
+use super::{Preloader, Previewer};
 use crate::{plugin::MAX_PRELOADERS, Preset, MERGED_YAZI};
 
 #[derive(Deserialize)]
 pub struct Plugin {
-	pub preloaders: Vec<PluginRule>,
-	pub previewers: Vec<PluginRule>,
+	pub preloaders: Vec<Preloader>,
+	pub previewers: Vec<Previewer>,
 }
 
 impl Default for Plugin {
@@ -21,17 +21,17 @@ impl Default for Plugin {
 
 		#[derive(Deserialize)]
 		struct Shadow {
-			preloaders:         Vec<PluginRule>,
+			preloaders:         Vec<Preloader>,
 			#[serde(default)]
-			prepend_preloaders: Vec<PluginRule>,
+			prepend_preloaders: Vec<Preloader>,
 			#[serde(default)]
-			append_preloaders:  Vec<PluginRule>,
+			append_preloaders:  Vec<Preloader>,
 
-			previewers:         Vec<PluginRule>,
+			previewers:         Vec<Previewer>,
 			#[serde(default)]
-			prepend_previewers: Vec<PluginRule>,
+			prepend_previewers: Vec<Previewer>,
 			#[serde(default)]
-			append_previewers:  Vec<PluginRule>,
+			append_previewers:  Vec<Previewer>,
 		}
 
 		let mut shadow = toml::from_str::<Outer>(&MERGED_YAZI).unwrap().plugin;
@@ -50,9 +50,6 @@ impl Default for Plugin {
 		}
 
 		for (i, preloader) in shadow.preloaders.iter_mut().enumerate() {
-			if preloader.sync {
-				panic!("Preloaders cannot be synchronous");
-			}
 			preloader.id = i as u8;
 		}
 
@@ -66,24 +63,34 @@ impl Plugin {
 		path: &Path,
 		mime: Option<&str>,
 		f: impl Fn(&str) -> bool + Copy,
-	) -> Vec<&PluginRule> {
-		let is_folder = mime == Some(MIME_DIR);
-		self
-			.preloaders
-			.iter()
-			.filter(|&rule| {
-				rule.cond.as_ref().and_then(|c| c.eval(f)) != Some(false)
-					&& (rule.mime.as_ref().zip(mime).map_or(false, |(p, m)| p.match_mime(m))
-						|| rule.name.as_ref().is_some_and(|p| p.match_path(path, is_folder)))
-			})
-			.collect()
+	) -> Vec<&Preloader> {
+		let is_dir = mime == Some(MIME_DIR);
+		let mut preloaders = Vec::with_capacity(1);
+
+		for p in &self.preloaders {
+			if p.cond.as_ref().and_then(|c| c.eval(f)) == Some(false) {
+				continue;
+			}
+
+			if !p.mime.as_ref().zip(mime).map_or(false, |(p, m)| p.match_mime(m))
+				&& !p.name.as_ref().is_some_and(|p| p.match_path(path, is_dir))
+			{
+				continue;
+			}
+
+			preloaders.push(p);
+			if !p.next {
+				break;
+			}
+		}
+		preloaders
 	}
 
-	pub fn previewer(&self, path: &Path, mime: &str) -> Option<&PluginRule> {
-		let is_folder = mime == MIME_DIR;
-		self.previewers.iter().find(|&rule| {
-			rule.mime.as_ref().is_some_and(|p| p.match_mime(mime))
-				|| rule.name.as_ref().is_some_and(|p| p.match_path(path, is_folder))
+	pub fn previewer(&self, path: &Path, mime: &str) -> Option<&Previewer> {
+		let is_dir = mime == MIME_DIR;
+		self.previewers.iter().find(|&p| {
+			p.mime.as_ref().is_some_and(|p| p.match_mime(mime))
+				|| p.name.as_ref().is_some_and(|p| p.match_path(path, is_dir))
 		})
 	}
 }

Diff for: yazi-config/src/plugin/mod.rs

@@ -0,0 +1,39 @@
+use serde::Deserialize;
+use yazi_shared::{event::Cmd, Condition};
+
+use crate::{Pattern, Priority};
+
+#[derive(Debug, Deserialize)]
+pub struct Preloader {
+	#[serde(skip)]
+	pub id:    u8,
+	pub cond:  Option<Condition>,
+	pub name:  Option<Pattern>,
+	pub mime:  Option<Pattern>,
+	pub run:   Cmd,
+	#[serde(default)]
+	pub next:  bool,
+	#[serde(default)]
+	pub multi: bool,
+	#[serde(default)]
+	pub prio:  Priority,
+}
+
+#[derive(Debug, Clone)]
+pub struct PreloaderProps {
+	pub id:    u8,
+	pub name:  String,
+	pub multi: bool,
+	pub prio:  Priority,
+}
+
+impl From<&Preloader> for PreloaderProps {
+	fn from(preloader: &Preloader) -> Self {
+		Self {
+			id:    preloader.id,
+			name:  preloader.run.name.to_owned(),
+			multi: preloader.multi,
+			prio:  preloader.prio,
+		}
+	}
+}

Diff for: yazi-config/src/plugin/plugin.rs

@@ -0,0 +1,21 @@
+use serde::Deserialize;
+use yazi_shared::event::Cmd;
+
+use crate::Pattern;
+
+#[derive(Debug, Deserialize)]
+pub struct Previewer {
+	pub name: Option<Pattern>,
+	pub mime: Option<Pattern>,
+	pub run:  Cmd,
+	#[serde(default)]
+	pub sync: bool,
+}
+
+impl Previewer {
+	#[inline]
+	pub fn any_file(&self) -> bool { self.name.as_ref().is_some_and(|p| p.any_file()) }
+
+	#[inline]
+	pub fn any_dir(&self) -> bool { self.name.as_ref().is_some_and(|p| p.any_dir()) }
+}