Allow rule params to be configured

Author: khiga8

no-generic-link-text.js

@@ -12,7 +12,7 @@ const stripAndDowncaseText = (text) => {
   return text
     .toLowerCase()
     .replace(/[.,/#!$%^&*;:{}=\-_`~()]/g, "")
-    .replace(/\s{2,}/g, " ")
+    .replace(/\s+/g, " ")
     .trim();
 };
 
@@ -27,7 +27,7 @@ module.exports = {
   function: function GH002(params, onError) {
     // markdown syntax
     const allBannedLinkTexts = bannedLinkText.concat(
-      params.config.banned_link_texts || []
+      params.config.additional_banned_texts || []
     );
     const inlineTokens = params.tokens.filter((t) => t.type === "inline");
     for (const token of inlineTokens) {

test/no-generic-link-text.test.js

@@ -9,7 +9,11 @@ describe("GH002: No Generic Link Text", () => {
         "[Read more about GitHub](https://www.github.com/about)",
         "[](www.github.com)",
         "![Image](www.github.com)",
-        "I am not a link, and unrelated",
+        `
+        ## Hello
+        I am not a link, and unrelated.
+        ![GitHub](some_image.png)
+        `,
       ];
 
       const results = await runTest(strings, noGenericLinkTextRule);
@@ -20,12 +24,13 @@ describe("GH002: No Generic Link Text", () => {
     });
   });
   describe("failures", () => {
-    test("markdown example", async () => {
+    test("inline", async () => {
       const strings = [
         "[Click here](www.github.com)",
         "[here](www.github.com)",
         "Please [read more](www.github.com)",
         "[more](www.github.com)",
+        "[link](www.github.com)",
         "You may [learn more](www.github.com) at GitHub",
         "[learn more.](www.github.com)",
         "[click here!](www.github.com)",
@@ -38,10 +43,26 @@ describe("GH002: No Generic Link Text", () => {
         .flat()
         .filter((name) => !name.includes("GH"));
 
-      expect(failedRules).toHaveLength(7);
+      expect(failedRules).toHaveLength(8);
       for (const rule of failedRules) {
         expect(rule).toBe("no-generic-link-text");
       }
     });
+
+    test("additional words can be configured", async () => {
+      const results = await runTest(
+        ["[something](www.github.com)"],
+        noGenericLinkTextRule,
+        // eslint-disable-next-line camelcase
+        { additional_banned_texts: ["something"] }
+      );
+
+      const failedRules = results
+        .map((result) => result.ruleNames)
+        .flat()
+        .filter((name) => !name.includes("GH"));
+
+      expect(failedRules).toHaveLength(1);
+    });
   });
 });

test/utils/run-test.js

@@ -1,12 +1,12 @@
 const markdownlint = require("markdownlint");
 
-async function runTest(strings, rule) {
+async function runTest(strings, rule, ruleConfig) {
   const thisRuleName = rule.names[1];
 
   const config = {
     config: {
       default: false,
-      [thisRuleName]: true,
+      [thisRuleName]: ruleConfig || true,
     },
     customRules: [rule],
   };