Parse custom completer annotation only in args (#10581)

# Description
To my knowledge `type@completer` annotations only make sense in
arguments at the moment.
Restrict the parsing.
Also fix a bug in parsing the completer annotation should there be more
than 1 `@`


- Add test that we disallow completer in type
- Guard against `@` inside command name
- Disallow custom completers in type specification


# User-Facing Changes
Error when annotating a variable or input-output type with a completer

# Tests + Formatting
Tests to verify the error message

crates/nu-parser/src/parser.rs

@@ -2696,11 +2696,22 @@ pub fn parse_string_strict(working_set: &mut StateWorkingSet, span: Span) -> Exp
     }
 }
 
+#[derive(Debug, Clone, Copy, PartialEq)]
+pub enum ShapeDescriptorUse {
+    /// Used in an argument position allowing the addition of custom completion
+    Argument,
+    /// Used to define the type of a variable or input/output types
+    Type,
+}
+
 /// Parse the literals of [`Type`]-like [`SyntaxShape`]s including inner types.
 /// Also handles the specification of custom completions with `type@completer`.
 ///
+/// Restrict the parsing with `use_loc`
 /// Used in:
+/// - [`ShapeDescriptorUse::Argument`]
 ///   - `: ` argument type (+completer) positions in signatures
+/// - [`ShapeDescriptorUse::Type`]
 ///   - `type->type` input/output type pairs
 ///   - `let name: type` variable type infos
 ///
@@ -2709,6 +2720,7 @@ pub fn parse_shape_name(
     working_set: &mut StateWorkingSet,
     bytes: &[u8],
     span: Span,
+    use_loc: ShapeDescriptorUse,
 ) -> SyntaxShape {
     let result = match bytes {
         b"any" => SyntaxShape::Any,
@@ -2733,32 +2745,52 @@ pub fn parse_shape_name(
         b"filesize" => SyntaxShape::Filesize,
         b"glob" => SyntaxShape::GlobPattern,
         b"int" => SyntaxShape::Int,
-        _ if bytes.starts_with(b"list") => parse_list_shape(working_set, bytes, span),
+        _ if bytes.starts_with(b"list") => parse_list_shape(working_set, bytes, span, use_loc),
         b"nothing" => SyntaxShape::Nothing,
         b"number" => SyntaxShape::Number,
         b"path" => SyntaxShape::Filepath,
         b"range" => SyntaxShape::Range,
-        _ if bytes.starts_with(b"record") => parse_collection_shape(working_set, bytes, span),
+        _ if bytes.starts_with(b"record") => {
+            parse_collection_shape(working_set, bytes, span, use_loc)
+        }
         b"string" => SyntaxShape::String,
-        _ if bytes.starts_with(b"table") => parse_collection_shape(working_set, bytes, span),
+        _ if bytes.starts_with(b"table") => {
+            parse_collection_shape(working_set, bytes, span, use_loc)
+        }
         _ => {
             if bytes.contains(&b'@') {
-                let split: Vec<_> = bytes.split(|b| b == &b'@').collect();
+                let mut split = bytes.splitn(2, |b| b == &b'@');
 
-                let shape_span = Span::new(span.start, span.start + split[0].len());
+                let shape_name = split
-                let cmd_span = Span::new(span.start + split[0].len() + 1, span.end);
+                    .next()
-                let shape = parse_shape_name(working_set, split[0], shape_span);
+                    .expect("If `bytes` contains `@` splitn returns 2 slices");
-
+                let shape_span = Span::new(span.start, span.start + shape_name.len());
-                let command_name = trim_quotes(split[1]);
+                let shape = parse_shape_name(working_set, shape_name, shape_span, use_loc);
-
+                if use_loc != ShapeDescriptorUse::Argument {
-                if command_name.is_empty() {
+                    let illegal_span = Span::new(span.start + shape_name.len(), span.end);
-                    working_set.error(ParseError::Expected("a command name", cmd_span));
+                    working_set.error(ParseError::LabeledError(
-                    return SyntaxShape::Any;
+                        "Unexpected custom completer in type spec".into(),
+                        "Type specifications do not support custom completers".into(),
+                        illegal_span,
+                    ));
+                    return shape;
                 }
 
-                let decl_id = working_set.find_decl(command_name);
+                let cmd_span = Span::new(span.start + shape_name.len() + 1, span.end);
+                let cmd_name = split
+                    .next()
+                    .expect("If `bytes` contains `@` splitn returns 2 slices");
 
-                if let Some(decl_id) = decl_id {
+                let cmd_name = trim_quotes(cmd_name);
+                if cmd_name.is_empty() {
+                    working_set.error(ParseError::Expected(
+                        "the command name of a completion function",
+                        cmd_span,
+                    ));
+                    return shape;
+                }
+
+                if let Some(decl_id) = working_set.find_decl(cmd_name) {
                     return SyntaxShape::CompleterWrapper(Box::new(shape), decl_id);
                 } else {
                     working_set.error(ParseError::UnknownCommand(cmd_span));
@@ -2779,6 +2811,7 @@ fn parse_collection_shape(
     working_set: &mut StateWorkingSet,
     bytes: &[u8],
     span: Span,
+    use_loc: ShapeDescriptorUse,
 ) -> SyntaxShape {
     assert!(bytes.starts_with(b"record") || bytes.starts_with(b"table"));
     let is_table = bytes.starts_with(b"table");
@@ -2884,7 +2917,7 @@ fn parse_collection_shape(
             }
 
             let shape_bytes = working_set.get_span_contents(tokens[idx].span).to_vec();
-            let shape = parse_shape_name(working_set, &shape_bytes, tokens[idx].span);
+            let shape = parse_shape_name(working_set, &shape_bytes, tokens[idx].span, use_loc);
             sig.push((key, shape));
             idx += 1;
         }
@@ -2897,7 +2930,12 @@ fn parse_collection_shape(
     }
 }
 
-fn parse_list_shape(working_set: &mut StateWorkingSet, bytes: &[u8], span: Span) -> SyntaxShape {
+fn parse_list_shape(
+    working_set: &mut StateWorkingSet,
+    bytes: &[u8],
+    span: Span,
+    use_loc: ShapeDescriptorUse,
+) -> SyntaxShape {
     assert!(bytes.starts_with(b"list"));
 
     if bytes == b"list" {
@@ -2915,7 +2953,7 @@ fn parse_list_shape(working_set: &mut StateWorkingSet, bytes: &[u8], span: Span)
         if inner_bytes.is_empty() {
             SyntaxShape::List(Box::new(SyntaxShape::Any))
         } else {
-            let inner_sig = parse_shape_name(working_set, &inner_bytes, inner_span);
+            let inner_sig = parse_shape_name(working_set, &inner_bytes, inner_span, use_loc);
 
             SyntaxShape::List(Box::new(inner_sig))
         }
@@ -2955,7 +2993,7 @@ fn prepare_inner_span(
 }
 
 pub fn parse_type(working_set: &mut StateWorkingSet, bytes: &[u8], span: Span) -> Type {
-    parse_shape_name(working_set, bytes, span).to_type()
+    parse_shape_name(working_set, bytes, span, ShapeDescriptorUse::Type).to_type()
 }
 
 pub fn parse_import_pattern(working_set: &mut StateWorkingSet, spans: &[Span]) -> Expression {
@@ -3715,7 +3753,12 @@ pub fn parse_signature_helper(working_set: &mut StateWorkingSet, span: Span) ->
                         }
                         ParseMode::TypeMode => {
                             if let Some(last) = args.last_mut() {
-                                let syntax_shape = parse_shape_name(working_set, &contents, span);
+                                let syntax_shape = parse_shape_name(
+                                    working_set,
+                                    &contents,
+                                    span,
+                                    ShapeDescriptorUse::Argument,
+                                );
                                 //TODO check if we're replacing a custom parameter already
                                 match last {
                                     Arg::Positional(PositionalArg { shape, var_id, .. }, ..) => {

src/tests/test_parser.rs

@@ -638,6 +638,14 @@ fn let_variable_type_mismatch() -> TestResult {
     fail_test(r#"let x: int = "foo""#, "expected int, found string")
 }
 
+#[test]
+fn let_variable_disallows_completer() -> TestResult {
+    fail_test(
+        r#"let x: int@completer = 42"#,
+        "Unexpected custom completer",
+    )
+}
+
 #[test]
 fn def_with_input_output_1() -> TestResult {
     run_test(r#"def foo []: nothing -> int { 3 }; foo"#, "3")
@@ -685,6 +693,22 @@ fn def_with_input_output_broken_2() -> TestResult {
     fail_test(r#"def foo []: int -> { 3 }"#, "expected type")
 }
 
+#[test]
+fn def_with_input_output_broken_3() -> TestResult {
+    fail_test(
+        r#"def foo []: int -> int@completer {}"#,
+        "Unexpected custom completer",
+    )
+}
+
+#[test]
+fn def_with_input_output_broken_4() -> TestResult {
+    fail_test(
+        r#"def foo []: int -> list<int@completer> {}"#,
+        "Unexpected custom completer",
+    )
+}
+
 #[test]
 fn def_with_in_var_let_1() -> TestResult {
     run_test(