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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

deprecate glob --not in favor of glob --exclude #10827

Merged
merged 4 commits into from
Oct 25, 2023
Merged

deprecate glob --not in favor of glob --exclude #10827

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc769e0
add the `--prune` option with more explicit doc
amtoine Oct 24, 2023
c8bbf7d
deprecate `--not`
amtoine Oct 24, 2023
d209c8f
fix the examples using `--not`
amtoine Oct 24, 2023
c2d26f4
rename `--prune` to `--exclude`
amtoine Oct 25, 2023
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
43 changes: 39 additions & 4 deletions crates/nu-command/src/filesystem/glob.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,15 @@ impl Command for Glob {
.named(
"not",
SyntaxShape::List(Box::new(SyntaxShape::String)),
"Patterns to exclude from the results",
"DEPRECATED OPTION: Patterns to exclude from the results",
Some('n'),
)
.named(
"exclude",
SyntaxShape::List(Box::new(SyntaxShape::String)),
"Patterns to exclude from the search: `glob` will not walk the inside of directories matching the excluded patterns.",
Some('e'),
)
.category(Category::FileSystem)
}

Expand Down Expand Up @@ -111,12 +117,12 @@ 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 --exclude [**/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/** */]"#,
example: r#"glob **/* --exclude [**/target/** **/.git/** */]"#,
result: None,
},
]
Expand All @@ -141,8 +147,37 @@ impl Command for Glob {
let no_files = call.has_flag("no-file");
let no_symlinks = call.has_flag("no-symlink");

if call.has_flag("not") {
nu_protocol::report_error_new(
engine_state,
&ShellError::GenericError(
"Deprecated option".into(),
"`glob --not {list<string>}` is deprecated and will be removed in 0.88.".into(),
Some(call.head),
Some("Please use `glob --exclude {list<string>}` instead.".into()),
vec![],
),
);
}

let not_flag: Option<Value> = call.get_flag(engine_state, stack, "not")?;
let (not_patterns, not_pattern_span): (Vec<String>, Span) = match not_flag {
let exclude_flag: Option<Value> = call.get_flag(engine_state, stack, "exclude")?;

let paths_to_exclude = match (not_flag, exclude_flag) {
(Some(not_flag), Some(exclude_flag)) => {
return Err(ShellError::IncompatibleParameters {
left_message: "Cannot pass --not".into(),
left_span: not_flag.span(),
right_message: "and --exclude".into(),
right_span: exclude_flag.span(),
})
}
(Some(not_flag), None) => Some(not_flag),
(None, Some(exclude_flag)) => Some(exclude_flag),
(None, None) => None,
};

let (not_patterns, not_pattern_span): (Vec<String>, Span) = match paths_to_exclude {
None => (vec![], span),
Some(f) => {
let pat_span = f.span();
Expand Down