fix: ignore urns, hrefs, code blocks for rewrite-icons

fixes #348
adobe · Jul 18, 2023 · f90218b · f90218b
1 parent 4ec0c4d
commit f90218b
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 4 deletions.
diff --git a/src/steps/rewrite-icons.js b/src/steps/rewrite-icons.js
@@ -11,9 +11,9 @@
  */
 /* eslint-disable no-param-reassign */
 import { h } from 'hastscript';
-import { CONTINUE, visit } from 'unist-util-visit';
+import { CONTINUE, SKIP, visit } from 'unist-util-visit';
 
-const REGEXP_ICON = /:(#?[a-z_-]+[a-z\d]*):/gi;
+const REGEXP_ICON = /(?<!(?:https?|urn)[^\s]*):(#?[a-z_-]+[a-z\d]*):/gi;
 
 /**
  * Create a <span> icon element:
@@ -44,9 +44,13 @@ function createIcon(value) {
 export default function rewrite({ content }) {
   const { hast } = content;
   visit(hast, (node, idx, parent) => {
+    if (node.tagName === 'code') {
+      return SKIP;
+    }
     if (node.type !== 'text') {
       return CONTINUE;
     }
+
     const text = node.value;
     let lastIdx = 0;
     for (const match of text.matchAll(REGEXP_ICON)) {

diff --git a/test/fixtures/content/icons-ignored.html b/test/fixtures/content/icons-ignored.html
@@ -0,0 +1,9 @@
+<main>
+    <div>
+        <h1 id="icons">Icons</h1>
+        <p><code>:button:</code></p>
+        <pre><code>:rocket:</code></pre>
+        <p><a href="https://example.test/:urn:">https://example.test/:urn:</a></p>
+        <p>urn:aaid:sc:VA6C2:ac6066f3-fd1d-4e00-bed3-fa3aa6d981d8</p>
+    </div>
+</main>
diff --git a/test/fixtures/content/icons-ignored.md b/test/fixtures/content/icons-ignored.md
@@ -0,0 +1,11 @@
+# Icons
+
+`:button:`
+
+```
+:rocket:
+```
+
+[https://example.test/:urn:](https://example.test/:urn:)
+
+urn:aaid:sc:VA6C2:ac6066f3-fd1d-4e00-bed3-fa3aa6d981d8
diff --git a/test/fixtures/content/icons.html b/test/fixtures/content/icons.html
@@ -1,7 +1,9 @@
 <main>
-    <div><h1 id="icons">Icons</h1>
+    <div>
+        <h1 id="icons">Icons</h1>
         <p>Hello <span class="icon icon-button"></span></p>
         <p>Hello <span class="icon icon-red"></span> banner.</p>
         <p>Hello <span class="icon icon-check"></span> mark.</p>
+        <p>Team<span class="icon icon-rocket"></span>blasting off again.</p>
     </div>
-</main>
+</main>
diff --git a/test/fixtures/content/icons.md b/test/fixtures/content/icons.md
@@ -5,3 +5,5 @@ Hello :button:
 Hello :red: banner.
 
 Hello :#check: mark.
+
+Team:rocket:blasting off again.
diff --git a/test/rendering.test.js b/test/rendering.test.js
@@ -129,6 +129,10 @@ describe('Rendering', () => {
     it('renders icons.md correctly', async () => {
       await testRender('icons', 'main');
     });
+
+    it('renders icons-ignored.md correctly', async () => {
+      await testRender('icons-ignored', 'main');
+    });
   });
 
   describe('Headings', () => {
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,5 @@ Hello :button:
		Hello :red: banner.

		Hello :#check: mark.

		Team:rocket:blasting off again.