Add link to clang-tidy check docs to PR comments (#94)

Author: fandreuz

run_action.py

@@ -10,6 +10,7 @@
 import re
 import sys
 import time
+import urllib.parse
 
 import requests
 import yaml
@@ -181,6 +182,24 @@ def unescape_chars(s):
 
         return s
 
+    def markdown_url(label, url):
+        return f"[{label}]({url})"
+
+    def diagnostic_name_visual(diagnostic_name):
+        visual = f"**{markdown(diagnostic_name)}**"
+
+        try:
+            first_dash_idx = diagnostic_name.index("-")
+        except ValueError:
+            return visual
+
+        namespace = urllib.parse.quote_plus(diagnostic_name[:first_dash_idx])
+        check_name = urllib.parse.quote_plus(diagnostic_name[first_dash_idx + 1 :])
+        return markdown_url(
+            visual,
+            f"https://clang.llvm.org/extra/clang-tidy/checks/{namespace}/{check_name}.html",
+        )
+
     def generate_single_comment(
         file_path,
         start_line_num,
@@ -189,12 +208,12 @@ def generate_single_comment(
         message,
         single_comment_marker,
         replacement_text=None,
-    ):  # pylint: disable=too-many-arguments,too-many-positional-arguments
+    ):  # pylint: disable=too-many-arguments,too-many-positional-arguments,line-too-long
         result = {
             "path": file_path,
             "line": end_line_num,
             "side": "RIGHT",
-            "body": f"{single_comment_marker} **{markdown(name)}** {single_comment_marker}\n"
+            "body": f"{single_comment_marker} {diagnostic_name_visual(name)} {single_comment_marker}\n"
             + markdown(message),
         }