Allow exceptions to be configured (#27)

github · Dec 27, 2022 · 207b296 · 207b296
1 parent 5763159
commit 207b296
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/no-generic-link-text.js b/no-generic-link-text.js
@@ -19,9 +19,15 @@ module.exports = {
   tags: ["accessibility", "links"],
   function: function GH002(params, onError) {
     // markdown syntax
-    const allBannedLinkTexts = bannedLinkText.concat(
+    let bannedLinkTexts = bannedLinkText.concat(
       params.config.additional_banned_texts || []
     );
+    const exceptions = params.config.exceptions || [];
+    if (exceptions.length > 0) {
+      bannedLinkTexts = bannedLinkTexts.filter(
+        (text) => !exceptions.includes(text)
+      );
+    }
     const inlineTokens = params.tokens.filter((t) => t.type === "inline");
     for (const token of inlineTokens) {
       const { children } = token;
@@ -35,7 +41,7 @@ module.exports = {
           linkText = "";
         } else if (type === "link_close") {
           inLink = false;
-          if (allBannedLinkTexts.includes(stripAndDowncaseText(linkText))) {
+          if (bannedLinkTexts.includes(stripAndDowncaseText(linkText))) {
             onError({
               lineNumber: child.lineNumber,
               detail: `For link: ${linkText}`,

diff --git a/test/no-generic-link-text.test.js b/test/no-generic-link-text.test.js
@@ -75,5 +75,17 @@ describe("GH002: No Generic Link Text", () => {
 
       expect(failedRules).toHaveLength(1);
     });
+
+    test("exceptions can be configured", async () => {
+      const results = await runTest(
+        ["[Link](primer.style/components/Link)"],
+        noGenericLinkTextRule,
+        { exceptions: ["link"] }
+      );
+
+      for (const result of results) {
+        expect(result).not.toBeDefined();
+      }
+    });
   });
 });