extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-07-09 02:48:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

Allow composing help message from two parts (#3124)

Browse Source 
* Split help message into brief and full help

Demonstrate on ansi command

Brief help is printed when running `help commands` so it doesn't clutter
the table. Full help is printed when normal help message is requested
(e.g., `help ansi`, `ansi --help`, etc.).

* Split long command descriptions

Some are not split, just edited to be shorter.

* Capitalize the usage of all commands

* Make sure every usage ends with dot

* Fix random typo
This commit is contained in:
Jakub Žádník
2021-03-08 01:57:58 +02:00
committed by GitHub
parent 7b8c2c232f
commit 49a9107e0f
52 changed files with 110 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -11,6 +11,7 @@ const COMMANDS_DOCS_DIR: &str = "docs/commands";
pub struct DocumentationConfig {
no_subcommands: bool,
no_color: bool,
brief: bool,
}
impl Default for DocumentationConfig {
@ -18,6 +19,7 @@ impl Default for DocumentationConfig {
DocumentationConfig {
no_subcommands: false,
no_color: false,
brief: false,
}
}
}
@ -49,6 +51,7 @@ fn generate_doc(name: &str, scope: &Scope) -> IndexMap<String, Value> {
&DocumentationConfig {
no_subcommands: true,
no_color: true,
brief: false,
},
))
.into_untagged_value(),
@ -70,7 +73,7 @@ pub fn generate_docs(scope: &Scope) -> Value {
if cmap.contains_key(*parent_name) {
let sub_names = cmap
.get_mut(*parent_name)
.expect("Expected a entry for parent");
.expect("Expected an entry for parent");
sub_names.push(name.to_owned());
}
} else {
@ -135,6 +138,12 @@ pub fn get_documentation(
long_desc.push_str("\n\n");
}
let extra_usage = if config.brief { "" } else { &cmd.extra_usage() };
if !extra_usage.is_empty() {
long_desc.push_str(extra_usage);
long_desc.push_str("\n\n");
}
let mut subcommands = vec![];
if !config.no_subcommands {
for name in scope.get_command_names() {
@ -296,6 +305,18 @@ fn get_flags_section(signature: &Signature) -> String {
long_desc
}
pub fn get_help(cmd: &dyn WholeStreamCommand, scope: &Scope) -> String {
pub fn get_brief_help(cmd: &dyn WholeStreamCommand, scope: &Scope) -> String {
get_documentation(
cmd,
scope,
&DocumentationConfig {
no_subcommands: false,
no_color: false,
brief: true,
},
)
}
pub fn get_full_help(cmd: &dyn WholeStreamCommand, scope: &Scope) -> String {
get_documentation(cmd, scope, &DocumentationConfig::default())
}