Bump aria-query and update to fix tests #448
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
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,93 @@ | ||
| const {getProp, getPropValue} = require('jsx-ast-utils') | ||
|
There was a problem hiding this comment. I would appreciate @smockle eyes on this! I extracted the code into this helper, and made updates to fix the bug. |
||
| const {elementRoles} = require('aria-query') | ||
| const {getElementType} = require('./get-element-type') | ||
| const ObjectMap = require('./object-map') | ||
|
|
||
| // Clean-up `elementRoles` from `aria-query` | ||
| const elementRolesMap = new ObjectMap() | ||
|
There was a problem hiding this comment. This code is constructing a cleaned up version of elementRoles. Below, we'll be constructing a key and grabbing the value from |
||
| for (const [key, value] of elementRoles.entries()) { | ||
| // - Remove unused `constraints` key | ||
| delete key.constraints | ||
|
There was a problem hiding this comment. Is this line still necessary? There was a problem hiding this comment. Oooh nice catch! It looks like removing this constraints can result in incorrect mappings in some scenarios... For example, If we remove the constraints key, we're left with: Since we cannot always accurately parse out the role of an ancestor in a linter context, I think we'd want to return undefined instead of potentially returning a false positive role. I will follow-up! There was a problem hiding this comment. I deleted this line in 8fb6419! However, there were two scenarios where it seemed appropriate to assume the role despite the constraints defined in I've added additional tests in aaca700#diff-a6b7fa0d4a2be411ccfcc6e6db5466c135100a1a045599f5c211bb91c37b839dR180-R190. |
||
| // - Remove empty `attributes` key | ||
| if (!key.attributes || key.attributes?.length === 0) { | ||
| delete key.attributes | ||
| } | ||
| elementRolesMap.set(key, value) | ||
| } | ||
| // - Remove insufficiently-disambiguated `menuitem` entry | ||
| elementRolesMap.delete({name: 'menuitem'}) | ||
| // - Disambiguate `menuitem` and `menu` roles by `type` | ||
| elementRolesMap.set({name: 'menuitem', attributes: [{name: 'type', value: 'command'}]}, ['menuitem']) | ||
| elementRolesMap.set({name: 'menuitem', attributes: [{name: 'type', value: 'radio'}]}, ['menuitemradio']) | ||
| elementRolesMap.set({name: 'menuitem', attributes: [{name: 'type', value: 'toolbar'}]}, ['toolbar']) | ||
| elementRolesMap.set({name: 'menu', attributes: [{name: 'type', value: 'toolbar'}]}, ['toolbar']) | ||
|
|
||
| /* | ||
| Determine role of an element, based on its name and attributes. | ||
| */ | ||
| function getRole(context, node) { | ||
| // Early return if role is explicitly set | ||
| const explicitRole = getPropValue(getProp(node.attributes, 'role')) | ||
| if (explicitRole) { | ||
| return explicitRole | ||
| } | ||
|
|
||
| // Assemble a key for looking-up the element’s role in the `elementRolesMap` | ||
| // - Get the element’s name | ||
| const key = {name: getElementType(context, node)} | ||
|
|
||
| for (const prop of [ | ||
| 'aria-label', | ||
| 'aria-labelledby', | ||
| 'alt', | ||
| 'type', | ||
| 'size', | ||
| 'role', | ||
| 'href', | ||
| 'multiple', | ||
| 'scope', | ||
| 'name', | ||
| ]) { | ||
| if ((prop === 'aria-labelledby' || prop === 'aria-label') && !['section', 'aside', 'form'].includes(key.name)) | ||
| continue | ||
| if (prop === 'name' && key.name !== 'form') continue | ||
| if (prop === 'href' && key.name !== 'a' && key.name !== 'area') continue | ||
| if (prop === 'alt' && key.name !== 'img') continue | ||
|
|
||
| const propOnNode = getProp(node.attributes, prop) | ||
|
|
||
| if (!('attributes' in key)) { | ||
| key.attributes = [] | ||
| } | ||
| // Disambiguate "undefined" props | ||
| if (propOnNode === undefined && prop === 'alt' && key.name === 'img') { | ||
| key.attributes.push({name: prop, constraints: ['undefined']}) | ||
| continue | ||
| } | ||
|
|
||
| const value = getPropValue(propOnNode) | ||
| if (value || (value === '' && prop === 'alt')) { | ||
| if ( | ||
| prop === 'href' || | ||
| prop === 'aria-labelledby' || | ||
| prop === 'aria-label' || | ||
| prop === 'name' || | ||
| (prop === 'alt' && value !== '') | ||
| ) { | ||
| key.attributes.push({name: prop, constraints: ['set']}) | ||
| } else { | ||
| key.attributes.push({name: prop, value}) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // - Remove empty `attributes` key | ||
| if (!key.attributes || key.attributes?.length === 0) { | ||
| delete key.attributes | ||
| } | ||
|
|
||
| // Get the element’s implicit role | ||
| return elementRolesMap.get(key)?.[0] | ||
| } | ||
|
|
||
| module.exports = {getRole} | ||
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
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
Oops, something went wrong.
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.
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'm extracting this entire section a new helper called
getRole, with tests.