mirror of
https://github.com/nushell/nushell.git
synced 2025-05-30 14:50:02 +02:00
bb6335830a
Path commands were incorrectly located in the default category... This PR moves all of the *Path* commands into their own Category called *Path*
63 lines
1.8 KiB
Rust
63 lines
1.8 KiB
Rust
use nu_engine::get_full_help;
|
|
use nu_protocol::{
|
|
ast::Call,
|
|
engine::{Command, EngineState, Stack},
|
|
Category, IntoPipelineData, PipelineData, ShellError, Signature, Type, Value,
|
|
};
|
|
|
|
#[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 {
|
|
val: get_full_help(
|
|
&PathCommand.signature(),
|
|
&PathCommand.examples(),
|
|
engine_state,
|
|
stack,
|
|
self.is_parser_keyword(),
|
|
),
|
|
span: call.head,
|
|
}
|
|
.into_pipeline_data())
|
|
}
|
|
}
|