Public/nushell
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add doc comments for recursive path completion function

Browse Source
This commit is contained in:
Himadri Bhattacharjee 2024-08-04 12:41:02 +05:30
parent e3db29b1b6
commit 8181783e5e
No known key found for this signature in database
1 changed files with 25 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
crates/nu-cli/src/completions/completion_common.rs
View File

@ -22,12 +22,21 @@ pub struct PathBuiltFromString {
isdir: bool, isdir: bool,
} }
fn complete_rec( /// Recursively goes through paths that match a given `partial`.
/// built: State struct for a valid matching path built so far.
///
/// `isdir`: whether the current partial path has a trailing slash.
/// Parsing a path string into a pathbuf loses that bit of information.
///
/// want_directory: Whether we want only directories as completion matches.
/// Some commands like `cd` can only be run on directories whereas others
/// like `ls` can be run on regular files as well.
pub fn complete_rec(
partial: &[&str], partial: &[&str],
built: &PathBuiltFromString, built: &PathBuiltFromString,
cwd: &Path, cwd: &Path,
options: &CompletionOptions, options: &CompletionOptions,
dir: bool, want_directory: bool,
isdir: bool, isdir: bool,
) -> Vec<PathBuiltFromString> { ) -> Vec<PathBuiltFromString> {
let mut completions = vec![]; let mut completions = vec![];
@ -37,7 +46,7 @@ fn complete_rec(
let mut built = built.clone(); let mut built = built.clone();
built.parts.push(base.to_string()); built.parts.push(base.to_string());
built.isdir = true; built.isdir = true;
return complete_rec(rest, &built, cwd, options, dir, isdir); return complete_rec(rest, &built, cwd, options, want_directory, isdir);
} }
} }
@ -58,7 +67,7 @@ fn complete_rec(
built.parts.push(entry_name.clone()); built.parts.push(entry_name.clone());
built.isdir = entry_isdir; built.isdir = entry_isdir;
if !dir || entry_isdir { if !want_directory || entry_isdir {
entries.push((entry_name, built)); entries.push((entry_name, built));
} }
} }
@ -70,19 +79,23 @@ fn complete_rec(
match partial.split_first() { match partial.split_first() {
Some((base, rest)) => { Some((base, rest)) => {
if matches(base, &entry_name, options) { if matches(base, &entry_name, options) {
// We use `isdir` to confirm that the current component has
// at least one next component or a slash.
// Serves as confirmation to ignore longer completions for
// components in between.
if !rest.is_empty() || isdir { if !rest.is_empty() || isdir {
completions.extend(complete_rec(rest, &built, cwd, options, dir, isdir)); completions.extend(complete_rec(
rest,
&built,
cwd,
options,
want_directory,
isdir,
));
} else { } else {
completions.push(built); completions.push(built);
} }
} }
// isdir tells us whether the current path has a trailing slash.
// Parsing a path string into a pathbuf loses that bit of information.
// We use isdir to confirm that the current component has at least one
// next component or a slash.
// This acts as a confirmation to ignore longer completions for components
// in between.
if entry_name.eq(base) if entry_name.eq(base)
&& matches!(options.match_algorithm, MatchAlgorithm::Prefix) && matches!(options.match_algorithm, MatchAlgorithm::Prefix)
&& isdir && isdir