198aedb6c2
<!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience. --> The derive macros provided by #13031 are very useful for plugin authors. In this PR I made use of these macros for two commands. # 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` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` to run the tests for the standard library > **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 > ``` --> - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # 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. --> This Example usage could be highlighted in the changelog for plugin authors as this is probably very useful for them.
63 lines
1.8 KiB
Rust
63 lines
1.8 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{Category, IntoValue, LabeledError, Signature, SyntaxShape, Value};
|
|
|
|
use crate::ExamplePlugin;
|
|
|
|
pub struct Two;
|
|
|
|
impl SimplePluginCommand for Two {
|
|
type Plugin = ExamplePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"example two"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Plugin test example 2. Returns list of records"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
// The signature defines the usage of the command inside Nu, and also automatically
|
|
// generates its help page.
|
|
Signature::build(self.name())
|
|
.required("a", SyntaxShape::Int, "required integer value")
|
|
.required("b", SyntaxShape::String, "required string value")
|
|
.switch("flag", "a flag for the signature", Some('f'))
|
|
.optional("opt", SyntaxShape::Int, "Optional number")
|
|
.named("named", SyntaxShape::String, "named string", Some('n'))
|
|
.rest("rest", SyntaxShape::String, "rest value string")
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
plugin: &ExamplePlugin,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
plugin.print_values(2, call, input)?;
|
|
|
|
// Use the IntoValue derive macro and trait to easily design output data.
|
|
#[derive(IntoValue)]
|
|
struct Output {
|
|
one: i64,
|
|
two: i64,
|
|
three: i64,
|
|
}
|
|
|
|
let vals = (0..10i64)
|
|
.map(|i| {
|
|
Output {
|
|
one: i,
|
|
two: 2 * i,
|
|
three: 3 * i,
|
|
}
|
|
.into_value(call.head)
|
|
})
|
|
.collect();
|
|
|
|
Ok(Value::list(vals, call.head))
|
|
}
|
|
}
|