extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-06-30 22:50:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

A few help cleanups (#372)

Browse Source
This commit is contained in:
JT
2021-11-28 07:16:20 +13:00
committed by GitHub
parent 63c3d19c67
commit f7f8b0dbff
4 changed files with 99 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
crates/nu-engine/src/documentation.rs
View File

@ -1,5 +1,7 @@
use itertools::Itertools;
use nu_protocol::{engine::EngineState, Example, Signature, Span, Value};
use nu_protocol::{
engine::EngineState, Example, PositionalArg, Signature, Span, SyntaxShape, Value,
};
use std::collections::HashMap;
const COMMANDS_DOCS_DIR: &str = "docs/commands";
@ -171,10 +173,10 @@ pub fn get_documentation(
one_liner.push(' ');
for positional in &sig.required_positional {
one_liner.push_str(&format!("<{}> ", positional.name));
one_liner.push_str(&get_positional_short_name(positional, true));
}
for positional in &sig.optional_positional {
one_liner.push_str(&format!("({}) ", positional.name));
one_liner.push_str(&get_positional_short_name(positional, false));
}
if sig.rest_positional.is_some() {
@ -204,10 +206,13 @@ pub fn get_documentation(
{
long_desc.push_str("\nParameters:\n");
for positional in &sig.required_positional {
long_desc.push_str(&format!(" <{}> {}\n", positional.name, positional.desc));
long_desc.push_str(&format!(" {}: {}\n", positional.name, positional.desc));
}
for positional in &sig.optional_positional {
long_desc.push_str(&format!(" ({}) {}\n", positional.name, positional.desc));
long_desc.push_str(&format!(
" (optional) {}: {}\n",
positional.name, positional.desc
));
}
if let Some(rest_positional) = &sig.rest_positional {
@ -241,6 +246,25 @@ pub fn get_documentation(
long_desc
}
fn get_positional_short_name(arg: &PositionalArg, is_required: bool) -> String {
match &arg.shape {
SyntaxShape::Keyword(name, ..) => {
if is_required {
format!("{} <{}> ", String::from_utf8_lossy(name), arg.name)
} else {
format!("({} <{}>) ", String::from_utf8_lossy(name), arg.name)
}
}
_ => {
if is_required {
format!("<{}> ", arg.name)
} else {
format!("({}) ", arg.name)
}
}
}
}
fn get_flags_section(signature: &Signature) -> String {
let mut long_desc = String::new();
long_desc.push_str("\nFlags:\n");