Introduce GitHub Alerts Style comment

_testdata/custom.txt

@@ -15,3 +15,8 @@
 function f()
 {
 }
+
+# Severity test
+test INFO
+test WARNING
+test ERROR

_testdata/custom_rdjson.json

@@ -82,33 +82,33 @@
  "path": "_testdata/custom.txt",
  "range": {
  "start": {
- "line": 3,
+ "line": 20,
  "column": 5
  }
  }
  },
  "severity": "INFO"
  },
  {
- "message": "severity test 2 (INFO)",
+ "message": "severity test 2 (INFO by number)",
  "location": {
  "path": "_testdata/custom.txt",
  "range": {
  "start": {
- "line": 3,
+ "line": 20,
  "column": 4
  }
  }
  },
- "severity": 2
+ "severity": 1
  },
  {
  "message": "severity test 3 (WARNING)",
  "location": {
  "path": "_testdata/custom.txt",
  "range": {
  "start": {
- "line": 3,
+ "line": 20,
  "column": 5
  }
  }
@@ -121,7 +121,7 @@
  "path": "_testdata/custom.txt",
  "range": {
  "start": {
- "line": 3,
+ "line": 20,
  "column": 5
  }
  }

service/commentutil/commentutil.go

@@ -1,6 +1,7 @@
 package commentutil
 
 import (
+ "bufio"
  "fmt"
  "log"
  "strings"
@@ -96,3 +97,36 @@ func severity(c *reviewdog.Comment) string {
  return ""
  }
 }
+
+// GitHubAlertComment creates a markdown comment using GitHub Alerts syntax.
+// https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
+func GitHubAlertComment(c *reviewdog.Comment) string {
+ return "> " + githubAlert(c) + "\n" + toMarkdownQuote(MarkdownComment(c))
+}
+
+func toMarkdownQuote(str string) string {
+ var sb strings.Builder
+ scanner := bufio.NewScanner(strings.NewReader(str))
+ for scanner.Scan() {
+ sb.WriteString("> ")
+ sb.Write(scanner.Bytes())
+ sb.WriteRune('\n')
+ }
+ return sb.String()
+}
+
+func githubAlert(c *reviewdog.Comment) string {
+ // TODO: Maybe we should support TIP and IMPORTANT severity.
+ switch c.Result.Diagnostic.GetSeverity() {
+ case rdf.Severity_ERROR:
+ return "[!CAUTION]"
+ case rdf.Severity_WARNING:
+ return "[!WARNING]"
+ case rdf.Severity_INFO:
+ return "[!NOTE]"
+ default:
+ // I'm not 100% sure what's the best default alert notation, but let's use
+ // warning as default.
+ return "[!WARNING]"
+ }
+}

service/github/github.go

@@ -350,7 +350,7 @@ func listAllPullRequestsComments(ctx context.Context, cli *github.Client,
 }
 
 func buildBody(c *reviewdog.Comment) string {
- cbody := commentutil.MarkdownComment(c)
+ cbody := commentutil.GitHubAlertComment(c)
  if suggestion := buildSuggestions(c); suggestion != "" {
  cbody += "\n" + suggestion
  }