mirror of
https://github.com/nushell/nushell.git
synced 2025-04-04 14:40:43 +02:00
efe25e3f58
# Description This makes `LabeledError` much more capable of representing close to everything a `miette::Diagnostic` can, including `ShellError`, and allows plugins to generate multiple error spans, codes, help, etc. `LabeledError` is now embeddable within `ShellError` as a transparent variant. This could also be used to improve `error make` and `try/catch` to reflect `LabeledError` exactly in the future. Also cleaned up some errors in existing plugins. # User-Facing Changes Breaking change for plugins. Nicer errors for users.
39 lines
1.1 KiB
Rust
39 lines
1.1 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{Category, LabeledError, PluginSignature, Value};
|
|
|
|
use crate::Example;
|
|
|
|
pub struct Main;
|
|
|
|
impl SimplePluginCommand for Main {
|
|
type Plugin = Example;
|
|
|
|
fn signature(&self) -> PluginSignature {
|
|
PluginSignature::build("example")
|
|
.usage("Example commands for Nushell plugins")
|
|
.extra_usage(
|
|
r#"
|
|
The `example` plugin demonstrates usage of the Nushell plugin API.
|
|
|
|
Several commands provided to test and demonstrate different capabilities of
|
|
plugins exposed through the API. None of these commands are intended to be
|
|
particularly useful.
|
|
"#
|
|
.trim(),
|
|
)
|
|
.search_terms(vec!["example".into()])
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &Self::Plugin,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
Err(LabeledError::new("No subcommand provided")
|
|
.with_label("add --help to see a list of subcommands", call.head))
|
|
}
|
|
}
|