mirror of
https://github.com/nushell/nushell.git
synced 2025-08-09 06:45:59 +02:00
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
@ -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,
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user