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.
58 lines
1.6 KiB
Rust
58 lines
1.6 KiB
Rust
use nu_engine::{command_prelude::*, get_full_help};
|
|
|
|
#[derive(Clone)]
|
|
pub struct PathCommand;
|
|
|
|
impl Command for PathCommand {
|
|
fn name(&self) -> &str {
|
|
"path"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("path")
|
|
.input_output_types(vec![(Type::Nothing, Type::String)])
|
|
.category(Category::Path)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Explore and manipulate paths."
|
|
}
|
|
|
|
fn extra_usage(&self) -> &str {
|
|
r#"You must use one of the following subcommands. Using this command as-is will only produce this help message.
|
|
|
|
There are three ways to represent a path:
|
|
|
|
* As a path literal, e.g., '/home/viking/spam.txt'
|
|
* As a structured path: a table with 'parent', 'stem', and 'extension' (and
|
|
* 'prefix' on Windows) columns. This format is produced by the 'path parse'
|
|
subcommand.
|
|
* As a list of path parts, e.g., '[ / home viking spam.txt ]'. Splitting into
|
|
parts is done by the `path split` command.
|
|
|
|
All subcommands accept all three variants as an input. Furthermore, the 'path
|
|
join' subcommand can be used to join the structured path or path parts back into
|
|
the path literal."#
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
Ok(Value::string(
|
|
get_full_help(
|
|
&PathCommand.signature(),
|
|
&PathCommand.examples(),
|
|
engine_state,
|
|
stack,
|
|
self.is_parser_keyword(),
|
|
),
|
|
call.head,
|
|
)
|
|
.into_pipeline_data())
|
|
}
|
|
}
|