Skip to content

Commit

Permalink
feat: Add option to always include cwd prefix
Browse files Browse the repository at this point in the history
Fixes: #1243
Fixes: #1331
  • Loading branch information
tmccombs committed Dec 9, 2023
1 parent 74b850a commit 6567b29
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 9 deletions.
2 changes: 1 addition & 1 deletion contrib/completion/_fd
Expand Up @@ -162,7 +162,7 @@ _fd() {
$no'(*)*--search-path=[set search path (instead of positional <path> arguments)]:directory:_files -/'

+ strip-cwd-prefix
$no'(strip-cwd-prefix exec-cmds)--strip-cwd-prefix[Strip ./ prefix when output is redirected]'
$no'(strip-cwd-prefix exec-cmds)--strip-cwd-prefix=[When to strip ./]:when:(always never auto)'

+ and
'--and=[additional required search path]:pattern'
Expand Down
17 changes: 14 additions & 3 deletions doc/fd.1
Expand Up @@ -159,9 +159,20 @@ can be used as an alias.
Enable the display of filesystem errors for situations such as insufficient
permissions or dead symlinks.
.TP
.B \-\-strip-cwd-prefix
By default, relative paths are prefixed with './' when the output goes to a non interactive terminal
(TTY). Use this flag to disable this behaviour.
.B \-\-strip-cwd-prefix [when]
By default, relative paths are prefixed with './' when -x/--exec,
-X/--exec-batch, or -0/--print0 are given, to reduce the risk of a
path starting with '-' being treated as a command line option. Use
this flag to change this behavior. If htis flag is used without a value,
it is equivalent to passing "always". Possible values are:
.RS
.IP auto
Use the default behavior.
.IP never
Never strip the ./ at the beginning of paths
.IP always
Always strip the ./ at the beinning of paths
.RE
.TP
.B \-\-one\-file\-system, \-\-mount, \-\-xdev
By default, fd will traverse the file system tree as far as other options dictate. With this flag, fd ensures that it does not descend into a different file system than the one it started in. Comparable to the -mount or -xdev filters of find(1).
Expand Down
39 changes: 36 additions & 3 deletions src/cli.rs
Expand Up @@ -618,9 +618,22 @@ pub struct Opts {
/// By default, relative paths are prefixed with './' when -x/--exec,
/// -X/--exec-batch, or -0/--print0 are given, to reduce the risk of a
/// path starting with '-' being treated as a command line option. Use
/// this flag to disable this behaviour.
#[arg(long, conflicts_with_all(&["path", "search_path"]), hide_short_help = true, long_help)]
pub strip_cwd_prefix: bool,
/// this flag to change this behavior. If this flag is used without a value,
/// it is equivalent to passing "always".
#[arg(long, conflicts_with_all(&["path", "search_path"]), value_name = "when", hide_short_help = true, long_help)]
strip_cwd_prefix: Option<Option<StripCwdWhen>>,

/// Force including the './' prefix for relative paths. By default, this
/// is not included unless using --exec, --exec-batch, or --print0. But with
/// this option, the prefix is never stripped.
#[arg(
long,
hide_short_help = true,
conflicts_with("absolute_path"),
overrides_with("strip_cwd_prefix"),
long_help
)]
pub cwd_prefix: bool,

/// By default, fd will traverse the file system tree as far as other options
/// dictate. With this flag, fd ensures that it does not descend into a
Expand Down Expand Up @@ -698,6 +711,16 @@ impl Opts {
.or_else(|| self.max_one_result.then_some(1))
}

pub fn strip_cwd_prefix<P: FnOnce() -> bool>(&self, auto_pred: P) -> bool {
use self::StripCwdWhen::*;
self.no_search_paths()
&& match self.strip_cwd_prefix.map_or(Auto, |o| o.unwrap_or(Always)) {
Auto => auto_pred(),
Always => true,
Never => false,
}
}

#[cfg(feature = "completions")]
pub fn gen_completions(&self) -> anyhow::Result<Option<Shell>> {
self.gen_completions
Expand Down Expand Up @@ -779,6 +802,16 @@ impl ColorWhen {
}
}

#[derive(Copy, Clone, PartialEq, Eq, Debug, ValueEnum)]
pub enum StripCwdWhen {
/// Use the default behavior
Auto,
/// Always strip the ./ at the beginning of paths
Always,
/// Never strip the ./
Never,
}

// there isn't a derive api for getting grouped values yet,
// so we have to use hand-rolled parsing for exec and exec-batch
pub struct Exec {
Expand Down
3 changes: 1 addition & 2 deletions src/main.rs
Expand Up @@ -311,8 +311,7 @@ fn construct_config(mut opts: Opts, pattern_regexps: &[String]) -> Result<Config
path_separator,
actual_path_separator,
max_results: opts.max_results(),
strip_cwd_prefix: (opts.no_search_paths()
&& (opts.strip_cwd_prefix || !(opts.null_separator || has_command))),
strip_cwd_prefix: opts.strip_cwd_prefix(|| !(opts.null_separator || has_command)),
})
}

Expand Down

0 comments on commit 6567b29

Please sign in to comment.