mirror of
https://github.com/nushell/nushell.git
synced 2025-07-08 10:27:47 +02:00
35798ce0cc
# Description This PR changes some help text to try and clarify how `register` works when using from `nu -c`. # User-Facing Changes _(List of all changes that impact the user experience here. This helps us keep track of breaking changes.)_ # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date.
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,
|
|
},
|
|
]
|
|
}
|
|
}
|