feat!: deprecate deprecated-statement rule and split into deprecated-return-setting (#1639)

Author: bhirsz

src/robocop/linter/rules/deprecated.py

@@ -44,14 +44,16 @@ class IfCanBeUsedRule(Rule):
     deprecated_names = ("0908",)
 
 
-class DeprecatedStatementRule(Rule):  # TODO: Split rule
+class DeprecatedStatementRule(Rule):
     """
     Statement is deprecated.
 
     Detects any piece of code that is marked as deprecated but still works in RF.
 
     For example, ``Run Keyword`` and ``Continue For Loop`` keywords or ``[Return]`` setting.
 
+    Changes in 8.0.0: Rule is now split into separate deprecated-* rules and the original rule is deprecated.
+
     """
 
     name = "deprecated-statement"
@@ -63,6 +65,7 @@ class DeprecatedStatementRule(Rule):  # TODO: Split rule
         clean_code=sonar_qube.CleanCodeAttribute.CONVENTIONAL, issue_type=sonar_qube.SonarQubeIssueType.CODE_SMELL
     )
     deprecated_names = ("0319",)
+    deprecated = True
 
 
 class DeprecatedWithNameRule(Rule):
@@ -360,3 +363,38 @@ class DeprecatedReturnKeyword(Rule):
     )
 
     deprecated_names = {"returnfromkeyword": "RETURN", "returnfromkeywordif": "IF and RETURN"}
+
+
+class DeprecatedReturnSetting(Rule):
+    """
+    ``[Return]`` settings is deprecated.
+
+    Use ``RETURN`` instead.
+
+    Incorrect code example:
+
+        *** Keywords ***
+        Return One Value
+            [Arguments]    ${arg}
+            ${value}    Convert To Upper Case    ${arg}
+            [Return]    ${value}
+
+    Correct code:
+
+        *** Keywords ***
+        Return One Value
+            [Arguments]    ${arg}
+            ${value}    Convert To Upper Case    ${arg}
+            RETURN    ${value}
+
+    """
+
+    name = "deprecated-return-setting"
+    rule_id = "DEPR10"
+    message = "'[Return]' is deprecated, use 'RETURN' instead"
+    severity = RuleSeverity.WARNING
+    version = ">=5.0"
+    added_in_version = "8.0.0"
+    sonar_qube_attrs = sonar_qube.SonarQubeAttributes(
+        clean_code=sonar_qube.CleanCodeAttribute.CONVENTIONAL, issue_type=sonar_qube.SonarQubeIssueType.CODE_SMELL
+    )

src/robocop/linter/rules/naming.py

@@ -1374,13 +1374,13 @@ def find_similar_variables(self, tokens, node, ignore_overwriting: bool = False)
 class DeprecatedStatementChecker(VisitorChecker):
     """Checker for deprecated statements."""
 
-    deprecated_statement: deprecated.DeprecatedStatementRule
     deprecated_with_name: deprecated.DeprecatedWithNameRule
     deprecated_singular_header: deprecated.DeprecatedSingularHeaderRule
     deprecated_force_tags: deprecated.DeprecatedForceTagsRule
     deprecated_run_keyword_if: deprecated.DeprecatedRunKeywordIfRule
     deprecated_loop_keyword: deprecated.DeprecatedLoopKeywordRule
     deprecated_return_keyword: deprecated.DeprecatedReturnKeyword
+    deprecated_return_setting: deprecated.DeprecatedReturnSetting
     replace_set_variable_with_var: deprecated.ReplaceSetVariableWithVarRule
     replace_create_with_var: deprecated.ReplaceCreateWithVarRule
 
@@ -1434,20 +1434,17 @@ def visit_Return(self, node) -> None:  # noqa: N802
         if ROBOT_VERSION.major not in (5, 6):
             return
         # TODO: check if our code for finding our return visitor would apply here
-        self.check_deprecated_return(node)
+        self.report_deprecated_return(node)
 
     def visit_ReturnSetting(self, node) -> None:  # noqa: N802
-        self.check_deprecated_return(node)
+        self.report_deprecated_return(node)
 
-    def check_deprecated_return(self, node) -> None:
+    def report_deprecated_return(self, node) -> None:
         self.report(
-            self.deprecated_statement,
-            statement_name="[Return]",
-            alternative="RETURN",
+            self.deprecated_return_setting,
             node=node,
             col=utils.token_col(node, Token.RETURN),
             end_col=node.end_col_offset,
-            version="5.*",
         )
 
     def visit_ForceTags(self, node) -> None:  # noqa: N802

…recated/deprecated_statement/__init__.py …ed/deprecated_return_setting/__init__.pytests/linter/rules/deprecated/deprecated_statement/__init__.py renamed to tests/linter/rules/deprecated/deprecated_return_setting/__init__.py tests/linter/rules/deprecated/deprecated_statement/__init__.py renamed to tests/linter/rules/deprecated/deprecated_return_setting/__init__.py

@@ -0,0 +1,9 @@
+test.robot:6:5 DEPR10 '[Return]' is deprecated, use 'RETURN' instead
+   |
+ 4 |     BuiltIn.Return From Keyword
+ 5 |     RETURN
+ 6 |     [Return]
+   |     ^^^^^^^^ DEPR10
+   |
+
+Found 1 issue.

tests/linter/rules/deprecated/deprecated_return_setting/expected_extended.txt

@@ -0,0 +1,3 @@
+test.robot:6:5 [W] DEPR10 '[Return]' is deprecated, use 'RETURN' instead
+
+Found 1 issue.