mirror of
https://github.com/nushell/nushell.git
synced 2025-06-30 22:50:14 +02:00
Make parsing for unknown args in known externals like normal external calls (#13414)
# Description This corrects the parsing of unknown arguments provided to known externals to behave exactly like external arguments passed to normal external calls. I've done this by adding a `SyntaxShape::ExternalArgument` which triggers the same parsing rules. Because I didn't like how the highlighting looked, I modified the flattener to emit `ExternalArg` flat shapes for arguments that have that syntax shape and are plain strings/globs. This is the same behavior that external calls have. Aside from passing the tests, I've also checked manually that the completer seems to work adequately. I can confirm that specified positional arguments get completion according to their specified type (including custom completions), and then anything remaining gets filepath style completion, as you'd expect from an external command. Thanks to @OJarrisonn for originally finding this issue. # User-Facing Changes - Unknown args are now parsed according to their specified syntax shape, rather than `Any`. This may be a breaking change, though I think it's extremely unlikely in practice. - The unspecified arguments of known externals are now highlighted / flattened identically to normal external arguments, which makes it more clear how they're being interpreted, and should help the completer function properly. - Known externals now have an implicit rest arg if not specified named `args`, with a syntax shape of `ExternalArgument`. # Tests + Formatting Tests added for the new behaviour. Some old tests had to be corrected to match. - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting - [ ] release notes (bugfix, and debatable whether it's a breaking change)
This commit is contained in:
@ -221,6 +221,22 @@ pub(crate) fn check_call(
|
||||
}
|
||||
}
|
||||
|
||||
/// Parses an unknown argument for the given signature. This handles the parsing as appropriate to
|
||||
/// the rest type of the command.
|
||||
fn parse_unknown_arg(
|
||||
working_set: &mut StateWorkingSet,
|
||||
span: Span,
|
||||
signature: &Signature,
|
||||
) -> Expression {
|
||||
let shape = signature
|
||||
.rest_positional
|
||||
.as_ref()
|
||||
.map(|arg| arg.shape.clone())
|
||||
.unwrap_or(SyntaxShape::Any);
|
||||
|
||||
parse_value(working_set, span, &shape)
|
||||
}
|
||||
|
||||
/// Parses a string in the arg or head position of an external call.
|
||||
///
|
||||
/// If the string begins with `r#`, it is parsed as a raw string. If it doesn't contain any quotes
|
||||
@ -427,11 +443,7 @@ fn parse_external_string(working_set: &mut StateWorkingSet, span: Span) -> Expre
|
||||
fn parse_external_arg(working_set: &mut StateWorkingSet, span: Span) -> ExternalArgument {
|
||||
let contents = working_set.get_span_contents(span);
|
||||
|
||||
if contents.starts_with(b"$") || contents.starts_with(b"(") {
|
||||
ExternalArgument::Regular(parse_dollar_expr(working_set, span))
|
||||
} else if contents.starts_with(b"[") {
|
||||
ExternalArgument::Regular(parse_list_expression(working_set, span, &SyntaxShape::Any))
|
||||
} else if contents.len() > 3
|
||||
if contents.len() > 3
|
||||
&& contents.starts_with(b"...")
|
||||
&& (contents[3] == b'$' || contents[3] == b'[' || contents[3] == b'(')
|
||||
{
|
||||
@ -441,7 +453,19 @@ fn parse_external_arg(working_set: &mut StateWorkingSet, span: Span) -> External
|
||||
&SyntaxShape::List(Box::new(SyntaxShape::Any)),
|
||||
))
|
||||
} else {
|
||||
ExternalArgument::Regular(parse_external_string(working_set, span))
|
||||
ExternalArgument::Regular(parse_regular_external_arg(working_set, span))
|
||||
}
|
||||
}
|
||||
|
||||
fn parse_regular_external_arg(working_set: &mut StateWorkingSet, span: Span) -> Expression {
|
||||
let contents = working_set.get_span_contents(span);
|
||||
|
||||
if contents.starts_with(b"$") || contents.starts_with(b"(") {
|
||||
parse_dollar_expr(working_set, span)
|
||||
} else if contents.starts_with(b"[") {
|
||||
parse_list_expression(working_set, span, &SyntaxShape::Any)
|
||||
} else {
|
||||
parse_external_string(working_set, span)
|
||||
}
|
||||
}
|
||||
|
||||
@ -998,7 +1022,7 @@ pub fn parse_internal_call(
|
||||
&& signature.allows_unknown_args
|
||||
{
|
||||
working_set.parse_errors.truncate(starting_error_count);
|
||||
let arg = parse_value(working_set, arg_span, &SyntaxShape::Any);
|
||||
let arg = parse_unknown_arg(working_set, arg_span, &signature);
|
||||
|
||||
call.add_unknown(arg);
|
||||
} else {
|
||||
@ -1040,7 +1064,7 @@ pub fn parse_internal_call(
|
||||
&& signature.allows_unknown_args
|
||||
{
|
||||
working_set.parse_errors.truncate(starting_error_count);
|
||||
let arg = parse_value(working_set, arg_span, &SyntaxShape::Any);
|
||||
let arg = parse_unknown_arg(working_set, arg_span, &signature);
|
||||
|
||||
call.add_unknown(arg);
|
||||
} else {
|
||||
@ -1135,6 +1159,10 @@ pub fn parse_internal_call(
|
||||
call.add_positional(Expression::garbage(working_set, arg_span));
|
||||
} else {
|
||||
let rest_shape = match &signature.rest_positional {
|
||||
Some(arg) if matches!(arg.shape, SyntaxShape::ExternalArgument) => {
|
||||
// External args aren't parsed inside lists in spread position.
|
||||
SyntaxShape::Any
|
||||
}
|
||||
Some(arg) => arg.shape.clone(),
|
||||
None => SyntaxShape::Any,
|
||||
};
|
||||
@ -1196,7 +1224,7 @@ pub fn parse_internal_call(
|
||||
call.add_positional(arg);
|
||||
positional_idx += 1;
|
||||
} else if signature.allows_unknown_args {
|
||||
let arg = parse_value(working_set, arg_span, &SyntaxShape::Any);
|
||||
let arg = parse_unknown_arg(working_set, arg_span, &signature);
|
||||
|
||||
call.add_unknown(arg);
|
||||
} else {
|
||||
@ -4670,7 +4698,8 @@ pub fn parse_value(
|
||||
| SyntaxShape::Signature
|
||||
| SyntaxShape::Filepath
|
||||
| SyntaxShape::String
|
||||
| SyntaxShape::GlobPattern => {}
|
||||
| SyntaxShape::GlobPattern
|
||||
| SyntaxShape::ExternalArgument => {}
|
||||
_ => {
|
||||
working_set.error(ParseError::Expected("non-[] value", span));
|
||||
return Expression::garbage(working_set, span);
|
||||
@ -4747,6 +4776,8 @@ pub fn parse_value(
|
||||
Expression::garbage(working_set, span)
|
||||
}
|
||||
|
||||
SyntaxShape::ExternalArgument => parse_regular_external_arg(working_set, span),
|
||||
|
||||
SyntaxShape::Any => {
|
||||
if bytes.starts_with(b"[") {
|
||||
//parse_value(working_set, span, &SyntaxShape::Table)
|
||||
|
Reference in New Issue
Block a user