95 lines
3.1 KiB
Plaintext
95 lines
3.1 KiB
Plaintext
/**
|
|
* @fileoverview Enforce explicit role property is not the
|
|
* same as implicit default role property on element.
|
|
* @author Ethan Cohen <@evcohen>
|
|
*/
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// Requirements
|
|
// -----------------------------------------------------------------------------
|
|
|
|
import { RuleTester } from 'eslint';
|
|
import parserOptionsMapper from '../../__util__/parserOptionsMapper';
|
|
import parsers from '../../__util__/helpers/parsers';
|
|
import rule from '../../../src/rules/no-redundant-roles';
|
|
import ruleOptionsMapperFactory from '../../__util__/ruleOptionsMapperFactory';
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// Tests
|
|
// -----------------------------------------------------------------------------
|
|
|
|
const ruleTester = new RuleTester();
|
|
|
|
const expectedError = (element, implicitRole) => ({
|
|
message: `The element ${element} has an implicit role of ${implicitRole}. Defining this explicitly is redundant and should be avoided.`,
|
|
type: 'JSXOpeningElement',
|
|
});
|
|
|
|
const ruleName = 'jsx-a11y/no-redundant-roles';
|
|
|
|
const componentsSettings = {
|
|
'jsx-a11y': {
|
|
components: {
|
|
Button: 'button',
|
|
},
|
|
},
|
|
};
|
|
|
|
const alwaysValid = [
|
|
{ code: '<div />;' },
|
|
{ code: '<button role="main" />' },
|
|
{ code: '<MyComponent role="button" />' },
|
|
{ code: '<button role={`${foo}button`} />' },
|
|
{ code: '<Button role={`${foo}button`} />', settings: componentsSettings },
|
|
];
|
|
|
|
const neverValid = [
|
|
{ code: '<button role="button" />', errors: [expectedError('button', 'button')] },
|
|
{ code: '<body role="DOCUMENT" />', errors: [expectedError('body', 'document')] },
|
|
{ code: '<Button role="button" />', settings: componentsSettings, errors: [expectedError('button', 'button')] },
|
|
];
|
|
|
|
ruleTester.run(`${ruleName}:recommended`, rule, {
|
|
valid: parsers.all([].concat(
|
|
...alwaysValid,
|
|
{ code: '<nav role="navigation" />' },
|
|
))
|
|
.map(parserOptionsMapper),
|
|
invalid: parsers.all([].concat(
|
|
neverValid,
|
|
))
|
|
.map(parserOptionsMapper),
|
|
});
|
|
|
|
const noNavExceptionsOptions = { nav: [] };
|
|
const listException = { ul: ['list'], ol: ['list'] };
|
|
|
|
ruleTester.run(`${ruleName}:recommended`, rule, {
|
|
valid: parsers.all([].concat(
|
|
alwaysValid
|
|
.map(ruleOptionsMapperFactory(noNavExceptionsOptions)),
|
|
))
|
|
.map(parserOptionsMapper),
|
|
invalid: parsers.all([].concat(
|
|
...neverValid,
|
|
{ code: '<nav role="navigation" />', errors: [expectedError('nav', 'navigation')] },
|
|
))
|
|
.map(ruleOptionsMapperFactory(noNavExceptionsOptions))
|
|
.map(parserOptionsMapper),
|
|
});
|
|
|
|
ruleTester.run(`${ruleName}:recommended (valid list role override)`, rule, {
|
|
valid: parsers.all([].concat(
|
|
{ code: '<ul role="list" />' },
|
|
{ code: '<ol role="list" />' },
|
|
{ code: '<dl role="list" />' },
|
|
))
|
|
.map(ruleOptionsMapperFactory(listException))
|
|
.map(parserOptionsMapper),
|
|
invalid: parsers.all([].concat(
|
|
{ code: '<ul role="list" />', errors: [expectedError('ul', 'list')] },
|
|
{ code: '<ol role="list" />', errors: [expectedError('ol', 'list')] },
|
|
))
|
|
.map(parserOptionsMapper),
|
|
});
|