feat: add emoji support for annotation severity ⚠️✅

microsoft · Nov 22, 2024 · 72a02dd · 72a02dd
1 parent dfbb3ba
commit 72a02dd
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/packages/core/src/annotations.ts b/packages/core/src/annotations.ts
@@ -4,6 +4,8 @@
  * of annotations into different formats for integration with CI/CD tools.
  */
 
+import { EMOJI_SUCCESS, EMOJI_WARNING } from "./constants"
+
 // Regular expression for matching GitHub Actions annotations.
 // Example: ::error file=foo.js,line=10,endLine=11::Something went wrong.
 const GITHUB_ANNOTATIONS_RX =
@@ -18,13 +20,20 @@ const AZURE_DEVOPS_ANNOTATIONS_RX =
 // Example: foo.ts:10:error TS1005: ';' expected.
 const TYPESCRIPT_ANNOTATIONS_RX =
     /^(?<file>[^:\s].*?):(?<line>\d+)(?::(?<endLine>\d+))?(?::\d+)?\s+-\s+(?<severity>error|warning)\s+(?<code>[^:]+)\s*:\s*(?<message>.*)$/gim
+
 // Maps severity strings to `DiagnosticSeverity`.
 const SEV_MAP: Record<string, DiagnosticSeverity> = Object.freeze({
     ["info"]: "info",
     ["notice"]: "info", // Maps 'notice' to 'info' severity
     ["warning"]: "warning",
     ["error"]: "error",
 })
+const SEV_EMOJI_MAP: Record<string, string> = Object.freeze({
+    ["info"]: "ℹ️",
+    ["notice"]: "ℹ️", // Maps 'notice' to 'info' severity
+    ["warning"]: EMOJI_WARNING,
+    ["error"]: EMOJI_SUCCESS,
+})
 
 /**
  * Parses annotations from TypeScript, GitHub Actions, and Azure DevOps.
@@ -82,7 +91,7 @@ export function convertAnnotationsToItems(text: string) {
                 const m = rx.exec(s)
                 if (!m) return s
                 const { file, line, severity, code, message } = m.groups
-                return `- ${SEV_MAP[severity?.toLowerCase()] ?? "info"}: ${message} (${file}#L${line} ${code || ""})`
+                return `- ${SEV_EMOJI_MAP[severity?.toLowerCase()] ?? "info"}: ${message} ([${file}#L${line}](${file}) ${code || ""})\n`
             }),
         text
     )

diff --git a/packages/core/src/constants.ts b/packages/core/src/constants.ts
@@ -159,6 +159,7 @@ export const STATS_DIR_NAME = "stats"
 
 export const EMOJI_SUCCESS = "✅"
 export const EMOJI_FAIL = "❌"
+export const EMOJI_WARNING = "⚠️"
 export const EMOJI_UNDEFINED = "?"
 
 export const MODEL_PROVIDER_OPENAI = "openai"