1867bb1a88
# Description
Possible fix of #11456
This PR fixes a bug where builtin commands did not respect the logic of
dynamically passed boolean flags. The reason is
[has_flag](6f59abaf43/crates/nu-protocol/src/ast/call.rs (L204C5-L212C6))
method did not evaluate and take into consideration expression used with
flag.
To address this issue a solution is proposed:
1. `has_flag` method is moved to `CallExt` and new logic to evaluate
expression and check if it is a boolean value is added
2. `has_flag_const` method is added to `CallExt` which is a constant
version of `has_flag`
3. `has_named` method is added to `Call` which is basically the old
logic of `has_flag`
4. All usages of `has_flag` in code are updated, mostly to pass
`engine_state` and `stack` to new `has_flag`. In `run_const` commands it
is replaced with `has_flag_const`. And in a few select places: parser,
`to nuon` and `into string` old logic via `has_named` is used.
# User-Facing Changes
Explicit values of boolean flags are now respected in builtin commands.
Before:
After:
Another example:
Before:
After:
# Tests + Formatting
Added test reproducing some variants of original issue.
109 lines
3.2 KiB
Rust
109 lines
3.2 KiB
Rust
use std::collections::VecDeque;
|
|
|
|
use nu_engine::env::current_dir;
|
|
use nu_engine::CallExt;
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{
|
|
Category, Example, IntoInterruptiblePipelineData, PipelineData, ShellError, Signature,
|
|
SyntaxShape, Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct Mkdir;
|
|
|
|
impl Command for Mkdir {
|
|
fn name(&self) -> &str {
|
|
"mkdir"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("mkdir")
|
|
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
|
|
.rest(
|
|
"rest",
|
|
SyntaxShape::Directory,
|
|
"The name(s) of the path(s) to create.",
|
|
)
|
|
.switch("verbose", "print created path(s).", Some('v'))
|
|
.category(Category::FileSystem)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Make directories, creates intermediary directories as required."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["directory", "folder", "create", "make_dirs"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let path = current_dir(engine_state, stack)?;
|
|
let mut directories = call
|
|
.rest::<String>(engine_state, stack, 0)?
|
|
.into_iter()
|
|
.map(|dir| path.join(dir))
|
|
.peekable();
|
|
|
|
let is_verbose = call.has_flag(engine_state, stack, "verbose")?;
|
|
let mut stream: VecDeque<Value> = VecDeque::new();
|
|
|
|
if directories.peek().is_none() {
|
|
return Err(ShellError::MissingParameter {
|
|
param_name: "requires directory paths".to_string(),
|
|
span: call.head,
|
|
});
|
|
}
|
|
|
|
for (i, dir) in directories.enumerate() {
|
|
let span = call
|
|
.positional_nth(i)
|
|
.expect("already checked through directories")
|
|
.span;
|
|
let dir_res = std::fs::create_dir_all(&dir);
|
|
|
|
if let Err(reason) = dir_res {
|
|
return Err(ShellError::CreateNotPossible {
|
|
msg: format!("failed to create directory: {reason}"),
|
|
span: call
|
|
.positional_nth(i)
|
|
.expect("already checked through directories")
|
|
.span,
|
|
});
|
|
}
|
|
|
|
if is_verbose {
|
|
let val = format!("{:}", dir.to_string_lossy());
|
|
stream.push_back(Value::string(val, span));
|
|
}
|
|
}
|
|
|
|
stream
|
|
.into_iter()
|
|
.into_pipeline_data(engine_state.ctrlc.clone())
|
|
.print_not_formatted(engine_state, false, true)?;
|
|
Ok(PipelineData::empty())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Make a directory named foo",
|
|
example: "mkdir foo",
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "Make multiple directories and show the paths created",
|
|
example: "mkdir -v foo/bar foo2",
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
}
|