add the ability to have a list of glob excludes (#9343)

# Description

This change allows you to have a list of exclude globs such as:
```
glob **/* --not [**/target/** **/.git/**]
```

TODO: Allow the input glob to be multiples too with
`wax::any(patterns)?`

The breaking change part is that the excludes have to be supplied as a
list, between [ and ].

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

# Tests + Formatting
<!--
Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect -A clippy::result_large_err` to check that
you're using the standard code style
- `cargo test --workspace` to check that all tests pass
- `cargo run -- crates/nu-std/tests/run.nu` to run the tests for the
standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->

# After Submitting
<!-- If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
-->
This commit is contained in:
Darren Schroeder 2023-06-02 12:37:17 -05:00 committed by GitHub
parent 2ac63910f6
commit 5c57d6a74d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,6 +1,3 @@
use std::sync::atomic::AtomicBool;
use std::sync::Arc;
use nu_engine::env::current_dir;
use nu_engine::CallExt;
use nu_protocol::ast::Call;
@ -9,6 +6,8 @@ use nu_protocol::{
Category, Example, IntoInterruptiblePipelineData, PipelineData, ShellError, Signature, Span,
Spanned, SyntaxShape, Type, Value,
};
use std::sync::atomic::AtomicBool;
use std::sync::Arc;
use wax::{Glob as WaxGlob, WalkBehavior, WalkEntry};
#[derive(Clone)]
@ -46,8 +45,8 @@ impl Command for Glob {
)
.named(
"not",
SyntaxShape::String,
"Pattern to exclude from the results",
SyntaxShape::List(Box::new(SyntaxShape::String)),
"Patterns to exclude from the results",
Some('n'),
)
.category(Category::FileSystem)
@ -112,10 +111,14 @@ impl Command for Glob {
},
Example {
description: "Search for files named tsconfig.json that are not in node_modules directories",
example: r#"glob **/tsconfig.json --not **/node_modules/**"#,
example: r#"glob **/tsconfig.json --not [**/node_modules/**]"#,
result: None,
},
Example {
description: "Search for all files that are not in the target nor .git directories",
example: r#"glob **/* --not [**/target/** **/.git/** */]"#,
result: None,
},
]
}
@ -138,7 +141,18 @@ impl Command for Glob {
let no_dirs = call.has_flag("no-dir");
let no_files = call.has_flag("no-file");
let no_symlinks = call.has_flag("no-symlink");
let not_pattern: Option<Spanned<String>> = call.get_flag(engine_state, stack, "not")?;
let (not_patterns, not_pattern_span): (Vec<String>, Span) = if let Some(Value::List {
vals: pats,
span: pat_span,
}) =
call.get_flag(engine_state, stack, "not")?
{
let p = convert_patterns(pats.as_slice(), span)?;
(p, pat_span)
} else {
(vec![], span)
};
if glob_pattern.item.is_empty() {
return Err(ShellError::GenericError(
@ -169,13 +183,8 @@ impl Command for Glob {
}
};
let (not_pat, not_span) = if let Some(not_pat) = not_pattern.clone() {
(not_pat.item, not_pat.span)
} else {
(String::new(), Span::test_data())
};
Ok(if not_pattern.is_some() {
Ok(if !not_patterns.is_empty() {
let np: Vec<&str> = not_patterns.iter().map(|s| s as &str).collect();
let glob_results = glob
.walk_with_behavior(
path,
@ -184,12 +193,12 @@ impl Command for Glob {
..Default::default()
},
)
.not([not_pat.as_str()])
.not(np)
.map_err(|err| {
ShellError::GenericError(
"error with glob's not pattern".to_string(),
format!("{err}"),
Some(not_span),
Some(not_pattern_span),
None,
Vec::new(),
)
@ -217,6 +226,21 @@ impl Command for Glob {
}
}
fn convert_patterns(columns: &[Value], span: Span) -> Result<Vec<String>, ShellError> {
let res = columns
.iter()
.map(|value| match &value {
Value::String { val: s, .. } => Ok(s.clone()),
_ => Err(ShellError::IncompatibleParametersSingle {
msg: "Incorrect column format, Only string as column name".to_string(),
span: value.span().unwrap_or(span),
}),
})
.collect::<Result<Vec<String>, _>>()?;
Ok(res)
}
fn glob_to_value<'a>(
ctrlc: Option<Arc<AtomicBool>>,
glob_results: impl Iterator<Item = WalkEntry<'a>>,