mirror of
https://github.com/nushell/nushell.git
synced 2025-02-09 06:59:19 +01:00
add str escape-glob
command (#11664)
# Description This pr is a follow up to #11621, it introduces a `str escape-glob` command as a workaround for the case: ```nushell let f = "a[123]b" ls $f ``` It will glob `a[123]b`, we can get rid of the behavior through `str escape-glob` command: ```nushll let f = "a[123]b" ls ($f | str escape-glob) ``` It's more useful in the `each` context: `ls | get name | str escape-glob | each {|it| ls $it}` # User-Facing Changes NaN # Tests + Formatting Done # After Submitting --------- Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com>
This commit is contained in:
parent
427857a78e
commit
0e023eaa84
@ -174,6 +174,7 @@ pub fn add_shell_command_context(mut engine_state: EngineState) -> EngineState {
|
|||||||
SplitColumn,
|
SplitColumn,
|
||||||
SplitRow,
|
SplitRow,
|
||||||
SplitWords,
|
SplitWords,
|
||||||
|
StrEscapeGlob,
|
||||||
Str,
|
Str,
|
||||||
StrCapitalize,
|
StrCapitalize,
|
||||||
StrContains,
|
StrContains,
|
||||||
|
92
crates/nu-command/src/strings/str_/escape_glob.rs
Normal file
92
crates/nu-command/src/strings/str_/escape_glob.rs
Normal file
@ -0,0 +1,92 @@
|
|||||||
|
use nu_cmd_base::input_handler::{operate, CmdArgument};
|
||||||
|
use nu_engine::CallExt;
|
||||||
|
use nu_protocol::ast::Call;
|
||||||
|
use nu_protocol::ast::CellPath;
|
||||||
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
||||||
|
use nu_protocol::Category;
|
||||||
|
use nu_protocol::{Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value};
|
||||||
|
|
||||||
|
#[derive(Clone)]
|
||||||
|
pub struct SubCommand;
|
||||||
|
|
||||||
|
struct Arguments {
|
||||||
|
cell_paths: Option<Vec<CellPath>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CmdArgument for Arguments {
|
||||||
|
fn take_cell_paths(&mut self) -> Option<Vec<CellPath>> {
|
||||||
|
self.cell_paths.take()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Command for SubCommand {
|
||||||
|
fn name(&self) -> &str {
|
||||||
|
"str escape-glob"
|
||||||
|
}
|
||||||
|
|
||||||
|
fn signature(&self) -> Signature {
|
||||||
|
Signature::build("str escape-glob")
|
||||||
|
.input_output_types(vec![
|
||||||
|
(Type::String, Type::String),
|
||||||
|
(
|
||||||
|
Type::List(Box::new(Type::String)),
|
||||||
|
Type::List(Box::new(Type::String)),
|
||||||
|
),
|
||||||
|
(Type::Table(vec![]), Type::Table(vec![])),
|
||||||
|
(Type::Record(vec![]), Type::Record(vec![])),
|
||||||
|
])
|
||||||
|
.allow_variants_without_examples(true)
|
||||||
|
.rest(
|
||||||
|
"rest",
|
||||||
|
SyntaxShape::CellPath,
|
||||||
|
"For a data structure input, turn strings at the given cell paths into substrings.",
|
||||||
|
)
|
||||||
|
.category(Category::Strings)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn usage(&self) -> &str {
|
||||||
|
"Escape glob pattern."
|
||||||
|
}
|
||||||
|
|
||||||
|
fn search_terms(&self) -> Vec<&str> {
|
||||||
|
vec!["pattern", "list", "ls"]
|
||||||
|
}
|
||||||
|
|
||||||
|
fn run(
|
||||||
|
&self,
|
||||||
|
engine_state: &EngineState,
|
||||||
|
stack: &mut Stack,
|
||||||
|
call: &Call,
|
||||||
|
input: PipelineData,
|
||||||
|
) -> Result<PipelineData, ShellError> {
|
||||||
|
let cell_paths: Vec<CellPath> = call.rest(engine_state, stack, 0)?;
|
||||||
|
let cell_paths = (!cell_paths.is_empty()).then_some(cell_paths);
|
||||||
|
let args = Arguments { cell_paths };
|
||||||
|
operate(action, args, input, call.head, engine_state.ctrlc.clone())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn examples(&self) -> Vec<Example> {
|
||||||
|
vec![Example {
|
||||||
|
description: "escape glob pattern before list",
|
||||||
|
example: r#"let f = 'test[a]'; ls ($f | str escape-glob)"#,
|
||||||
|
result: None,
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn action(input: &Value, _args: &Arguments, head: Span) -> Value {
|
||||||
|
match input {
|
||||||
|
Value::String { val: s, .. } => Value::string(nu_glob::Pattern::escape(s), input.span()),
|
||||||
|
// Propagate errors by explicitly matching them before the final case.
|
||||||
|
Value::Error { .. } => input.clone(),
|
||||||
|
other => Value::error(
|
||||||
|
ShellError::OnlySupportsThisInputType {
|
||||||
|
exp_input_type: "string".into(),
|
||||||
|
wrong_type: other.get_type().to_string(),
|
||||||
|
dst_span: head,
|
||||||
|
src_span: other.span(),
|
||||||
|
},
|
||||||
|
head,
|
||||||
|
),
|
||||||
|
}
|
||||||
|
}
|
@ -2,6 +2,7 @@ mod case;
|
|||||||
mod contains;
|
mod contains;
|
||||||
mod distance;
|
mod distance;
|
||||||
mod ends_with;
|
mod ends_with;
|
||||||
|
mod escape_glob;
|
||||||
mod expand;
|
mod expand;
|
||||||
mod index_of;
|
mod index_of;
|
||||||
mod join;
|
mod join;
|
||||||
@ -17,6 +18,7 @@ pub use case::*;
|
|||||||
pub use contains::SubCommand as StrContains;
|
pub use contains::SubCommand as StrContains;
|
||||||
pub use distance::SubCommand as StrDistance;
|
pub use distance::SubCommand as StrDistance;
|
||||||
pub use ends_with::SubCommand as StrEndswith;
|
pub use ends_with::SubCommand as StrEndswith;
|
||||||
|
pub use escape_glob::SubCommand as StrEscapeGlob;
|
||||||
pub use expand::SubCommand as StrExpand;
|
pub use expand::SubCommand as StrExpand;
|
||||||
pub use index_of::SubCommand as StrIndexOf;
|
pub use index_of::SubCommand as StrIndexOf;
|
||||||
pub use join::*;
|
pub use join::*;
|
||||||
|
Loading…
Reference in New Issue
Block a user