feat(langserver): better argument signatures for completion and signature help

don't break between prefix and name of signature

Author: d-biehl

packages/language_server/src/robotcode/language_server/robotframework/diagnostics/library_doc.py

@@ -24,6 +24,7 @@
     List,
     NamedTuple,
     Optional,
+    Sequence,
     Set,
     Tuple,
     TypeVar,
@@ -370,25 +371,32 @@ def from_robot(arg: Any) -> ArgumentInfo:
         )
 
     def __str__(self) -> str:
+        return self.signature()
+
+    def signature(self, add_types: bool = True) -> str:
         prefix = ""
         if self.kind == KeywordArgumentKind.POSITIONAL_ONLY_MARKER:
-            prefix = "*"
+            prefix = "*\u200d"
         elif self.kind == KeywordArgumentKind.NAMED_ONLY_MARKER:
-            prefix = "/"
+            prefix = "/\u200d"
         elif self.kind == KeywordArgumentKind.VAR_NAMED:
-            prefix = "**"
+            prefix = "*\u200d*\u200d"
         elif self.kind == KeywordArgumentKind.VAR_POSITIONAL:
-            prefix = "*"
+            prefix = "*\u200d"
         elif self.kind == KeywordArgumentKind.NAMED_ONLY:
-            prefix = "🏷"
+            prefix = "🏷\u200d"
         elif self.kind == KeywordArgumentKind.POSITIONAL_ONLY:
-            prefix = "⟶"
-        return (
-            f"{prefix}{self.name!s}"
-            f"{(': ' + (' | '.join(f'{s}' for s in self.types))) if self.types else ''}"
-            f"{' =' if self.default_value is not None else ''}"
-            f"{f' {self.default_value!s}' if self.default_value else ''}"
-        )
+            prefix = "⟶\u200d"
+        result = f"{prefix}{self.name!s}"
+        if add_types:
+            result += (
+                f"{(': ' + (' | '.join(f'{s}' for s in self.types))) if self.types else ''}"
+                f"{' =' if self.default_value is not None else ''}"
+                f"{f' {self.default_value!s}' if self.default_value else ''}"
+                if add_types
+                else ""
+            )
+        return result
 
     def __hash__(self) -> int:
         return id(self)
@@ -676,13 +684,12 @@ def signature(self) -> str:
             + ")"
         )
 
-    @property
-    def parameter_signature(self) -> str:
+    def parameter_signature(self, full_signatures: Optional[Sequence[int]] = None) -> str:
         return (
             "("
             + ", ".join(
-                str(a)
-                for a in self.arguments
+                a.signature(full_signatures is None or i in full_signatures)
+                for i, a in enumerate(self.arguments)
                 if a.kind not in [KeywordArgumentKind.POSITIONAL_ONLY_MARKER, KeywordArgumentKind.NAMED_ONLY_MARKER]
             )
             + ")"

packages/language_server/src/robotcode/language_server/robotframework/parts/completion.py

@@ -2162,7 +2162,7 @@ async def _complete_KeywordCall_or_Fixture(  # noqa: N802
         if complete_argument_names:
             result += [
                 CompletionItem(
-                    label=f"{e.name}=",
+                    label=f"{e.signature(False)}=",
                     kind=CompletionItemKind.VARIABLE,
                     detail="Argument",
                     filter_text=e.name,

packages/language_server/src/robotcode/language_server/robotframework/parts/signature_help.py

@@ -145,18 +145,18 @@ def _get_signature_help(
         )
 
         signature = SignatureInformation(
-            label=keyword_doc.parameter_signature,
+            label=keyword_doc.parameter_signature(),
             parameters=[
                 ParameterInformation(
-                    label=str(p),
+                    label=p.signature(),
                     documentation=MarkupContent(
                         kind=MarkupKind.MARKDOWN,
                         value="\n\n---\n\n".join([t.to_markdown() for t in keyword_doc.parent.get_types(p.types)]),
                     )
                     if p.types and keyword_doc.parent is not None
                     else None,
                 )
-                for p in kw_arguments
+                for i, p in enumerate(kw_arguments)
             ],
             active_parameter=argument_index,
             documentation=MarkupContent(kind=MarkupKind.MARKDOWN, value=keyword_doc.to_markdown(False)),