Permalink
Cannot retrieve contributors at this time
73 lines (64 sloc)
2.38 KB
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/eslint-plugin-github/lib/rules/a11y-no-generic-link-text.js
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains 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
const {getProp, getPropValue} = require('jsx-ast-utils') | |
const {getElementType} = require('../utils/get-element-type') | |
const bannedLinkText = ['read more', 'here', 'click here', 'learn more', 'more'] | |
/* Downcase and strip extra whitespaces and punctuation */ | |
const stripAndDowncaseText = text => { | |
return text | |
.toLowerCase() | |
.replace(/[.,/#!$%^&*;:{}=\-_`~()]/g, '') | |
.replace(/\s{2,}/g, ' ') | |
.trim() | |
} | |
module.exports = { | |
meta: { | |
docs: { | |
description: 'disallow generic link text', | |
url: require('../url')(module), | |
}, | |
deprecated: true, | |
replacedBy: ['jsx-a11y/anchor-ambiguous-text'], | |
schema: [], | |
}, | |
create(context) { | |
return { | |
JSXOpeningElement: node => { | |
const elementType = getElementType(context, node) | |
if (elementType !== 'a') return | |
if (getProp(node.attributes, 'aria-labelledby')) return | |
let cleanTextContent // text content we can reliably fetch | |
const parent = node.parent | |
let jsxTextNode | |
if (parent.children && parent.children.length > 0 && parent.children[0].type === 'JSXText') { | |
jsxTextNode = parent.children[0] | |
cleanTextContent = stripAndDowncaseText(parent.children[0].value) | |
} | |
const ariaLabel = getPropValue(getProp(node.attributes, 'aria-label')) | |
const cleanAriaLabelValue = ariaLabel && stripAndDowncaseText(ariaLabel) | |
if (ariaLabel) { | |
if (bannedLinkText.includes(cleanAriaLabelValue)) { | |
context.report({ | |
node, | |
message: | |
'Avoid setting generic link text like `Here`, `Click here`, `Read more`. Make sure that your link text is both descriptive and concise.', | |
}) | |
} | |
if (cleanTextContent && !cleanAriaLabelValue.includes(cleanTextContent)) { | |
context.report({ | |
node, | |
message: 'When using ARIA to set a more descriptive text, it must fully contain the visible label.', | |
}) | |
} | |
} else { | |
if (cleanTextContent) { | |
if (!bannedLinkText.includes(cleanTextContent)) return | |
context.report({ | |
node: jsxTextNode, | |
message: | |
'Avoid setting generic link text like `Here`, `Click here`, `Read more`. Make sure that your link text is both descriptive and concise.', | |
}) | |
} | |
} | |
}, | |
} | |
}, | |
} |