/
no-distracting-elements.js
49 lines (41 loc) · 1.29 KB
/
no-distracting-elements.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/**
* @fileoverview Enforce distracting elements are not used.
* @author Ethan Cohen
*/
// ----------------------------------------------------------------------------
// Rule Definition
// ----------------------------------------------------------------------------
import { elementType } from 'jsx-ast-utils';
import { generateObjSchema, enumArraySchema } from '../util/schemas';
const errorMessage = (element) => (
`Do not use <${element}> elements as they can create visual accessibility issues and are deprecated.`
);
const DEFAULT_ELEMENTS = [
'marquee',
'blink',
];
const schema = generateObjSchema({
elements: enumArraySchema(DEFAULT_ELEMENTS),
});
export default {
meta: {
docs: {
url: 'https://github.com/evcohen/eslint-plugin-jsx-a11y/tree/master/docs/rules/no-distracting-elements.md',
},
schema: [schema],
},
create: (context) => ({
JSXOpeningElement: (node) => {
const options = context.options[0] || {};
const elementOptions = options.elements || DEFAULT_ELEMENTS;
const type = elementType(node);
const distractingElement = elementOptions.find((element) => type === element);
if (distractingElement) {
context.report({
node,
message: errorMessage(distractingElement),
});
}
},
}),
};