implement handling of command line variables

Author: d-biehl

package.json

@@ -143,7 +143,7 @@
       }
     ],
     "languages": [
-      {
+      {        
         "id": "robotframework",
         "aliases": [
           "Robot Framework",

poetry.lock

@@ -30,6 +30,7 @@ robotframework-robocop = "^1.7.1"
 robotframework-tidy = "^1.5.1"
 orjson = "^3.6.3"
 types-orjson = "^3.6.0"
+PyYAML = "^6.0"
 
 
 [tool.poetry-dynamic-versioning]

pyproject.toml

@@ -323,7 +323,7 @@ async def get_configuration(
             else:
                 result = {}
                 break
-        return self.settings.get(str(section), {})
+        return result
 
     def get_workspace_folder(self, uri: Union[Uri, str]) -> Optional[WorkspaceFolder]:
         if isinstance(uri, str):

robotcode/language_server/common/parts/workspace.py

@@ -141,7 +141,8 @@ def __hash__(self) -> int:
 class VariableDefinitionType(Enum):
     VARIABLE = "Variable"
     ARGUMENT = "Argument"
-    BUILTIN_VARIABLE = "Variable (Builtin)"
+    COMMAND_LINE_VARIABLE = "Command Line Variable"
+    BUILTIN_VARIABLE = "Builtin Variable"
 
 
 @dataclass
@@ -174,6 +175,14 @@ def __hash__(self) -> int:
         return hash((type(self), self.name, self.type))
 
 
+@dataclass
+class CommandLineVariableDefinition(VariableDefinition):
+    type: VariableDefinitionType = VariableDefinitionType.COMMAND_LINE_VARIABLE
+
+    def __hash__(self) -> int:
+        return hash((type(self), self.name, self.type))
+
+
 @dataclass
 class ArgumentDefinition(VariableDefinition):
     type: VariableDefinitionType = VariableDefinitionType.ARGUMENT
@@ -995,6 +1004,15 @@ def get_builtin_variables(cls) -> List[BuiltInVariableDefinition]:
 
         return cls._builtin_variables
 
+    def get_command_line_variables(self) -> List[VariableDefinition]:
+        if self.imports_manager.config is None:
+            return []
+
+        return [
+            CommandLineVariableDefinition(0, 0, 0, 0, "", f"${{{k}}}", None)
+            for k in self.imports_manager.config.variables.keys()
+        ]
+
     async def get_variables(
         self, nodes: Optional[List[ast.AST]] = None, position: Optional[Position] = None
     ) -> Dict[VariableMatcher, VariableDefinition]:
@@ -1012,6 +1030,7 @@ async def get_variables(
             ],
             (e for e in await self.get_own_variables()),
             *(e.variables for e in self._resources.values()),
+            (e for e in self.get_command_line_variables()),
             (e for e in self.get_builtin_variables()),
         ):
             if var.name is not None and VariableMatcher(var.name) not in result.keys():

robotcode/language_server/robotframework/diagnostics/namespace.py

@@ -304,7 +304,8 @@ async def create_environment_variables_completion_items(self, range: Optional[Ra
     _VARIABLE_COMPLETION_SORT_TEXT_PREFIX = {
         VariableDefinitionType.VARIABLE: "035",
         VariableDefinitionType.ARGUMENT: "034",
-        VariableDefinitionType.BUILTIN_VARIABLE: "036",
+        VariableDefinitionType.COMMAND_LINE_VARIABLE: "036",
+        VariableDefinitionType.BUILTIN_VARIABLE: "037",
     }
 
     async def create_variables_completion_items(

robotcode/language_server/robotframework/parts/completion.py

@@ -83,21 +83,27 @@ async def _on_initialize(self, sender: Any, initialization_options: Optional[Any
 
     @_logger.call
     async def _on_initialized(self, sender: Any) -> None:
-        document_selector = [DocumentFilter(language="python")]
-        await self.register_capability(
-            str(uuid.uuid4()),
-            "textDocument/didOpen",
-            TextDocumentRegistrationOptions(document_selector=document_selector),
-        )
-        await self.register_capability(
-            str(uuid.uuid4()),
-            "textDocument/didChange",
-            TextDocumentChangeRegistrationOptions(
-                document_selector=document_selector, sync_kind=TextDocumentSyncKind.INCREMENTAL
-            ),
-        )
-        await self.register_capability(
-            str(uuid.uuid4()),
-            "textDocument/didClose",
-            TextDocumentRegistrationOptions(document_selector=document_selector),
-        )
+        if (
+            self.client_capabilities
+            and self.client_capabilities.workspace
+            and self.client_capabilities.workspace.file_operations
+            and self.client_capabilities.workspace.file_operations.dynamic_registration
+        ):
+            document_selector = [DocumentFilter(language="python")]
+            await self.register_capability(
+                str(uuid.uuid4()),
+                "textDocument/didOpen",
+                TextDocumentRegistrationOptions(document_selector=document_selector),
+            )
+            await self.register_capability(
+                str(uuid.uuid4()),
+                "textDocument/didChange",
+                TextDocumentChangeRegistrationOptions(
+                    document_selector=document_selector, sync_kind=TextDocumentSyncKind.INCREMENTAL
+                ),
+            )
+            await self.register_capability(
+                str(uuid.uuid4()),
+                "textDocument/didClose",
+                TextDocumentRegistrationOptions(document_selector=document_selector),
+            )

robotcode/language_server/robotframework/protocol.py

@@ -12,3 +12,4 @@ first
     FOR    ${key}    ${value}    IN    &{A DICT}
         Log    ${key}=${value}
     END
+    Log    ${CMD_VAR}

tests/robotcode/language_server/robotframework/parts/data/hover.robot

@@ -1,20 +1,26 @@
 from pathlib import Path
-from typing import AsyncGenerator
+from typing import AsyncGenerator, cast
 
 import pytest
 
+from robotcode.language_server.common.parts.workspace import HasConfigSection
 from robotcode.language_server.common.text_document import TextDocument
 from robotcode.language_server.common.types import (
     ClientCapabilities,
     ClientInfo,
     HoverClientCapabilities,
+    InitializedParams,
     MarkupContent,
     MarkupKind,
     Position,
     Range,
     TextDocumentClientCapabilities,
     WorkspaceFolder,
 )
+from robotcode.language_server.robotframework.configuration import (
+    RobotCodeConfig,
+    RobotConfig,
+)
 from robotcode.language_server.robotframework.protocol import (
     RobotLanguageServerProtocol,
 )
@@ -38,7 +44,21 @@ async def protocol() -> AsyncGenerator[RobotLanguageServerProtocol, None]:
             workspace_folders=[WorkspaceFolder(name="test workspace", uri=root_path.as_uri())],
             client_info=ClientInfo(name="TestClient", version="1.0.0"),
         )
-
+        await protocol._initialized(InitializedParams())
+        await protocol.workspace._workspace_did_change_configuration(
+            {
+                cast(HasConfigSection, RobotCodeConfig)
+                .__config_section__: RobotCodeConfig(
+                    robot=RobotConfig(
+                        env={"ENV_VAR": "1"},
+                        variables={
+                            "CMD_VAR": "1",
+                        },
+                    )
+                )
+                .dict()
+            }
+        )
         yield protocol
     finally:
         server.close()
@@ -102,6 +122,7 @@ async def test_hover_should_not_find_simple_keyword_on_boundaries(
         (Position(line=10, character=36), "(Variable) &{A DICT}"),
         (Position(line=11, character=13), "(Variable) ${key}"),  # FOR Variable
         (Position(line=11, character=24), "(Variable) ${value}"),  # FOR Variable
+        (Position(line=14, character=14), "(Command Line Variable) ${CMD_VAR}"),  # CMD LINE Variable
     ],
 )
 @pytest.mark.asyncio