forked from extern/nushell
c747ec75c9
# Description
When implementing a `Command`, one must also import all the types
present in the function signatures for `Command`. This makes it so that
we often import the same set of types in each command implementation
file. E.g., something like this:
```rust
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{
record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, PipelineData,
ShellError, Signature, Span, Type, Value,
};
```
This PR adds the `nu_engine::command_prelude` module which contains the
necessary and commonly used types to implement a `Command`:
```rust
// command_prelude.rs
pub use crate::CallExt;
pub use nu_protocol::{
ast::{Call, CellPath},
engine::{Command, EngineState, Stack},
record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, IntoSpanned,
PipelineData, Record, ShellError, Signature, Span, Spanned, SyntaxShape, Type, Value,
};
```
This should reduce the boilerplate needed to implement a command and
also gives us a place to track the breadth of the `Command` API. I tried
to be conservative with what went into the prelude modules, since it
might be hard/annoying to remove items from the prelude in the future.
Let me know if something should be included or excluded.
105 lines
2.7 KiB
Rust
105 lines
2.7 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
use std::path::PathBuf;
|
|
use uu_mkdir::mkdir;
|
|
#[cfg(not(windows))]
|
|
use uucore::mode;
|
|
|
|
#[derive(Clone)]
|
|
pub struct UMkdir;
|
|
|
|
const IS_RECURSIVE: bool = true;
|
|
const DEFAULT_MODE: u32 = 0o777;
|
|
|
|
#[cfg(not(windows))]
|
|
fn get_mode() -> u32 {
|
|
DEFAULT_MODE - mode::get_umask()
|
|
}
|
|
|
|
#[cfg(windows)]
|
|
fn get_mode() -> u32 {
|
|
DEFAULT_MODE
|
|
}
|
|
|
|
impl Command for UMkdir {
|
|
fn name(&self) -> &str {
|
|
"mkdir"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Create directories, with intermediary directories if required using uutils/coreutils mkdir."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["directory", "folder", "create", "make_dirs", "coreutils"]
|
|
}
|
|
|
|
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 a message for each created directory.",
|
|
Some('v'),
|
|
)
|
|
.category(Category::FileSystem)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let mut directories = call
|
|
.rest::<String>(engine_state, stack, 0)?
|
|
.into_iter()
|
|
.map(PathBuf::from)
|
|
.peekable();
|
|
|
|
let is_verbose = call.has_flag(engine_state, stack, "verbose")?;
|
|
|
|
if directories.peek().is_none() {
|
|
return Err(ShellError::MissingParameter {
|
|
param_name: "requires directory paths".to_string(),
|
|
span: call.head,
|
|
});
|
|
}
|
|
|
|
for dir in directories {
|
|
if let Err(error) = mkdir(&dir, IS_RECURSIVE, get_mode(), is_verbose) {
|
|
return Err(ShellError::GenericError {
|
|
error: format!("{}", error),
|
|
msg: format!("{}", error),
|
|
span: None,
|
|
help: None,
|
|
inner: vec![],
|
|
});
|
|
}
|
|
}
|
|
|
|
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,
|
|
},
|
|
]
|
|
}
|
|
}
|