Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create nu_glob::is_glob function #14717

Merged
merged 1 commit into from
Jan 2, 2025
Merged

Create nu_glob::is_glob function #14717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/nu-cli/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ tempfile = { workspace = true }
[dependencies]
nu-cmd-base = { path = "../nu-cmd-base", version = "0.101.1" }
nu-engine = { path = "../nu-engine", version = "0.101.1", features = ["os"] }
nu-glob = { path = "../nu-glob", version = "0.101.1" }
nu-path = { path = "../nu-path", version = "0.101.1" }
nu-parser = { path = "../nu-parser", version = "0.101.1" }
nu-plugin-engine = { path = "../nu-plugin-engine", version = "0.101.1", optional = true }
Expand Down
3 changes: 1 addition & 2 deletions crates/nu-cli/src/completions/completion_common.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,8 +286,7 @@ pub fn complete_item(
// Fix files or folders with quotes or hashes
pub fn escape_path(path: String, dir: bool) -> String {
// make glob pattern have the highest priority.
let glob_contaminated = path.contains(['[', '*', ']', '?']);
if glob_contaminated {
if nu_glob::is_glob(path.as_str()) {
return if path.contains('\'') {
// decide to use double quote, also need to escape `"` in path
// or else users can't do anything with completed path either.
Expand Down
4 changes: 1 addition & 3 deletions crates/nu-command/src/filesystem/ls.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ struct Args {
call_span: Span,
}

const GLOB_CHARS: &[char] = &['*', '?', '['];

impl Command for Ls {
fn name(&self) -> &str {
"ls"
Expand Down Expand Up @@ -291,7 +289,7 @@ fn ls_for_one_pattern(
{
return Ok(Value::test_nothing().into_pipeline_data());
}
just_read_dir = !(pat.item.is_expand() && pat.item.as_ref().contains(GLOB_CHARS));
just_read_dir = !(pat.item.is_expand() && nu_glob::is_glob(pat.item.as_ref()));
}

// it's absolute path if:
Expand Down
6 changes: 2 additions & 4 deletions crates/nu-command/src/system/run_external.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,11 +340,9 @@ fn expand_glob(
span: Span,
signals: &Signals,
) -> Result<Vec<OsString>, ShellError> {
const GLOB_CHARS: &[char] = &['*', '?', '['];

// For an argument that doesn't include the GLOB_CHARS, just do the `expand_tilde`
// For an argument that isn't a glob, just do the `expand_tilde`
// and `expand_ndots` expansion
if !arg.contains(GLOB_CHARS) {
if !nu_glob::is_glob(arg) {
let path = expand_ndots_safe(expand_tilde(arg));
return Ok(vec![path.into()]);
}
Expand Down
10 changes: 4 additions & 6 deletions crates/nu-engine/src/glob_from.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ use std::{
path::{Component, Path, PathBuf},
};

const GLOB_CHARS: &[char] = &['*', '?', '['];

/// This function is like `nu_glob::glob` from the `glob` crate, except it is relative to a given cwd.
///
/// It returns a tuple of two values: the first is an optional prefix that the expanded filenames share.
Expand All @@ -29,7 +27,7 @@ pub fn glob_from(
ShellError,
> {
let no_glob_for_pattern = matches!(pattern.item, NuGlob::DoNotExpand(_));
let (prefix, pattern) = if pattern.item.as_ref().contains(GLOB_CHARS) {
let (prefix, pattern) = if nu_glob::is_glob(pattern.item.as_ref()) {
// Pattern contains glob, split it
let mut p = PathBuf::new();
let path = PathBuf::from(&pattern.item.as_ref());
Expand All @@ -38,7 +36,7 @@ pub fn glob_from(

for c in components {
if let Component::Normal(os) = c {
if os.to_string_lossy().contains(GLOB_CHARS) {
if nu_glob::is_glob(os.to_string_lossy().as_ref()) {
break;
}
}
Expand Down Expand Up @@ -73,8 +71,8 @@ pub fn glob_from(
(path.parent().map(|parent| parent.to_path_buf()), path)
} else {
let path = if let Ok(p) = canonicalize_with(path.clone(), cwd) {
if p.to_string_lossy().contains(GLOB_CHARS) {
// our path might contains GLOB_CHARS too
if nu_glob::is_glob(p.to_string_lossy().as_ref()) {
// our path might contain glob metacharacters too.
// in such case, we need to escape our path to make
// glob work successfully
PathBuf::from(nu_glob::Pattern::escape(&p.to_string_lossy()))
Expand Down
21 changes: 21 additions & 0 deletions crates/nu-glob/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,27 @@ pub fn glob_with_parent(
}
}

const GLOB_CHARS: &[char] = &['*', '?', '['];

/// Returns true if the given pattern is a glob, false if it's merely text to be
/// matched exactly.
///
/// ```rust
/// assert!(nu_glob::is_glob("foo/*"));
/// assert!(nu_glob::is_glob("foo/**/bar"));
/// assert!(nu_glob::is_glob("foo?"));
/// assert!(nu_glob::is_glob("foo[A]"));
///
/// assert!(!nu_glob::is_glob("foo"));
/// // nu_glob will ignore an unmatched ']'
/// assert!(!nu_glob::is_glob("foo]"));
/// // nu_glob doesn't expand {}
/// assert!(!nu_glob::is_glob("foo.{txt,png}"));
/// ```
pub fn is_glob(pattern: &str) -> bool {
pattern.contains(GLOB_CHARS)
}

/// A glob iteration error.
///
/// This is typically returned when a particular path cannot be read
Expand Down
Loading