feat(langserver): implemented robocop 6.0 formatting and deprecate old robotidy

d-biehl · d-biehl · commit 310bc544be83 · 2025-05-30T02:19:55.000+02:00
diff --git a/package.json b/package.json
@@ -1116,13 +1116,13 @@
         }
       },
       {
-        "title": "Linting - Robocop",
+        "title": "Linting and Formatting - Robocop",
         "type": "object",
         "properties": {
           "robotcode.robocop.enabled": {
             "type": "boolean",
             "default": true,
-            "markdownDescription": "Enables 'robocop' code analysis, if installed. See [robocop](https://github.com/MarketSquare/robotframework-robocop)",
+            "markdownDescription": "Enables 'robocop' code analysis, if installed. See [robocop](https://robocop.readthedocs.io/)",
             "scope": "resource"
           },
           "robotcode.robocop.include": {
@@ -1132,15 +1132,35 @@
               "type": "string"
             },
             "description": "Include specified 'robocop' rules. You can define rule by its name or id. Glob patterns are supported",
-            "scope": "resource"
+            "scope": "resource",
+            "markdownDeprecationMessage": "This is a setting for an old `robotframework-robocop` version `<6.0` and will be removed in the future"
           },
           "robotcode.robocop.exclude": {
             "type": "array",
             "default": [],
             "items": {
               "type": "string"
             },
-            "description": "Exlude specified 'robocop' rules. You can define rule by its name or id. Glob patterns are supported",
+            "description": "Exclude specified 'robocop' rules. You can define rule by its name or id. Glob patterns are supported",
+            "scope": "resource",
+            "markdownDeprecationMessage": "This is a setting for an old `robotframework-robocop` version `<6.0` and will be removed in the future."
+          },
+          "robotcode.robocop.ignoreGitDir": {
+            "type": "boolean",
+            "default": false,
+            "markdownDescription": "Do not stop searching for config file when .git directory is found. Corresponds to the `--ignore-git-dir` of _robocop_ See [robocop](https://robocop.readthedocs.io/)",
+            "scope": "resource"
+          },
+          "robotcode.robocop.configFile": {
+            "type": "string",
+            "default": null,
+            "markdownDescription": "Read configuration from FILE path. Corresponds to the `--config` option of _robocop_ See [robocop](https://robocop.readthedocs.io/)",
+            "scope": "resource"
+          },
+          "robotcode.robocop.ignoreFileConfig": {
+            "type": "boolean",
+            "default": false,
+            "markdownDescription": "Do not load configuration files. Corresponds to the `--ignore-file-config` option of _robocop_ See [robocop](https://robocop.readthedocs.io/)",
             "scope": "resource"
           },
           "robotcode.robocop.configurations": {
@@ -1149,8 +1169,9 @@
             "items": {
               "type": "string"
             },
-            "description": "Configure 'robocop' checker with parameter value.",
-            "scope": "resource"
+            "description": "Configure checker or report with parameter value. Corresponds to the `--configure` option of _robocop_ See [robocop](https://robocop.readthedocs.io/)",
+            "scope": "resource",
+            "markdownDeprecationMessage": "This is a setting for an old `robotframework-robocop` version `<6.0` and will be removed in the future."
           }
         }
       },
diff --git a/packages/core/src/robotcode/core/utils/version.py b/packages/core/src/robotcode/core/utils/version.py
@@ -1,3 +1,4 @@
+import functools
 import re
 from typing import NamedTuple, Optional
 
@@ -16,6 +17,7 @@ class Version(NamedTuple):
     dev: Optional[int] = None
 
 
+@functools.lru_cache(maxsize=128)
 def create_version_from_str(version_str: str) -> Version:
     def s_to_i(s: Optional[str]) -> Optional[int]:
         return int(s) if s is not None else None
diff --git a/packages/language_server/src/robotcode/language_server/robotframework/configuration.py b/packages/language_server/src/robotcode/language_server/robotframework/configuration.py
@@ -33,6 +33,9 @@ class RoboCopConfig(ConfigBase):
     enabled: bool = True
     include: List[str] = field(default_factory=list)
     exclude: List[str] = field(default_factory=list)
+    ignore_git_dir: bool = False
+    ignore_file_config: bool = False
+    config_file: Optional[str] = None
     configurations: List[str] = field(default_factory=list)
 
 
diff --git a/packages/language_server/src/robotcode/language_server/robotframework/parts/formatting.py b/packages/language_server/src/robotcode/language_server/robotframework/parts/formatting.py
@@ -1,6 +1,5 @@
 import io
 import os
-import re
 from concurrent.futures import CancelledError
 from typing import TYPE_CHECKING, Any, List, Optional, cast
 
@@ -14,49 +13,48 @@
 )
 from robotcode.core.text_document import TextDocument
 from robotcode.core.utils.logging import LoggingDescriptor
-from robotcode.core.utils.version import create_version_from_str
-from robotcode.robot.diagnostics.model_helper import ModelHelper
 from robotcode.robot.utils import get_robot_version
 
-from ..configuration import RoboTidyConfig
+from ..configuration import RoboCopConfig, RoboTidyConfig
 from .protocol_part import RobotLanguageServerProtocolPart
+from .robocop_tidy_mixin import RoboCopTidyMixin
 
 if TYPE_CHECKING:
     from ..protocol import RobotLanguageServerProtocol
 
 
-def robotidy_installed() -> bool:
-    try:
-        __import__("robotidy")
-    except ImportError:
-        return False
-    return True
-
-
-class RobotFormattingProtocolPart(RobotLanguageServerProtocolPart, ModelHelper):
+class RobotFormattingProtocolPart(RobotLanguageServerProtocolPart, RoboCopTidyMixin):
     _logger = LoggingDescriptor()
 
     def __init__(self, parent: "RobotLanguageServerProtocol") -> None:
         super().__init__(parent)
 
         parent.formatting.format.add(self.format)
 
-        if robotidy_installed():
+        if self.robotidy_installed or (self.robocop_installed and self.robocop_version >= (6, 0)):
             parent.formatting.format_range.add(self.format_range)
 
         self.space_count = 4
         self.use_pipes = False
         self.line_separator = os.linesep
         self.short_test_name_length = 18
         self.setting_and_variable_name_length = 14
+        self.robocop_installed_message_shown = False
 
-    def get_config(self, document: TextDocument) -> RoboTidyConfig:
+    def get_tidy_config(self, document: TextDocument) -> RoboTidyConfig:
         folder = self.parent.workspace.get_workspace_folder(document.uri)
         if folder is None:
             return RoboTidyConfig()
 
         return self.parent.workspace.get_configuration(RoboTidyConfig, folder.uri)
 
+    def get_robocop_config(self, document: TextDocument) -> RoboCopConfig:
+        folder = self.parent.workspace.get_workspace_folder(document.uri)
+        if folder is None:
+            return RoboCopConfig()
+
+        return self.parent.workspace.get_configuration(RoboCopConfig, folder.uri)
+
     @language_id("robotframework")
     @_logger.call
     def format(
@@ -66,23 +64,32 @@ def format(
         options: FormattingOptions,
         **further_options: Any,
     ) -> Optional[List[TextEdit]]:
-        config = self.get_config(document)
+        if (get_robot_version() >= (5, 0)) and self.robocop_installed and self.robocop_version >= (6, 0):
+            if not self.robocop_installed_message_shown and self.robotidy_installed:
+                self.parent.window.show_message(
+                    "`robotframework-robocop >= 6.0` is installed and will be used for formatting.\n"
+                    "`robotframework-tidy` is also detected in the workspace. "
+                    "It is not needed as `robocop` handles formatting tasks.\n",
+                    MessageType.INFO,
+                )
+                self.robocop_installed_message_shown = True
 
-        if (config.enabled or get_robot_version() >= (5, 0)) and robotidy_installed():
-            return self.format_robot_tidy(document, options, config=config, **further_options)
+            return self.format_robocop(document, options, **further_options)
+
+        tidy_config = self.get_tidy_config(document)
+        if (tidy_config.enabled or get_robot_version() >= (5, 0)) and self.robotidy_installed:
+            return self.format_robot_tidy(document, options, config=tidy_config, **further_options)
 
         if get_robot_version() < (5, 0):
             return self.format_internal(document, options, **further_options)
 
         self.parent.window.show_message(
-            "RobotFramework formatter is not available, please install 'robotframework-tidy'.",
+            "RobotFramework formatter is not available, please install 'robotframework-robocop'.",
             MessageType.ERROR,
         )
 
         return None
 
-    RE_LINEBREAKS = re.compile(r"\r\n|\r|\n")
-
     def format_robot_tidy(
         self,
         document: TextDocument,
@@ -91,28 +98,24 @@ def format_robot_tidy(
         config: Optional[RoboTidyConfig] = None,
         **further_options: Any,
     ) -> Optional[List[TextEdit]]:
-        from robotidy.version import __version__
-
         try:
             if config is None:
-                config = self.get_config(document)
-
-            robotidy_version = create_version_from_str(__version__)
+                config = self.get_tidy_config(document)
 
             model = self.parent.documents_cache.get_model(document, False)
 
-            if robotidy_version >= (3, 0):
+            if self.robotidy_version >= (3, 0):
                 from robotidy.api import get_robotidy
                 from robotidy.disablers import RegisterDisablers
 
-                if robotidy_version >= (4, 2):
+                if self.robotidy_version >= (4, 2):
                     robot_tidy = get_robotidy(
                         document.uri.to_path(),
                         None,
                         ignore_git_dir=config.ignore_git_dir,
                         config=config.config,
                     )
-                elif robotidy_version >= (4, 1):
+                elif self.robotidy_version >= (4, 1):
                     robot_tidy = get_robotidy(
                         document.uri.to_path(),
                         None,
@@ -131,14 +134,14 @@ def format_robot_tidy(
                 )
                 disabler_finder.visit(model)
 
-                if robotidy_version >= (4, 11):
+                if self.robotidy_version >= (4, 11):
                     if disabler_finder.is_disabled_in_file():
                         return None
                 else:
                     if disabler_finder.file_disabled:
                         return None
 
-                if robotidy_version >= (4, 0):
+                if self.robotidy_version >= (4, 0):
                     _, _, new, _ = robot_tidy.transform_until_stable(model, disabler_finder)
                 else:
                     _, _, new = robot_tidy.transform(model, disabler_finder.disablers)
@@ -152,7 +155,7 @@ def format_robot_tidy(
                     robot_tidy.formatting_config.start_line = range.start.line + 1
                     robot_tidy.formatting_config.end_line = range.end.line + 1
 
-                if robotidy_version >= (2, 2):
+                if self.robotidy_version >= (2, 2):
                     from robotidy.disablers import RegisterDisablers
 
                     disabler_finder = RegisterDisablers(
@@ -186,6 +189,50 @@ def format_robot_tidy(
             self.parent.window.show_message(f"Executing `robotidy` failed: {e}", MessageType.ERROR)
         return None
 
+    def format_robocop(
+        self,
+        document: TextDocument,
+        options: FormattingOptions,
+        range: Optional[Range] = None,
+        **further_options: Any,
+    ) -> Optional[List[TextEdit]]:
+        from robocop.config import ConfigManager
+        from robocop.formatter.runner import RobocopFormatter
+
+        robocop_config = self.get_robocop_config(document)
+
+        config_manager = ConfigManager(
+            [document.uri.to_path()],
+            config=robocop_config.config_file,
+            ignore_git_dir=robocop_config.ignore_git_dir,
+            ignore_file_config=robocop_config.ignore_file_config,
+        )
+
+        config = config_manager.get_config_for_source_file(document.uri.to_path())
+
+        if range is not None:
+            config.formatter.start_line = range.start.line + 1
+            config.formatter.end_line = range.end.line + 1
+
+        runner = RobocopFormatter(config_manager)
+        runner.config = config
+
+        model = self.parent.documents_cache.get_model(document, False)
+        _, _, new, _ = runner.format_until_stable(model)
+
+        if new.text == document.text():
+            return None
+
+        return [
+            TextEdit(
+                range=Range(
+                    start=Position(line=0, character=0),
+                    end=Position(line=len(document.get_lines()), character=0),
+                ),
+                new_text=new.text,
+            )
+        ]
+
     def format_internal(
         self,
         document: TextDocument,
@@ -233,8 +280,8 @@ def format_range(
         options: FormattingOptions,
         **further_options: Any,
     ) -> Optional[List[TextEdit]]:
-        config = self.get_config(document)
-        if config.enabled and robotidy_installed():
+        config = self.get_tidy_config(document)
+        if (config.enabled and self.robotidy_installed) or (self.robocop_installed and self.robocop_version >= (6, 0)):
             return self.format_robot_tidy(document, options, range=range, config=config, **further_options)
 
         return None
diff --git a/packages/language_server/src/robotcode/language_server/robotframework/parts/project_info.py b/packages/language_server/src/robotcode/language_server/robotframework/parts/project_info.py
@@ -7,9 +7,8 @@
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
 
-from .formatting import robotidy_installed
 from .protocol_part import RobotLanguageServerProtocolPart
-from .robocop_diagnostics import robocop_installed
+from .robocop_tidy_mixin import RoboCopTidyMixin
 
 if TYPE_CHECKING:
     from ..protocol import RobotLanguageServerProtocol
@@ -22,7 +21,7 @@ class ProjectInfo(CamelSnakeMixin):
     tidy_version_string: Optional[str] = None
 
 
-class ProjectInfoPart(RobotLanguageServerProtocolPart):
+class ProjectInfoPart(RobotLanguageServerProtocolPart, RoboCopTidyMixin):
     _logger = LoggingDescriptor()
 
     def __init__(self, parent: "RobotLanguageServerProtocol") -> None:
@@ -36,24 +35,12 @@ def _robot_project_info(
         **kwargs: Any,
     ) -> ProjectInfo:
         robocop_version_string = None
-        if robocop_installed():
-            try:
-                from robocop.version import __version__
-
-                robocop_version_string = __version__
-            except ImportError:
-                try:
-                    from robocop import __version__
-
-                    robocop_version_string = __version__
-                except ImportError:
-                    pass
+        if self.robocop_installed:
+            robocop_version_string = self.robocop_version_str
 
         tidy_version_string = None
-        if robotidy_installed():
-            from robotidy.version import __version__
-
-            tidy_version_string = __version__
+        if self.robotidy_installed:
+            tidy_version_string = self.robotidy_version_str
 
         return ProjectInfo(
             robot_version_string=get_version(),
diff --git a/packages/language_server/src/robotcode/language_server/robotframework/parts/robocop_diagnostics.py b/packages/language_server/src/robotcode/language_server/robotframework/parts/robocop_diagnostics.py
@@ -17,28 +17,21 @@
 from ...common.parts.diagnostics import DiagnosticsCollectType, DiagnosticsResult
 from ..configuration import RoboCopConfig
 from .protocol_part import RobotLanguageServerProtocolPart
+from .robocop_tidy_mixin import RoboCopTidyMixin
 
 if TYPE_CHECKING:
     from ..protocol import RobotLanguageServerProtocol
 
 
-def robocop_installed() -> bool:
-    try:
-        __import__("robocop")
-    except ImportError:
-        return False
-    return True
-
-
-class RobotRoboCopDiagnosticsProtocolPart(RobotLanguageServerProtocolPart):
+class RobotRoboCopDiagnosticsProtocolPart(RobotLanguageServerProtocolPart, RoboCopTidyMixin):
     _logger = LoggingDescriptor()
 
     def __init__(self, parent: "RobotLanguageServerProtocol") -> None:
         super().__init__(parent)
 
         self.source_name = "robocop"
 
-        if robocop_installed():
+        if self.robocop_installed and self.robocop_version < (6, 0):
             parent.diagnostics.collect.add(self.collect_diagnostics)
 
     def get_config(self, document: TextDocument) -> Optional[RoboCopConfig]:
diff --git a/packages/language_server/src/robotcode/language_server/robotframework/parts/robocop_tidy_mixin.py b/packages/language_server/src/robotcode/language_server/robotframework/parts/robocop_tidy_mixin.py
diff --git a/packages/robot/src/robotcode/robot/utils/__init__.py b/packages/robot/src/robotcode/robot/utils/__init__.py
diff --git a/vscode-client/extension/languageclientsmanger.ts b/vscode-client/extension/languageclientsmanger.ts
