Permalink
Cannot retrieve contributors at this time
61 lines (54 sloc)
2.17 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-role-supports-aria-props.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
// @ts-check | |
const {aria, roles} = require('aria-query') | |
const {getPropValue, propName} = require('jsx-ast-utils') | |
const {getRole} = require('../utils/get-role') | |
module.exports = { | |
meta: { | |
docs: { | |
description: | |
'Enforce that elements with explicit or implicit roles defined contain only `aria-*` properties supported by that `role`.', | |
url: require('../url')(module), | |
}, | |
schema: [], | |
}, | |
create(context) { | |
return { | |
JSXOpeningElement(node) { | |
// Get the element’s explicit or implicit role | |
const role = getRole(context, node) | |
// Return early if role could not be determined | |
if (!role) return | |
// Get allowed ARIA attributes: | |
// - From the role itself | |
let allowedProps = Object.keys(roles.get(role)?.props || {}) | |
// - From parent roles | |
for (const parentRole of roles.get(role)?.superClass.flat() ?? []) { | |
allowedProps = allowedProps.concat(Object.keys(roles.get(parentRole)?.props || {})) | |
} | |
// Dedupe, for performance | |
allowedProps = Array.from(new Set(allowedProps)) | |
// Get prohibited ARIA attributes: | |
// - From the role itself | |
let prohibitedProps = roles.get(role)?.prohibitedProps || [] | |
// - From parent roles | |
for (const parentRole of roles.get(role)?.superClass.flat() ?? []) { | |
prohibitedProps = prohibitedProps.concat(roles.get(parentRole)?.prohibitedProps || []) | |
} | |
// - From comparing allowed vs all ARIA attributes | |
prohibitedProps = prohibitedProps.concat(aria.keys().filter(x => !allowedProps.includes(x))) | |
// Dedupe, for performance | |
prohibitedProps = Array.from(new Set(prohibitedProps)) | |
for (const prop of node.attributes) { | |
// Return early if prohibited ARIA attribute is set to an ignorable value | |
if (getPropValue(prop) == null || prop.type === 'JSXSpreadAttribute') return | |
if (prohibitedProps?.includes(propName(prop))) { | |
context.report({ | |
node, | |
message: `The attribute ${propName(prop)} is not supported by the role ${role}.`, | |
}) | |
} | |
} | |
}, | |
} | |
}, | |
} |