forked from extern/nushell
5b01685fc3
# Description This updates all the positional arguments (except with `--features=dataframe` or `--features=extra`) to start with an uppercase letter and end with a period. Part of #5066, specifically [this comment](/nushell/nushell/issues/5066#issuecomment-1421528910) Some arguments had example data removed from them because it also appears in the examples. There are other inconsistencies in positional arguments I noticed while making the tests pass which I will bring up in #5066. # User-Facing Changes Positional arguments are now consistent # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting Automatic documentation updates
73 lines
2.1 KiB
Rust
73 lines
2.1 KiB
Rust
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{Category, Example, PipelineData, ShellError, Signature, SyntaxShape, Type};
|
|
|
|
#[derive(Clone)]
|
|
pub struct Register;
|
|
|
|
impl Command for Register {
|
|
fn name(&self) -> &str {
|
|
"register"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Register a plugin."
|
|
}
|
|
|
|
fn signature(&self) -> nu_protocol::Signature {
|
|
Signature::build("register")
|
|
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
|
|
.required(
|
|
"plugin",
|
|
SyntaxShape::Filepath,
|
|
"Path of executable for plugin.",
|
|
)
|
|
.optional(
|
|
"signature",
|
|
SyntaxShape::Any,
|
|
"Block with signature description as json object.",
|
|
)
|
|
.named(
|
|
"shell",
|
|
SyntaxShape::Filepath,
|
|
"path of shell used to run plugin (cmd, sh, python, etc)",
|
|
Some('s'),
|
|
)
|
|
.category(Category::Core)
|
|
}
|
|
|
|
fn extra_usage(&self) -> &str {
|
|
r#"This command is a parser keyword. For details, check:
|
|
https://www.nushell.sh/book/thinking_in_nu.html"#
|
|
}
|
|
|
|
fn is_parser_keyword(&self) -> bool {
|
|
true
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
_call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
Ok(PipelineData::empty())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Register `nu_plugin_query` plugin from ~/.cargo/bin/ dir",
|
|
example: r#"register ~/.cargo/bin/nu_plugin_query"#,
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "Register `nu_plugin_query` plugin from `nu -c` (writes/updates $nu.plugin-path)",
|
|
example: r#"let plugin = ((which nu).path.0 | path dirname | path join 'nu_plugin_query'); nu -c $'register ($plugin); version'"#,
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
}
|