Support GitHub alerts in tag annotations

Closes #126
ghalactic · Mar 7, 2024 · 7d31410 · 7d31410
1 parent 06f9b54
commit 7d31410
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 3 deletions.
diff --git a/dist/main.js b/dist/main.js
diff --git a/dist/main.js.map b/dist/main.js.map
diff --git a/src/markdown.ts b/src/markdown.ts
@@ -1,18 +1,28 @@
+import { Node } from "mdast";
 import { remark } from "remark";
 import remarkGfm from "remark-gfm";
 import { visit } from "unist-util-visit";
 
+const ALERT_PATTERN =
+  /(\[!(?:CAUTION|IMPORTANT|NOTE|TIP|WARNING)])(?!\s*$)(\s*)/gm;
 const SOFT_BREAK_PATTERN = /$[^$]/gms;
 
 export function createProcessor(): (original: string) => Promise<string> {
   const createRemark = remark()
     .use(remarkGfm)
-    // strip soft breaks
     .use(() => {
       return (tree) => {
+        // strip soft breaks
         visit(tree, "text", (node: { value: string }) => {
           node.value = node.value.replace(SOFT_BREAK_PATTERN, " ");
         });
+
+        // preserve GitHub alerts
+        visit(tree, "blockquote", (node: Node) => {
+          visit(node, "text", (node: { value: string }) => {
+            node.value = node.value.replace(ALERT_PATTERN, "$1\n");
+          });
+        });
       };
     })
     .freeze();

diff --git a/test/fixture/markdown-processor/gfm/expected.md b/test/fixture/markdown-processor/gfm/expected.md
@@ -1,5 +1,22 @@
 # GFM
 
+## Alerts
+
+> \[!NOTE]
+> Useful information that users should know, even when skimming content.
+
+> \[!TIP]
+> Helpful advice for doing things better or more easily.
+
+> \[!IMPORTANT]
+> Key information users need to know to achieve their goal.
+
+> \[!WARNING]
+> Urgent info that needs immediate user attention to avoid problems.
+
+> \[!CAUTION]
+> Advises about risks or negative outcomes of certain actions.
+
 ## Autolink literals
 
 [www.example.com](http://www.example.com), <https://example.com>, and <[email protected]>.

diff --git a/test/fixture/markdown-processor/gfm/input.md b/test/fixture/markdown-processor/gfm/input.md
@@ -1,5 +1,22 @@
 # GFM
 
+## Alerts
+
+> [!NOTE]
+> Useful information that users should know, even when skimming content.
+
+> [!TIP]
+> Helpful advice for doing things better or more easily.
+
+> [!IMPORTANT]
+> Key information users need to know to achieve their goal.
+
+> [!WARNING]
+> Urgent info that needs immediate user attention to avoid problems.
+
+> [!CAUTION]
+> Advises about risks or negative outcomes of certain actions.
+
 ## Autolink literals
 
 www.example.com, https://example.com, and [email protected].

diff --git a/test/suite/e2e/happy-path.spec.ts b/test/suite/e2e/happy-path.spec.ts
@@ -70,6 +70,9 @@ one
 paragraph
 
 @actions
+
+> [!IMPORTANT]
+> this should be an alert
 `;
 
     const config = `assets:
@@ -186,6 +189,7 @@ paragraph
       ${"markdown heading 2"}  | ${`//h2[normalize-space()='Heading 2']`}
       ${"markdown paragraphs"} | ${`//*[normalize-space()='this should form one paragraph']`}
       ${"mention"}             | ${`//a[@href='https://github.com/actions'][normalize-space()='@actions']`}
+      ${"alert"}               | ${`//*[contains(concat(' ', normalize-space(@class), ' '), ' markdown-alert-important ')]/p[not(contains(concat(' ', normalize-space(@class), ' '), ' markdown-alert-title '))][normalize-space()='this should be an alert']`}
       ${"release notes"}       | ${`//*[normalize-space()='Full Changelog: https://github.com/${owner}/${repo}/commits/${tagName}']`}
     `(
       "should produce the expected release body elements ($description)",