Add no-generic-link-text rule #10
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| /* Downcase and strip extra whitespaces and punctuation */ | ||
| function stripAndDowncaseText(text) { | ||
| return text | ||
| .toLowerCase() | ||
| .replace(/[.,/#!$%^&*;:{}=\-_`~()]/g, "") | ||
| .replace(/\s+/g, " ") | ||
| .trim(); | ||
| } | ||
|
|
||
| module.exports = { stripAndDowncaseText }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| const { stripAndDowncaseText } = require("./helpers/strip-and-downcase-text"); | ||
|
|
||
| const bannedLinkText = [ | ||
| "read more", | ||
| "learn more", | ||
| "more", | ||
| "here", | ||
| "click here", | ||
| "link", | ||
| ]; | ||
|
|
||
| module.exports = { | ||
| names: ["GH002", "no-generic-link-text"], | ||
| description: | ||
| "Avoid using generic link text like `Learn more` or `Click here`", | ||
| information: new URL( | ||
| "https://primer.style/design/accessibility/links#writing-link-text" | ||
| ), | ||
| tags: ["accessibility", "links"], | ||
| function: function GH002(params, onError) { | ||
| // markdown syntax | ||
| const allBannedLinkTexts = bannedLinkText.concat( | ||
| params.config.additional_banned_texts || [] | ||
|
There was a problem hiding this comment. I'm using snake case to follow the convention set in |
||
| ); | ||
| const inlineTokens = params.tokens.filter((t) => t.type === "inline"); | ||
|
There was a problem hiding this comment. I found markdown-it demo and using the Additionally, I referenced: md042. |
||
| for (const token of inlineTokens) { | ||
| const { children } = token; | ||
| let inLink = false; | ||
| let linkText = ""; | ||
|
|
||
| for (const child of children) { | ||
| const { content, type } = child; | ||
| if (type === "link_open") { | ||
| inLink = true; | ||
| linkText = ""; | ||
| } else if (type === "link_close") { | ||
| inLink = false; | ||
| if (allBannedLinkTexts.includes(stripAndDowncaseText(linkText))) { | ||
| onError({ | ||
| lineNumber: child.lineNumber, | ||
| detail: `For link: ${linkText}`, | ||
| }); | ||
| } | ||
| } else if (inLink) { | ||
| linkText += content; | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| const { | ||
| stripAndDowncaseText, | ||
| } = require("../../helpers/strip-and-downcase-text"); | ||
|
|
||
| describe("stripAndDowncaseText", () => { | ||
| test("strips extra whitespace", () => { | ||
| expect(stripAndDowncaseText(" read more ")).toBe("read more"); | ||
| expect(stripAndDowncaseText(" learn ")).toBe("learn"); | ||
| }); | ||
|
|
||
| test("strips punctuation", () => { | ||
| expect(stripAndDowncaseText("learn more!!!!")).toBe("learn more"); | ||
| expect(stripAndDowncaseText("I like dogs...")).toBe("i like dogs"); | ||
| }); | ||
|
|
||
| test("downcases text", () => { | ||
| expect(stripAndDowncaseText("HeRe")).toBe("here"); | ||
| expect(stripAndDowncaseText("CLICK HERE")).toBe("click here"); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| const noGenericLinkTextRule = require("../no-generic-link-text"); | ||
| const runTest = require("./utils/run-test").runTest; | ||
|
|
||
| describe("GH002: No Generic Link Text", () => { | ||
| describe("successes", () => { | ||
| test("inline", async () => { | ||
| const strings = [ | ||
| "[GitHub](https://www.github.com)", | ||
| "[Read more about GitHub](https://www.github.com/about)", | ||
| "[](www.github.com)", | ||
| "", | ||
| ` | ||
| ## Hello | ||
| I am not a link, and unrelated. | ||
|  | ||
| `, | ||
| ]; | ||
|
|
||
| const results = await runTest(strings, noGenericLinkTextRule); | ||
|
|
||
| for (const result of results) { | ||
| expect(result).not.toBeDefined(); | ||
| } | ||
| }); | ||
| }); | ||
| describe("failures", () => { | ||
| 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)", | ||
| ]; | ||
|
|
||
| const results = await runTest(strings, noGenericLinkTextRule); | ||
|
|
||
| const failedRules = results | ||
| .map((result) => result.ruleNames) | ||
| .flat() | ||
| .filter((name) => !name.includes("GH")); | ||
|
|
||
| expect(failedRules).toHaveLength(8); | ||
| for (const rule of failedRules) { | ||
| expect(rule).toBe("no-generic-link-text"); | ||
| } | ||
| }); | ||
|
|
||
| test("error message", async () => { | ||
| const strings = ["[Click here](www.github.com)"]; | ||
|
|
||
| const results = await runTest(strings, noGenericLinkTextRule); | ||
|
|
||
| expect(results[0].ruleDescription).toMatch( | ||
| /Avoid using generic link text like `Learn more` or `Click here`/ | ||
| ); | ||
| expect(results[0].errorDetail).toBe("For link: Click here"); | ||
| }); | ||
|
|
||
| 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); | ||
| }); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| const markdownlint = require("markdownlint"); | ||
khiga8 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| async function runTest(strings, rule, ruleConfig) { | ||
| const thisRuleName = rule.names[1]; | ||
|
|
||
| const config = { | ||
| config: { | ||
| default: false, | ||
| [thisRuleName]: ruleConfig || true, | ||
| }, | ||
| customRules: [rule], | ||
| }; | ||
|
|
||
| return await Promise.all( | ||
| strings.map((variation) => { | ||
| const thisTestConfig = { | ||
| ...config, | ||
| strings: [variation], | ||
| }; | ||
|
|
||
| return new Promise((resolve, reject) => { | ||
| markdownlint(thisTestConfig, (err, result) => { | ||
| if (err) reject(err); | ||
| resolve(result[0][0]); | ||
| }); | ||
| }); | ||
| }) | ||
| ); | ||
| } | ||
|
|
||
| exports.runTest = runTest; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be possible or worth making this work for various languages?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This plugin doesn't currently have i18n support, but I added support so people can additionally configure text so they can through that!
Related: #10 (comment)
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we will want to address i18n in a separate issue! I'll make an issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i18n Issue!