mirror of
https://github.com/nushell/nushell.git
synced 2025-06-15 06:26:57 +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
76 lines
1.6 KiB
Rust
76 lines
1.6 KiB
Rust
use super::ViewCommand;
|
|
use crate::{
|
|
nu_common::collect_input,
|
|
views::{Orientation, RecordView, ViewConfig},
|
|
};
|
|
use anyhow::Result;
|
|
use nu_protocol::{
|
|
engine::{EngineState, Stack},
|
|
Value,
|
|
};
|
|
|
|
#[derive(Debug, Default, Clone)]
|
|
pub struct TableCmd {
|
|
// todo: add arguments to override config right from CMD
|
|
settings: TableSettings,
|
|
}
|
|
|
|
#[derive(Debug, Default, Clone)]
|
|
struct TableSettings {
|
|
orientation: Option<Orientation>,
|
|
turn_on_cursor_mode: bool,
|
|
}
|
|
|
|
impl TableCmd {
|
|
pub fn new() -> Self {
|
|
Self::default()
|
|
}
|
|
|
|
pub const NAME: &'static str = "table";
|
|
}
|
|
|
|
impl ViewCommand for TableCmd {
|
|
type View = RecordView;
|
|
|
|
fn name(&self) -> &'static str {
|
|
Self::NAME
|
|
}
|
|
|
|
fn description(&self) -> &'static str {
|
|
""
|
|
}
|
|
|
|
fn parse(&mut self, _: &str) -> Result<()> {
|
|
Ok(())
|
|
}
|
|
|
|
fn spawn(
|
|
&mut self,
|
|
_: &EngineState,
|
|
_: &mut Stack,
|
|
value: Option<Value>,
|
|
config: &ViewConfig,
|
|
) -> Result<Self::View> {
|
|
let value = value.unwrap_or_default();
|
|
let is_record = matches!(value, Value::Record { .. });
|
|
|
|
let (columns, data) = collect_input(value)?;
|
|
|
|
let mut view = RecordView::new(columns, data, config.explore_config.clone());
|
|
|
|
if is_record {
|
|
view.set_top_layer_orientation(Orientation::Left);
|
|
}
|
|
|
|
if let Some(o) = self.settings.orientation {
|
|
view.set_top_layer_orientation(o);
|
|
}
|
|
|
|
if self.settings.turn_on_cursor_mode {
|
|
view.set_cursor_mode();
|
|
}
|
|
|
|
Ok(view)
|
|
}
|
|
}
|