Feat/explicitly define help url for each rule

robocop/checkers/comments.py

@@ -9,6 +9,7 @@
 from robocop.checkers import RawFileChecker, VisitorChecker
 from robocop.rules import Rule, RuleParam, RuleSeverity
 from robocop.utils import ROBOT_VERSION
+from robocop.utils.misc import get_rule_help_url
 
 
 def regex(value):
@@ -48,6 +49,7 @@ def regex(value):
 
         """,
         added_in_version="1.0.0",
+        help_url=get_rule_help_url("default", "todo-in-comment"),
     ),
     "0702": Rule(
         RuleParam(
@@ -86,6 +88,7 @@ def regex(value):
 
         """,
         added_in_version="1.0.0",
+        help_url=get_rule_help_url("default", "missing-space-after-comment"),
     ),
     "0703": Rule(
         rule_id="0703",
@@ -106,6 +109,7 @@ def regex(value):
 
         """,
         added_in_version="1.0.0",
+        help_url=get_rule_help_url("default", "invalid-comment"),
     ),
     "0704": Rule(
         rule_id="0704",
@@ -135,6 +139,7 @@ def regex(value):
 
         """,
         added_in_version="1.3.0",
+        help_url=get_rule_help_url("default", "ignored-data"),
     ),
     "0705": Rule(
         rule_id="0705",
@@ -145,6 +150,7 @@ def regex(value):
         Some code editors can save Robot file using BOM encoding. Ensure that file is saved in UTF-8 encoding.
         """,
         added_in_version="1.7.0",
+        help_url=get_rule_help_url("default", "bom-encoding-in-file"),
     ),
 }
 

robocop/rules.py

@@ -298,6 +298,7 @@ def __init__(
         added_in_version: str | None = None,
         enabled: bool = True,
         deprecated: bool = False,
+        help_url: str = "",
     ):
         """
         :param params: RuleParam() or SeverityThreshold() instances
@@ -311,6 +312,7 @@ def __init__(
         :param added_in_version: Version of the Robocop when the Rule was created
         :param enabled: Enable/disable rule by default using this parameter
         :param deprecated: Deprecate rule. If rule is used in configuration, it will issue a warning.
+        :param help_url: URL to rule documentation or other help resource.
         """
         self.rule_id = rule_id
         self.name = name
@@ -342,6 +344,7 @@ def __init__(
         self.added_in_version = added_in_version
         self.community_rule = False
         self.category_id = None
+        self.help_url = help_url
 
     @property
     def severity(self):
@@ -487,6 +490,7 @@ def __init__(
         self.enabled = rule.enabled
         self.rule_id = rule.rule_id
         self.name = rule.name
+        self.help_url = rule.help_url
         self.severity = self.get_severity(overwrite_severity, rule, sev_threshold_value)
         self.desc = msg
         self.source = source

robocop/utils/misc.py

@@ -10,6 +10,7 @@
 from pathlib import Path
 from re import Pattern
 from tokenize import generate_tokens
+from typing import Literal
 
 import platformdirs
 from robot.api import Token
@@ -120,7 +121,7 @@ def issues_to_lsp_diagnostic(issues) -> list[dict]:
             "code": issue.rule_id,
             "source": "robocop",
             "message": issue.desc,
-            "codeDescription": {"href": f"{ROBOCOP_RULES_URL.format(version=__version__)}#{issue.name}"},
+            "codeDescription": {"href": issue.help_url},
         }
         for issue in issues
     ]
@@ -420,3 +421,15 @@ def parse_test_case_order_param(value: str) -> list:
         "teardown": Token.TEARDOWN,
     }
     return parse_order_comma_sep_list(value, mapping)
+
+
+def get_rule_help_url(type: Literal["default", "community"], rule_name: str):
+    base_url = f"https://robocop.readthedocs.io/en/{__version__}"
+
+    if type == "default":
+        return f"{base_url}/rules_list.html#{rule_name}"
+
+    if type == "community":
+        return f"{base_url}/community_rules.html#{rule_name}"
+
+    raise TypeError(f"Can't create help url for rule. Unexpected type '{type}'")