mirror of
https://github.com/nushell/nushell.git
synced 2025-08-05 05:39:34 +02:00
95b78eee25
# Description
The meaning of the word usage is specific to describing how a command
function is *used* and not a synonym for general description. Usage can
be used to describe the SYNOPSIS or EXAMPLES sections of a man page
where the permitted argument combinations are shown or example *uses*
are given.
Let's not confuse people and call it what it is a description.
Our `help` command already creates its own *Usage* section based on the
available arguments and doesn't refer to the description with usage.
# User-Facing Changes
`help commands` and `scope commands` will now use `description` or
`extra_description`
`usage`-> `description`
`extra_usage` -> `extra_description`
Breaking change in the plugin protocol:
In the signature record communicated with the engine.
`usage`-> `description`
`extra_usage` -> `extra_description`
The same rename also takes place for the methods on
`SimplePluginCommand` and `PluginCommand`
# Tests + Formatting
- Updated plugin protocol specific changes
# After Submitting
- [ ] update plugin protocol doc
57 lines
1.0 KiB
Rust
57 lines
1.0 KiB
Rust
use crate::views::ViewConfig;
|
|
|
|
use super::pager::{Pager, Transition};
|
|
use anyhow::Result;
|
|
use nu_protocol::{
|
|
engine::{EngineState, Stack},
|
|
Value,
|
|
};
|
|
|
|
mod expand;
|
|
mod help;
|
|
mod nu;
|
|
mod quit;
|
|
mod table;
|
|
mod r#try;
|
|
|
|
pub use expand::ExpandCmd;
|
|
pub use help::HelpCmd;
|
|
pub use nu::NuCmd;
|
|
pub use quit::QuitCmd;
|
|
pub use r#try::TryCmd;
|
|
pub use table::TableCmd;
|
|
|
|
pub trait SimpleCommand {
|
|
fn name(&self) -> &'static str;
|
|
|
|
fn description(&self) -> &'static str;
|
|
|
|
fn parse(&mut self, args: &str) -> Result<()>;
|
|
|
|
fn react(
|
|
&mut self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
pager: &mut Pager<'_>,
|
|
value: Option<Value>,
|
|
) -> Result<Transition>;
|
|
}
|
|
|
|
pub trait ViewCommand {
|
|
type View;
|
|
|
|
fn name(&self) -> &'static str;
|
|
|
|
fn description(&self) -> &'static str;
|
|
|
|
fn parse(&mut self, args: &str) -> Result<()>;
|
|
|
|
fn spawn(
|
|
&mut self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
value: Option<Value>,
|
|
config: &ViewConfig,
|
|
) -> Result<Self::View>;
|
|
}
|