Introduce GitHub Alerts Style comment

service/commentutil/commentutil.go

@@ -1,6 +1,7 @@
 package commentutil
 
 import (
+ "bufio"
  "fmt"
  "log"
  "strings"
@@ -96,3 +97,59 @@
  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 GitHubAlertComemnt(c *reviewdog.Comment) string {
+ var sb strings.Builder
+ alert := githubAlert(c)
+ if alert != "" {
+ sb.WriteString(alert)
+ sb.WriteString("\n")
+ }
+ if tool := toolName(c); tool != "" {
+ sb.WriteString(fmt.Sprintf("**[%s]** ", tool))
+ }
+ if code := c.Result.Diagnostic.GetCode().GetValue(); code != "" {
+ if url := c.Result.Diagnostic.GetCode().GetUrl(); url != "" {
+ sb.WriteString(fmt.Sprintf("<[%s](%s)> ", code, url))
+ } else {
+ sb.WriteString(fmt.Sprintf("<%s> ", code))
+ }
+ }
+ sb.WriteString(c.Result.Diagnostic.GetMessage())
+ sb.WriteString("<p align='right'>")
+ sb.WriteString(BodyPrefix)
+ sb.WriteString("</p>")
+ if alert == "" {
+ return sb.String()
+ }
+ return toMarkdownQuote(sb.String())
+}
+
+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.GitHubAlertComemnt(c)
  if suggestion := buildSuggestions(c); suggestion != "" {
  cbody += "\n" + suggestion
  }