Add support for cmd.exe (experimental)

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- Support for `cmd.exe` (experimental).
+
 ### Added
 
 - Short option `-a` for `zoxide query --all`.

Cargo.toml

@@ -22,7 +22,7 @@ bincode = "1.3.1"
 clap = { version = "4.0.0", features = ["derive"] }
 color-print = "0.3.4"
 dirs = "5.0.0"
-dunce = "1.0.1"
+dunce = "1.0.4"
 fastrand = "1.7.0"
 glob = "0.3.0"
 ouroboros = "0.15.5"

src/cmd/cmd.rs

@@ -132,6 +132,7 @@ pub enum InitHook {
 #[derive(ValueEnum, Clone, Debug)]
 pub enum InitShell {
  Bash,
+ Cmd,
  Elvish,
  Fish,
  Nushell,

src/cmd/init.rs

@@ -6,7 +6,7 @@ use askama::Template;
 use crate::cmd::{Init, InitShell, Run};
 use crate::config;
 use crate::error::BrokenPipeHandler;
-use crate::shell::{Bash, Elvish, Fish, Nushell, Opts, Posix, Powershell, Xonsh, Zsh};
+use crate::shell::{Bash, Cmd, Elvish, Fish, Nushell, Opts, Posix, Powershell, Xonsh, Zsh};
 
 impl Run for Init {
  fn run(&self) -> Result<()> {
@@ -17,6 +17,7 @@ impl Run for Init {
 
  let source = match self.shell {
  InitShell::Bash => Bash(opts).render(),
+ InitShell::Cmd => Cmd(opts).render(),
  InitShell::Elvish => Elvish(opts).render(),
  InitShell::Fish => Fish(opts).render(),
  InitShell::Nushell => Nushell(opts).render(),

src/shell.rs

@@ -24,6 +24,7 @@ macro_rules! make_template {
 }
 
 make_template!(Bash, "bash.txt");
+make_template!(Cmd, "cmd.txt");
 make_template!(Elvish, "elvish.txt");
 make_template!(Fish, "fish.txt");
 make_template!(Nushell, "nushell.txt");
@@ -53,6 +54,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn bash_bash(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let source = Bash(&opts).render().unwrap();
@@ -65,6 +67,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn bash_shellcheck(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let source = Bash(&opts).render().unwrap();
@@ -79,6 +82,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn bash_shfmt(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let mut source = Bash(&opts).render().unwrap();
@@ -94,6 +98,22 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(windows)]
+ fn cmd_cmd(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
+ let opts = Opts { cmd, hook, echo, resolve_symlinks };
+ let source = Cmd(&opts).render().unwrap();
+
+ Command::new("cmd.exe")
+ .args(["/a", "/d", "/e:on", "/q", "/v:off", "/k", "@doskey", "/macros:cmd.exe"])
+ .write_stdin(source)
+ .assert()
+ .success()
+ .stdout("")
+ .stderr("");
+ }
+
+ #[apply(opts)]
+ #[cfg(unix)]
  fn elvish_elvish(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let mut source = String::default();
@@ -114,6 +134,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn fish_fish(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let source = Fish(&opts).render().unwrap();
@@ -131,6 +152,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn fish_fishindent(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let mut source = Fish(&opts).render().unwrap();
@@ -149,6 +171,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn nushell_nushell(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let source = Nushell(&opts).render().unwrap();
@@ -169,6 +192,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn posix_bash(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let source = Posix(&opts).render().unwrap();
@@ -184,6 +208,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn posix_dash(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let source = Posix(&opts).render().unwrap();
@@ -196,7 +221,8 @@ mod tests {
  }
 
  #[apply(opts)]
- fn posix_shellcheck_(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
+ #[cfg(unix)]
+ fn posix_shellcheck(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let source = Posix(&opts).render().unwrap();
 
@@ -210,6 +236,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn posix_shfmt(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let mut source = Posix(&opts).render().unwrap();
@@ -225,6 +252,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn powershell_pwsh(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let mut source = "Set-StrictMode -Version latest\n".to_string();
@@ -239,6 +267,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn xonsh_black(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let mut source = Xonsh(&opts).render().unwrap();
@@ -253,6 +282,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn xonsh_mypy(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let source = Xonsh(&opts).render().unwrap();
@@ -261,6 +291,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn xonsh_pylint(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let mut source = Xonsh(&opts).render().unwrap();
@@ -275,6 +306,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn xonsh_xonsh(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let source = Xonsh(&opts).render().unwrap();
@@ -292,6 +324,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn zsh_shellcheck(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let source = Zsh(&opts).render().unwrap();
@@ -307,6 +340,7 @@ mod tests {
  }
 
  #[apply(opts)]
+ #[cfg(unix)]
  fn zsh_zsh(cmd: Option<&str>, hook: InitHook, echo: bool, resolve_symlinks: bool) {
  let opts = Opts { cmd, hook, echo, resolve_symlinks };
  let source = Zsh(&opts).render().unwrap();

src/util.rs

@@ -291,44 +291,77 @@ pub fn resolve_path(path: impl AsRef<Path>) -> Result<PathBuf> {
  }
  }
 
- fn get_drive_path(drive_letter: u8) -> PathBuf {
- format!(r"{}:\", drive_letter as char).into()
+ fn get_drive_prefix_path(drive_letter: u8) -> PathBuf {
+ format!(r"{}:\", patch_drive_letter(drive_letter)).into()
  }
 
- fn get_drive_relative(drive_letter: u8) -> Result<PathBuf> {
+ fn get_drive_relative_path(drive_letter: u8) -> Result<PathBuf> {
  let path = current_dir()?;
  if Some(drive_letter) == get_drive_letter(&path) {
- return Ok(path);
+ return Ok(patch_drive_prefix(path));
  }
 
- if let Some(path) = env::var_os(format!("={}:", drive_letter as char)) {
- return Ok(path.into());
+ if let Some(path) = env::var_os(format!("={}:", patch_drive_letter(drive_letter))) {
+ return Ok(patch_drive_prefix(path.into()));
  }
 
- let path = get_drive_path(drive_letter);
+ let path = get_drive_prefix_path(drive_letter);
  Ok(path)
  }
 
+ #[inline(always)]
+ fn patch_drive_letter(drive_letter: u8) -> char {
+ drive_letter.to_ascii_uppercase() as char
+ }
+
+ // https://github.com/rust-lang/rust-analyzer/pull/14689
+ fn patch_drive_prefix(path: PathBuf) -> PathBuf {
+ let mut components = path.components();
+
+ match components.next() {
+ Some(Component::Prefix(prefix)) => {
+ let prefix = match prefix.kind() {
+ Prefix::Disk(drive_letter) => {
+ format!(r"{}:", patch_drive_letter(drive_letter))
+ }
+ Prefix::VerbatimDisk(drive_letter) => {
+ format!(r"\\?\{}:", patch_drive_letter(drive_letter))
+ }
+ _ => return path,
+ };
+
+ let mut path = PathBuf::default();
+ path.push(prefix);
+ path.extend(components);
+ path
+ }
+ _ => path,
+ }
+ }
+
  match components.peek() {
  Some(Component::Prefix(prefix)) => match prefix.kind() {
  Prefix::Disk(drive_letter) => {
- let disk = components.next().unwrap();
+ components.next();
  if components.peek() == Some(&Component::RootDir) {
- let root = components.next().unwrap();
- stack.push(disk);
- stack.push(root);
+ components.next();
+ base_path = get_drive_prefix_path(drive_letter);
  } else {
- base_path = get_drive_relative(drive_letter)?;
- stack.extend(base_path.components());
+ base_path = get_drive_relative_path(drive_letter)?;
  }
+
+ stack.extend(base_path.components());
  }
  Prefix::VerbatimDisk(drive_letter) => {
  components.next();
  if components.peek() == Some(&Component::RootDir) {
  components.next();
+ base_path = get_drive_prefix_path(drive_letter);
+ } else {
+ // Verbatim prefix without a root component? Likely not a legal path
+ bail!("illegal path: {}", path.display());
  }
 
- base_path = get_drive_path(drive_letter);
  stack.extend(base_path.components());
  }
  _ => bail!("invalid path: {}", path.display()),
@@ -340,7 +373,7 @@ pub fn resolve_path(path: impl AsRef<Path>) -> Result<PathBuf> {
  let drive_letter = get_drive_letter(&current_dir).with_context(|| {
  format!("could not get drive letter: {}", current_dir.display())
  })?;
- base_path = get_drive_path(drive_letter);
+ base_path = get_drive_prefix_path(drive_letter);
  stack.extend(base_path.components());
  }
  _ => {
@@ -377,3 +410,38 @@ pub fn to_lowercase(s: impl AsRef<str>) -> String {
  let s = s.as_ref();
  if s.is_ascii() { s.to_ascii_lowercase() } else { s.to_lowercase() }
 }
+
+#[cfg(test)]
+#[cfg(windows)]
+mod tests_win {
+ use std::path::PathBuf;
+
+ use rstest::rstest;
+
+ #[rstest]
+ #[case(r"c:\", r"C:\")]
+ #[case(r"C:\", r"C:\")]
+ #[case(r"c:\\.", r"C:\")]
+ #[case(r"c:\..", r"C:\")]
+ #[case(r"C:\.\.", r"C:\")]
+ #[case(r"\\?\C:\", r"C:\")]
+ #[case(r"\\?\c:\", r"C:\")]
+ #[case(r"\\?\C:\\\", r"C:\")]
+ #[case(r"\\?\c:\\.\", r"C:\")]
+ #[case(r"c:\Windows", r"C:\Windows")]
+ #[case(r"C:\WINDOWS", r"C:\WINDOWS")]
+ #[case(r"c:\\\Windows\.", r"C:\Windows")]
+ #[case(r"C:\$WinREAgent", r"C:\$WinREAgent")]
+ #[case(r"\\?\c:\\Windows\\.", r"C:\Windows")]
+ #[case(r"\\?\c:\..\.\windows", r"C:\windows")]
+ #[case(r"c:\Windows\System32\.", r"C:\Windows\System32")]
+ #[case(r"c:\WINDOWS\..\..\Windows", r"C:\Windows")]
+ #[case(r"c:\Windows\..\.\.\..\Temp\..\tmp", r"C:\tmp")]
+ #[case(r"c:\.\Windows\..\..\Program Files", r"C:\Program Files")]
+ #[case(r"\\?\C:\\$WinREAgent\\..\Program Files\.", r"C:\Program Files")]
+ fn resolve_path(#[case] absolute_path: &str, #[case] normalized_form: &str) {
+ let path = PathBuf::from(absolute_path);
+ let resolved_path = super::resolve_path(path).unwrap();
+ assert_eq!(resolved_path.to_str().unwrap(), normalized_form);
+ }
+}