feat: new stash command to let users customize back and forward command behavior (#3380)

Author: sxyazi

yazi-actor/src/context.rs

@@ -118,13 +118,5 @@ impl<'a> Ctx<'a> {
 	pub fn tasks(&self) -> &Tasks { &self.tasks }
 
 	#[inline]
-	pub fn source(&self) -> Source {
-		use Source::*;
-		match self.source {
-			Key if self.level != 1 => Ind,
-			Emit if self.level != 1 => EmitInd,
-			Relay if self.level != 1 => RelayInd,
-			s => s,
-		}
-	}
+	pub fn source(&self) -> Source { if self.level != 1 { Source::Ind } else { self.source } }
 }

yazi-actor/src/mgr/back.rs

@@ -14,7 +14,7 @@ impl Actor for Back {
 
 	fn act(cx: &mut Ctx, _: Self::Options) -> Result<Data> {
 		if let Some(u) = cx.tab_mut().backstack.shift_backward().cloned() {
-			return act!(mgr:cd, cx, (u, CdSource::Back));
+			act!(mgr:cd, cx, (u, CdSource::Back))?;
 		}
 		succ!();
 	}

yazi-actor/src/mgr/cd.rs

@@ -9,7 +9,7 @@ use yazi_fs::{File, FilesOp, path::expand_url};
 use yazi_macro::{act, err, render, succ};
 use yazi_parser::mgr::CdOpt;
 use yazi_proxy::{CmpProxy, InputProxy, MgrProxy};
-use yazi_shared::{Debounce, data::Data, errors::InputError, url::{AsUrl, UrlBuf, UrlLike}};
+use yazi_shared::{Debounce, data::Data, errors::InputError, url::{UrlBuf, UrlLike}};
 use yazi_vfs::VfsFile;
 
 use crate::{Actor, Ctx};
@@ -33,18 +33,8 @@ impl Actor for Cd {
 		}
 
 		// Take parent to history
-		if let Some(rep) = tab.parent.take() {
-			tab.history.insert(rep.url.to_owned(), rep);
-		}
-
-		// Backstack
-		if opt.source.big_jump() {
-			if tab.current.url.is_regular() {
-				tab.backstack.push(tab.current.url.as_url());
-			}
-			if opt.target.is_regular() {
-				tab.backstack.push(opt.target.as_url());
-			}
+		if let Some(t) = tab.parent.take() {
+			tab.history.insert(t.url.to_owned(), t);
 		}
 
 		// Current
@@ -58,10 +48,12 @@ impl Actor for Cd {
 		}
 
 		err!(Pubsub::pub_after_cd(tab.id, tab.cwd()));
+		act!(mgr:displace, cx)?;
 		act!(mgr:hidden, cx)?;
 		act!(mgr:sort, cx)?;
 		act!(mgr:hover, cx)?;
 		act!(mgr:refresh, cx)?;
+		act!(mgr:stash, cx, opt).ok();
 		succ!(render!());
 	}
 }

yazi-actor/src/mgr/displace.rs

@@ -0,0 +1,59 @@
+use anyhow::{Result, bail};
+use yazi_macro::{act, succ};
+use yazi_parser::{VoidOpt, mgr::{CdSource, DisplaceDoOpt}};
+use yazi_proxy::MgrProxy;
+use yazi_shared::{data::Data, url::UrlLike};
+use yazi_vfs::provider;
+
+use crate::{Actor, Ctx};
+
+pub struct Displace;
+
+impl Actor for Displace {
+	type Options = VoidOpt;
+
+	const NAME: &str = "displace";
+
+	fn act(cx: &mut Ctx, _: Self::Options) -> Result<Data> {
+		if cx.cwd().is_absolute() {
+			succ!();
+		}
+
+		let tab = cx.tab().id;
+		let from = cx.cwd().to_owned();
+		tokio::spawn(async move {
+			if let Ok(to) = provider::absolute(&from).await
+				&& to.is_owned()
+			{
+				MgrProxy::displace_do(tab, DisplaceDoOpt { to: to.into(), from });
+			}
+		});
+
+		succ!();
+	}
+}
+
+// --- Do
+pub struct DisplaceDo;
+
+impl Actor for DisplaceDo {
+	type Options = DisplaceDoOpt;
+
+	const NAME: &str = "displace_do";
+
+	fn act(cx: &mut Ctx, opt: Self::Options) -> Result<Data> {
+		if !opt.to.is_absolute() {
+			bail!("Target URL must be absolute");
+		}
+
+		if cx.cwd() != opt.from {
+			succ!()
+		} else if let Some(hovered) = cx.hovered()
+			&& let Ok(url) = opt.to.try_join(hovered.urn())
+		{
+			act!(mgr:reveal, cx, (url, CdSource::Displace))
+		} else {
+			act!(mgr:cd, cx, (opt.to, CdSource::Displace))
+		}
+	}
+}

yazi-actor/src/mgr/forward.rs

@@ -13,9 +13,9 @@ impl Actor for Forward {
 	const NAME: &str = "forward";
 
 	fn act(cx: &mut Ctx, _: Self::Options) -> Result<Data> {
-		match cx.tab_mut().backstack.shift_forward().cloned() {
-			Some(u) => act!(mgr:cd, cx, (u, CdSource::Forward)),
-			None => succ!(),
+		if let Some(u) = cx.tab_mut().backstack.shift_forward().cloned() {
+			act!(mgr:cd, cx, (u, CdSource::Forward))?;
 		}
+		succ!()
 	}
 }

yazi-actor/src/mgr/mod.rs

@@ -6,6 +6,7 @@ yazi_macro::mod_flat!(
 	close
 	copy
 	create
+	displace
 	download
 	enter
 	escape
@@ -36,6 +37,7 @@ yazi_macro::mod_flat!(
 	shell
 	sort
 	spot
+	stash
 	suspend
 	tab_close
 	tab_create

yazi-actor/src/mgr/search.rs

@@ -1,12 +1,12 @@
-use std::{borrow::Cow, mem, time::Duration};
+use std::{borrow::Cow, time::Duration};
 
 use anyhow::Result;
 use tokio::pin;
 use tokio_stream::{StreamExt, wrappers::UnboundedReceiverStream};
 use yazi_config::popup::InputCfg;
 use yazi_fs::{FilesOp, cha::Cha};
 use yazi_macro::{act, succ};
-use yazi_parser::{VoidOpt, mgr::{SearchOpt, SearchOptVia}};
+use yazi_parser::{VoidOpt, mgr::{CdSource, SearchOpt, SearchOptVia}};
 use yazi_plugin::external;
 use yazi_proxy::{InputProxy, MgrProxy};
 use yazi_shared::data::Data;
@@ -107,15 +107,10 @@ impl Actor for SearchStop {
 			handle.abort();
 		}
 
-		if !tab.cwd().is_search() {
-			succ!();
+		if tab.cwd().is_search() {
+			act!(mgr:cd, cx, (tab.cwd().to_regular()?, CdSource::Escape))?;
 		}
 
-		let rep = tab.history.remove_or(tab.cwd().to_regular()?);
-		drop(mem::replace(&mut tab.current, rep));
-
-		act!(mgr:hidden, cx)?;
-		act!(mgr:sort, cx)?;
-		act!(mgr:refresh, cx)
+		succ!();
 	}
 }

yazi-actor/src/mgr/stash.rs

@@ -0,0 +1,31 @@
+use anyhow::Result;
+use yazi_dds::spark::SparkKind;
+use yazi_macro::succ;
+use yazi_parser::mgr::StashOpt;
+use yazi_shared::{Source, data::Data, url::AsUrl};
+
+use crate::{Actor, Ctx};
+
+pub struct Stash;
+
+impl Actor for Stash {
+	type Options = StashOpt;
+
+	const NAME: &str = "stash";
+
+	fn act(cx: &mut Ctx, opt: Self::Options) -> Result<Data> {
+		if opt.target.is_regular() {
+			cx.tab_mut().backstack.push(opt.target.as_url());
+		}
+
+		succ!()
+	}
+
+	fn hook(cx: &Ctx, _opt: &Self::Options) -> Option<SparkKind> {
+		match cx.source() {
+			Source::Relay => Some(SparkKind::RelayStash),
+			Source::Ind => Some(SparkKind::IndStash),
+			_ => None,
+		}
+	}
+}

yazi-binding/src/url.rs

@@ -49,6 +49,10 @@ impl From<Url> for yazi_shared::url::UrlBufCov {
 	fn from(value: Url) -> Self { Self(value.inner) }
 }
 
+impl From<Url> for yazi_shared::url::UrlCow<'_> {
+	fn from(value: Url) -> Self { value.inner.into() }
+}
+
 impl TryFrom<&[u8]> for Url {
 	type Error = mlua::Error;
 

yazi-config/src/which/sorting.rs

@@ -1,6 +1,6 @@
 use serde::{Deserialize, Serialize};
 
-#[derive(Clone, Copy, Debug, Default, Deserialize, Serialize, PartialEq, Eq)]
+#[derive(Clone, Copy, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
 #[serde(rename_all = "kebab-case")]
 pub enum SortBy {
 	#[default]