forked from extern/nushell
Parameter defaults to $nu.scope.commands (#9152)
(*third* try at posting this PR, #9104, like #9084, got polluted with unrelated commits. I'm never going to pull from the github feature branch again!) # 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. --> Show parameter defaults in scope command signature, where they're available for display by help. per https://github.com/nushell/nushell/issues/8928. I found unexpected ramifications in one completer (NuHelpCompleter) and plugins, which both use the flag-formatting routine from builtin help. For the moment I made the minimum necessary changes to get the mainline scenario to pass tests and run. But we should circle back on what to do with plugins and help completer.. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> 1. New `parameter_default` column to `signatures` table in `$nu.scope.commands` It is populated with whatever parameters can be defaulted: currently positional args and named flags. 2. Built in help (both `help <command>` and `<command> --help` will display the defaults 3. Help completer will display defaults for flags, but not for positionals. Example: A custom command with some default parameters: ``` 〉cat ~/work/dflts.nu # sample function to show defaults in help export def main [ arg1: string # mandatory positional arg2:string=abc # optional positional --switch # no default here --named:int # named flag, no default --other:string=def # flag --hard:record<foo:int bar:string, bas:bool> # default can be compound type = {foo:22, bar:"other worlds", bas:false} ] { {arg1: $arg1, arg2: $arg2, switch: $switch, named: $named, other: $other, hard: $hard, } } 〉use ~/work/dflts.nu 〉$nu.scope.commands | where name == 'dflts' | get signatures.0.any | reject short_flag description custom_completion ╭───┬────────────────┬────────────────┬──────────────────────────────────────────┬─────────────┬───────────────────────────╮ │ # │ parameter_name │ parameter_type │ syntax_shape │ is_optional │ parameter_default │ ├───┼────────────────┼────────────────┼──────────────────────────────────────────┼─────────────┼───────────────────────────┤ │ 0 │ │ input │ any │ false │ │ │ 1 │ arg1 │ positional │ string │ false │ │ │ 2 │ arg2 │ positional │ string │ true │ abc │ │ 3 │ switch │ switch │ │ true │ │ │ 4 │ named │ named │ int │ true │ │ │ 5 │ other │ named │ string │ true │ def │ │ 6 │ hard │ named │ record<foo: int, bar: string, bas: bool> │ true │ ╭───────┬───────────────╮ │ │ │ │ │ │ │ │ foo │ 22 │ │ │ │ │ │ │ │ │ bar │ other worlds │ │ │ │ │ │ │ │ │ bas │ false │ │ │ │ │ │ │ │ ╰───────┴───────────────╯ │ │ 7 │ │ output │ any │ false │ │ ╰───┴────────────────┴────────────────┴──────────────────────────────────────────┴─────────────┴───────────────────────────╯ 〉help dflts sample function to show defaults in help Usage: > dflts {flags} <arg1> (arg2) Flags: --switch - switch -- no default here --named <Int> - named flag, typed, but no default --other <String> - flag with default (default: 'def') --hard <Record([("foo", Int), ("bar", String), ("bas", Boolean)])> - default can be compound type (default: {foo: 22, bar: 'other worlds', bas: false}) -h, --help - Display the help message for this command Parameters: arg1 <string>: mandatory positional arg2 <string>: optional positional (optional, default: 'abc') ``` Compared to (relevant bits of) help output previously: ``` Flags: -h, --help - Display the help message for this command -, --switch - no default here -, --named <int> - named flag, no default -, --other <string> - flag -, --hard <record<foo: int, bar: string, bas: bool>> - default can be compound type Signatures: <any> | dflts <string> <string> -> <any> Parameters: arg1 <string>: mandatory positional (optional) arg2 <string>: optional positional ``` # 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 -A clippy::needless_collect -A clippy::result_large_err` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass - `cargo run -- crates/nu-std/tests/run.nu` 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 > [x] toolkit check pr > ``` --> # 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 commit is contained in:
Bob Hyman
GitHub
parent
e735d0c561
commit
9e9fe83bfd
@ -57,7 +57,9 @@ impl NuHelpCompleter {
|
||||
let _ = write!(long_desc, "Usage:\r\n > {}\r\n", sig.call_signature());
|
||||
|
||||
if !sig.named.is_empty() {
|
||||
long_desc.push_str(&get_flags_section(sig))
|
||||
long_desc.push_str(&get_flags_section(sig, |v| {
|
||||
v.into_string_parsable(", ", &self.0.config)
|
||||
}))
|
||||
}
|
||||
|
||||
if !sig.required_positional.is_empty()
|
||||
@ -69,10 +71,18 @@ impl NuHelpCompleter {
|
||||
let _ = write!(long_desc, " {}: {}\r\n", positional.name, positional.desc);
|
||||
}
|
||||
for positional in &sig.optional_positional {
|
||||
let opt_suffix = if let Some(value) = &positional.default_value {
|
||||
format!(
|
||||
" (optional, default: {})",
|
||||
&value.into_string_parsable(", ", &self.0.config),
|
||||
)
|
||||
} else {
|
||||
(" (optional)").to_string()
|
||||
};
|
||||
let _ = write!(
|
||||
long_desc,
|
||||
" (optional) {}: {}\r\n",
|
||||
positional.name, positional.desc
|
||||
" (optional) {}: {}{}\r\n",
|
||||
positional.name, positional.desc, opt_suffix
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@ -72,8 +72,8 @@ fn test_no_color_flag() {
|
||||
);
|
||||
assert_eq!(
|
||||
actual.out,
|
||||
r"<html><style>body { background-color:white;color:black; }</style><body>Change directory.<br><br>Usage:<br> > cd (path) <br><br>Flags:<br> -h, --help - Display the help message for this command<br><br>Signatures:<br> <nothing> | cd <string?> -> <nothing><br> <string> | cd <string?> -> <nothing><br><br>Parameters:<br> (optional) path <directory>: the path to change to<br><br>Examples:<br> Change to your home directory<br> > cd ~<br><br> Change to a directory via abbreviations<br> > cd d/s/9<br><br> Change to the previous working directory ($OLDPWD)<br> > cd -<br><br></body></html>"
|
||||
);
|
||||
r"<html><style>body { background-color:white;color:black; }</style><body>Change directory.<br><br>Usage:<br> > cd (path) <br><br>Flags:<br> -h, --help - Display the help message for this command<br><br>Signatures:<br> <nothing> | cd <string?> -> <nothing><br> <string> | cd <string?> -> <nothing><br><br>Parameters:<br> path <directory>: the path to change to (optional)<br><br>Examples:<br> Change to your home directory<br> > cd ~<br><br> Change to a directory via abbreviations<br> > cd d/s/9<br><br> Change to the previous working directory ($OLDPWD)<br> > cd -<br><br></body></html>"
|
||||
)
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@ -35,6 +35,26 @@ struct DocumentationConfig {
|
||||
brief: bool,
|
||||
}
|
||||
|
||||
// Utility returns nu-highlighted string
|
||||
fn nu_highlight_string(code_string: &str, engine_state: &EngineState, stack: &mut Stack) -> String {
|
||||
if let Some(highlighter) = engine_state.find_decl(b"nu-highlight", &[]) {
|
||||
let decl = engine_state.get_decl(highlighter);
|
||||
|
||||
if let Ok(output) = decl.run(
|
||||
engine_state,
|
||||
stack,
|
||||
&Call::new(Span::unknown()),
|
||||
Value::string(code_string, Span::unknown()).into_pipeline_data(),
|
||||
) {
|
||||
let result = output.into_value(Span::unknown());
|
||||
if let Ok(s) = result.as_string() {
|
||||
return s; // successfully highlighted string
|
||||
}
|
||||
}
|
||||
}
|
||||
code_string.to_string()
|
||||
}
|
||||
|
||||
#[allow(clippy::cognitive_complexity)]
|
||||
fn get_documentation(
|
||||
sig: &Signature,
|
||||
@ -45,9 +65,11 @@ fn get_documentation(
|
||||
is_parser_keyword: bool,
|
||||
) -> String {
|
||||
// Create ansi colors
|
||||
//todo make these configurable -- pull from enginestate.config
|
||||
const G: &str = "\x1b[32m"; // green
|
||||
const C: &str = "\x1b[36m"; // cyan
|
||||
const BB: &str = "\x1b[1;34m"; // bold blue
|
||||
// was const BB: &str = "\x1b[1;34m"; // bold blue
|
||||
const BB: &str = "\x1b[94m"; // light blue (nobold, should be bolding the *names*)
|
||||
const RESET: &str = "\x1b[0m"; // reset
|
||||
|
||||
let cmd_name = &sig.name;
|
||||
@ -98,7 +120,13 @@ fn get_documentation(
|
||||
}
|
||||
|
||||
if !sig.named.is_empty() {
|
||||
long_desc.push_str(&get_flags_section(sig))
|
||||
long_desc.push_str(&get_flags_section(sig, |v| {
|
||||
nu_highlight_string(
|
||||
&v.into_string_parsable(", ", &engine_state.config),
|
||||
engine_state,
|
||||
stack,
|
||||
)
|
||||
}))
|
||||
}
|
||||
|
||||
if !is_parser_keyword && !sig.input_output_types.is_empty() {
|
||||
@ -142,18 +170,32 @@ fn get_documentation(
|
||||
let text = match &positional.shape {
|
||||
SyntaxShape::Keyword(kw, shape) => {
|
||||
format!(
|
||||
" (optional) {C}\"{}\" + {RESET}<{BB}{}{RESET}>: {}",
|
||||
" {C}\"{}\" + {RESET}<{BB}{}{RESET}>: {} (optional)",
|
||||
String::from_utf8_lossy(kw),
|
||||
document_shape(*shape.clone()),
|
||||
positional.desc
|
||||
)
|
||||
}
|
||||
_ => {
|
||||
let opt_suffix = if let Some(value) = &positional.default_value {
|
||||
format!(
|
||||
" (optional, default: {})",
|
||||
nu_highlight_string(
|
||||
&value.into_string_parsable(", ", &engine_state.config),
|
||||
engine_state,
|
||||
stack
|
||||
)
|
||||
)
|
||||
} else {
|
||||
(" (optional)").to_string()
|
||||
};
|
||||
|
||||
format!(
|
||||
" (optional) {C}{}{RESET} <{BB}{}{RESET}>: {}",
|
||||
" {C}{}{RESET} <{BB}{}{RESET}>: {}{}",
|
||||
positional.name,
|
||||
document_shape(positional.shape.clone()),
|
||||
positional.desc
|
||||
positional.desc,
|
||||
opt_suffix,
|
||||
)
|
||||
}
|
||||
};
|
||||
@ -254,21 +296,35 @@ pub fn document_shape(shape: SyntaxShape) -> SyntaxShape {
|
||||
}
|
||||
}
|
||||
|
||||
pub fn get_flags_section(signature: &Signature) -> String {
|
||||
pub fn get_flags_section<F>(
|
||||
signature: &Signature,
|
||||
mut value_formatter: F, // format default Value (because some calls cant access config or nu-highlight)
|
||||
) -> String
|
||||
where
|
||||
F: FnMut(&nu_protocol::Value) -> String,
|
||||
{
|
||||
//todo make these configurable -- pull from enginestate.config
|
||||
const G: &str = "\x1b[32m"; // green
|
||||
const C: &str = "\x1b[36m"; // cyan
|
||||
const BB: &str = "\x1b[1;34m"; // bold blue
|
||||
// was const BB: &str = "\x1b[1;34m"; // bold blue
|
||||
const BB: &str = "\x1b[94m"; // light blue (nobold, should be bolding the *names*)
|
||||
const RESET: &str = "\x1b[0m"; // reset
|
||||
const D: &str = "\x1b[39m"; // default
|
||||
|
||||
let mut long_desc = String::new();
|
||||
let _ = write!(long_desc, "\n{G}Flags{RESET}:\n");
|
||||
for flag in &signature.named {
|
||||
let default_str = if let Some(value) = &flag.default_value {
|
||||
format!(" (default: {BB}{}{RESET})", &value_formatter(value))
|
||||
} else {
|
||||
"".to_string()
|
||||
};
|
||||
|
||||
let msg = if let Some(arg) = &flag.arg {
|
||||
if let Some(short) = flag.short {
|
||||
if flag.required {
|
||||
format!(
|
||||
" {C}-{}{}{RESET} (required parameter) {:?} - {}\n",
|
||||
" {C}-{}{}{RESET} (required parameter) {:?} - {}{}\n",
|
||||
short,
|
||||
if !flag.long.is_empty() {
|
||||
format!("{D},{RESET} {C}--{}", flag.long)
|
||||
@ -276,11 +332,12 @@ pub fn get_flags_section(signature: &Signature) -> String {
|
||||
"".into()
|
||||
},
|
||||
arg,
|
||||
flag.desc
|
||||
flag.desc,
|
||||
default_str,
|
||||
)
|
||||
} else {
|
||||
format!(
|
||||
" {C}-{}{}{RESET} <{BB}{:?}{RESET}> - {}\n",
|
||||
" {C}-{}{}{RESET} <{BB}{:?}{RESET}> - {}{}\n",
|
||||
short,
|
||||
if !flag.long.is_empty() {
|
||||
format!("{D},{RESET} {C}--{}", flag.long)
|
||||
@ -288,48 +345,51 @@ pub fn get_flags_section(signature: &Signature) -> String {
|
||||
"".into()
|
||||
},
|
||||
arg,
|
||||
flag.desc
|
||||
flag.desc,
|
||||
default_str,
|
||||
)
|
||||
}
|
||||
} else if flag.required {
|
||||
format!(
|
||||
" {C}--{}{RESET} (required parameter) <{BB}{:?}{RESET}> - {}\n",
|
||||
flag.long, arg, flag.desc
|
||||
" {C}--{}{RESET} (required parameter) <{BB}{:?}{RESET}> - {}{}\n",
|
||||
flag.long, arg, flag.desc, default_str,
|
||||
)
|
||||
} else {
|
||||
format!(
|
||||
" {C}--{}{RESET} <{BB}{:?}{RESET}> - {}\n",
|
||||
flag.long, arg, flag.desc
|
||||
" {C}--{}{RESET} <{BB}{:?}{RESET}> - {}{}\n",
|
||||
flag.long, arg, flag.desc, default_str,
|
||||
)
|
||||
}
|
||||
} else if let Some(short) = flag.short {
|
||||
if flag.required {
|
||||
format!(
|
||||
" {C}-{}{}{RESET} (required parameter) - {}\n",
|
||||
" {C}-{}{}{RESET} (required parameter) - {}{}\n",
|
||||
short,
|
||||
if !flag.long.is_empty() {
|
||||
format!("{D},{RESET} {C}--{}", flag.long)
|
||||
} else {
|
||||
"".into()
|
||||
},
|
||||
flag.desc
|
||||
flag.desc,
|
||||
default_str,
|
||||
)
|
||||
} else {
|
||||
format!(
|
||||
" {C}-{}{}{RESET} - {}\n",
|
||||
" {C}-{}{}{RESET} - {}{}\n",
|
||||
short,
|
||||
if !flag.long.is_empty() {
|
||||
format!("{D},{RESET} {C}--{}", flag.long)
|
||||
} else {
|
||||
"".into()
|
||||
},
|
||||
flag.desc
|
||||
flag.desc,
|
||||
default_str
|
||||
)
|
||||
}
|
||||
} else if flag.required {
|
||||
format!(
|
||||
" {C}--{}{RESET} (required parameter) - {}\n",
|
||||
flag.long, flag.desc
|
||||
" {C}--{}{RESET} (required parameter) - {}{}\n",
|
||||
flag.long, flag.desc, default_str,
|
||||
)
|
||||
} else {
|
||||
format!(" {C}--{}{RESET} - {}\n", flag.long, flag.desc)
|
||||
|
||||
@ -327,6 +327,7 @@ impl<'e, 's> ScopeData<'e, 's> {
|
||||
"short_flag".to_string(),
|
||||
"description".to_string(),
|
||||
"custom_completion".to_string(),
|
||||
"parameter_default".to_string(),
|
||||
];
|
||||
|
||||
// input
|
||||
@ -340,6 +341,7 @@ impl<'e, 's> ScopeData<'e, 's> {
|
||||
Value::nothing(span),
|
||||
Value::nothing(span),
|
||||
Value::nothing(span),
|
||||
Value::nothing(span),
|
||||
],
|
||||
span,
|
||||
});
|
||||
@ -357,6 +359,7 @@ impl<'e, 's> ScopeData<'e, 's> {
|
||||
extract_custom_completion_from_arg(self.engine_state, &req.shape),
|
||||
span,
|
||||
),
|
||||
Value::nothing(span),
|
||||
];
|
||||
|
||||
sig_records.push(Value::Record {
|
||||
@ -379,6 +382,11 @@ impl<'e, 's> ScopeData<'e, 's> {
|
||||
extract_custom_completion_from_arg(self.engine_state, &opt.shape),
|
||||
span,
|
||||
),
|
||||
if let Some(val) = &opt.default_value {
|
||||
val.clone()
|
||||
} else {
|
||||
Value::nothing(span)
|
||||
},
|
||||
];
|
||||
|
||||
sig_records.push(Value::Record {
|
||||
@ -401,6 +409,7 @@ impl<'e, 's> ScopeData<'e, 's> {
|
||||
extract_custom_completion_from_arg(self.engine_state, &rest.shape),
|
||||
span,
|
||||
),
|
||||
Value::nothing(span), // rest_positional does have default, but parser prohibits specifying it?!
|
||||
];
|
||||
|
||||
sig_records.push(Value::Record {
|
||||
@ -444,6 +453,11 @@ impl<'e, 's> ScopeData<'e, 's> {
|
||||
short_flag,
|
||||
Value::string(&named.desc, span),
|
||||
Value::string(custom_completion_command_name, span),
|
||||
if let Some(val) = &named.default_value {
|
||||
val.clone()
|
||||
} else {
|
||||
Value::nothing(span)
|
||||
},
|
||||
];
|
||||
|
||||
sig_records.push(Value::Record {
|
||||
@ -464,6 +478,7 @@ impl<'e, 's> ScopeData<'e, 's> {
|
||||
Value::nothing(span),
|
||||
Value::nothing(span),
|
||||
Value::nothing(span),
|
||||
Value::nothing(span),
|
||||
],
|
||||
span,
|
||||
});
|
||||
|
||||
@ -320,7 +320,7 @@ fn print_help(plugin: &mut impl Plugin, encoder: impl PluginEncoder) {
|
||||
}
|
||||
})
|
||||
.and_then(|_| {
|
||||
let flags = get_flags_section(&signature.sig);
|
||||
let flags = get_flags_section(&signature.sig, |v| format!("{:#?}", v));
|
||||
write!(help, "{flags}")
|
||||
})
|
||||
.and_then(|_| writeln!(help, "\nParameters:"))
|
||||
|
||||
@ -643,6 +643,36 @@ impl Value {
|
||||
format!("{self:#?}")
|
||||
}
|
||||
|
||||
/// Convert Value into a parsable string (quote strings)
|
||||
/// bugbug other, rarer types not handled
|
||||
|
||||
pub fn into_string_parsable(&self, separator: &str, config: &Config) -> String {
|
||||
match self {
|
||||
// give special treatment to the simple types to make them parsable
|
||||
Value::String { val, .. } => format!("'{}'", val),
|
||||
|
||||
// recurse back into this function for recursive formatting
|
||||
Value::List { vals: val, .. } => format!(
|
||||
"[{}]",
|
||||
val.iter()
|
||||
.map(|x| x.into_string_parsable(", ", config))
|
||||
.collect::<Vec<_>>()
|
||||
.join(separator)
|
||||
),
|
||||
Value::Record { cols, vals, .. } => format!(
|
||||
"{{{}}}",
|
||||
cols.iter()
|
||||
.zip(vals.iter())
|
||||
.map(|(x, y)| format!("{}: {}", x, y.into_string_parsable(", ", config)))
|
||||
.collect::<Vec<_>>()
|
||||
.join(separator)
|
||||
),
|
||||
|
||||
// defer to standard handling for types where standard representation is parsable
|
||||
_ => self.into_string(separator, config),
|
||||
}
|
||||
}
|
||||
|
||||
/// Convert Value into string. Note that Streams will be consumed.
|
||||
pub fn debug_string(&self, separator: &str, config: &Config) -> String {
|
||||
match self {
|
||||
|
||||
@ -569,14 +569,27 @@ def show-command [command: record] {
|
||||
|
||||
print ""
|
||||
print-help-header "Flags"
|
||||
print $" (ansi teal)-h(ansi reset), (ansi teal)--help(ansi reset) - Display the help message for this command"
|
||||
for flag in $flags {
|
||||
print -n $" (ansi teal)-($flag.short_flag)(ansi reset), (ansi teal)--($flag.parameter_name)(ansi reset)"
|
||||
if not ($flag.syntax_shape | is-empty) {
|
||||
print -n $" <(ansi light_blue)($flag.syntax_shape)(ansi reset)>"
|
||||
}
|
||||
print $" - ($flag.description)"
|
||||
let flag_parts = [ " ",
|
||||
(if ($flag.short_flag | is-empty) { "" } else {
|
||||
$"-(ansi teal)($flag.short_flag)(ansi reset), "
|
||||
}),
|
||||
(if ($flag.parameter_name | is-empty) { "" } else {
|
||||
$"--(ansi teal)($flag.parameter_name)(ansi reset)"
|
||||
}),
|
||||
(if ($flag.syntax_shape | is-empty) { "" } else {
|
||||
$": <(ansi light_blue)($flag.syntax_shape)(ansi reset)>"
|
||||
}),
|
||||
(if ($flag.description | is-empty) { "" } else {
|
||||
$" - ($flag.description)"
|
||||
}),
|
||||
(if ($flag.parameter_default | is-empty) { "" } else {
|
||||
$" \(default: ($flag.parameter_default)\)"
|
||||
}),
|
||||
]
|
||||
print ($flag_parts | str join "")
|
||||
}
|
||||
print $" (ansi teal)-h(ansi reset), --(ansi teal)help(ansi reset) - Display the help message for this command"
|
||||
|
||||
print ""
|
||||
print-help-header "Signatures"
|
||||
@ -595,16 +608,24 @@ def show-command [command: record] {
|
||||
print ""
|
||||
print-help-header "Parameters"
|
||||
for positional in $positionals {
|
||||
print -n " "
|
||||
if ($positional.is_optional) {
|
||||
print -n "(optional) "
|
||||
}
|
||||
print $"(ansi teal)($positional.parameter_name)(ansi reset) <(ansi light_blue)($positional.syntax_shape)(ansi reset)>: ($positional.description)"
|
||||
let arg_parts = [ " ",
|
||||
$"(ansi teal)($positional.parameter_name)(ansi reset)",
|
||||
(if ($positional.syntax_shape | is-empty) { "" } else {
|
||||
$": <(ansi light_blue)($positional.syntax_shape)(ansi reset)>"
|
||||
}),
|
||||
(if ($positional.description | is-empty) { "" } else {
|
||||
$" ($positional.description)"
|
||||
}),
|
||||
(if ($positional.parameter_default | is-empty) { "" } else {
|
||||
$" \(optional, default: ($positional.parameter_default)\)"
|
||||
})
|
||||
]
|
||||
print ($arg_parts | str join "")
|
||||
}
|
||||
|
||||
if $is_rest {
|
||||
let rest = ($parameters | where parameter_type == rest | get 0)
|
||||
print $" ...(ansi teal)rest(ansi reset) <(ansi light_blue)($rest.syntax_shape)(ansi reset)>: ($rest.description)"
|
||||
print $" ...(ansi teal)rest(ansi reset): <(ansi light_blue)($rest.syntax_shape)(ansi reset)> ($rest.description)"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -71,6 +71,6 @@ pub fn get_brief_subcommand_help(sigs: &[PluginSignature]) -> String {
|
||||
let _ = writeln!(help, " {} - {}", x.1.sig.name, x.1.sig.usage);
|
||||
}
|
||||
|
||||
help.push_str(&get_flags_section(&sigs[0].sig));
|
||||
help.push_str(&get_flags_section(&sigs[0].sig, |v| format!("{:#?}", v)));
|
||||
help
|
||||
}
|
||||
|
||||
@ -7,6 +7,7 @@ mod test_converters;
|
||||
mod test_custom_commands;
|
||||
mod test_engine;
|
||||
mod test_env;
|
||||
mod test_help;
|
||||
mod test_hiding;
|
||||
mod test_ide;
|
||||
mod test_iteration;
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
use crate::tests::{fail_test, run_test, TestResult};
|
||||
use rstest::rstest;
|
||||
|
||||
#[test]
|
||||
fn concrete_variable_assignment() -> TestResult {
|
||||
@ -63,6 +64,22 @@ fn scope_variable() -> TestResult {
|
||||
"int",
|
||||
)
|
||||
}
|
||||
#[rstest]
|
||||
#[case("a", "<> nothing")]
|
||||
#[case("b", "<1.23> float")]
|
||||
#[case("flag1", "<> nothing")]
|
||||
#[case("flag2", "<4.56> float")]
|
||||
|
||||
fn scope_command_defaults(#[case] var: &str, #[case] exp_result: &str) -> TestResult {
|
||||
run_test(
|
||||
&format!(
|
||||
r#"def t1 [a:int b?:float=1.23 --flag1:string --flag2:float=4.56] {{ true }};
|
||||
let rslt = ($nu.scope.commands | where name == 't1' | get signatures.0.any | where parameter_name == '{var}' | get parameter_default.0);
|
||||
$"<($rslt)> ($rslt | describe)""#
|
||||
),
|
||||
&format!("{exp_result}"),
|
||||
)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn earlier_errors() -> TestResult {
|
||||
|
||||
27
src/tests/test_help.rs
Normal file
27
src/tests/test_help.rs
Normal file
@ -0,0 +1,27 @@
|
||||
use crate::tests::{run_test, TestResult};
|
||||
use rstest::rstest;
|
||||
|
||||
#[rstest]
|
||||
// avoid feeding strings containing parens to regex. Does not end well.
|
||||
#[case(": arga help")]
|
||||
#[case("argb help")]
|
||||
#[case("optional, default: 20")]
|
||||
#[case("- f1 switch")]
|
||||
#[case("- f2 named no default")]
|
||||
#[case("- f3 named default 3")]
|
||||
#[case("default: 33")]
|
||||
#[case("--help - Display the help message")]
|
||||
fn can_get_help(#[case] exp_result: &str) -> TestResult {
|
||||
run_test(
|
||||
&format!(
|
||||
r#"def t [a:string, # arga help
|
||||
b:int=20, # argb help
|
||||
--f1, # f1 switch help
|
||||
--f2:string, # f2 named no default
|
||||
--f3:int=33 # f3 named default 3
|
||||
] {{ true }};
|
||||
help t | ansi strip | find `{exp_result}` | get 0 | str replace -a '^(.*({exp_result}).*)$' '$2'"#,
|
||||
),
|
||||
exp_result,
|
||||
)
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user