consistent-data-testid.js
4.11 KB
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RULE_NAME = void 0;
const create_testing_library_rule_1 = require("../create-testing-library-rule");
const node_utils_1 = require("../node-utils");
exports.RULE_NAME = 'consistent-data-testid';
const FILENAME_PLACEHOLDER = '{fileName}';
exports.default = (0, create_testing_library_rule_1.createTestingLibraryRule)({
name: exports.RULE_NAME,
meta: {
type: 'suggestion',
docs: {
description: 'Ensures consistent usage of `data-testid`',
recommendedConfig: {
dom: false,
angular: false,
react: false,
vue: false,
marko: false,
},
},
messages: {
consistentDataTestId: '`{{attr}}` "{{value}}" should match `{{regex}}`',
},
schema: [
{
type: 'object',
default: {},
additionalProperties: false,
required: ['testIdPattern'],
properties: {
testIdPattern: {
type: 'string',
},
testIdAttribute: {
default: 'data-testid',
oneOf: [
{
type: 'string',
},
{
type: 'array',
items: {
type: 'string',
},
},
],
},
},
},
],
},
defaultOptions: [
{
testIdPattern: '',
testIdAttribute: 'data-testid',
},
],
detectionOptions: {
skipRuleReportingCheck: true,
},
create: (context, [options]) => {
const { getFilename } = context;
const { testIdPattern, testIdAttribute: attr } = options;
function getFileNameData() {
var _a;
const splitPath = getFilename().split('/');
const fileNameWithExtension = (_a = splitPath.pop()) !== null && _a !== void 0 ? _a : '';
if (fileNameWithExtension.includes('[') ||
fileNameWithExtension.includes(']')) {
return { fileName: undefined };
}
const parent = splitPath.pop();
const fileName = fileNameWithExtension.split('.').shift();
return {
fileName: fileName === 'index' ? parent : fileName,
};
}
function getTestIdValidator(fileName) {
return new RegExp(testIdPattern.replace(FILENAME_PLACEHOLDER, fileName));
}
function isTestIdAttribute(name) {
var _a;
if (typeof attr === 'string') {
return attr === name;
}
else {
return (_a = attr === null || attr === void 0 ? void 0 : attr.includes(name)) !== null && _a !== void 0 ? _a : false;
}
}
return {
JSXIdentifier: (node) => {
if (!node.parent ||
!(0, node_utils_1.isJSXAttribute)(node.parent) ||
!(0, node_utils_1.isLiteral)(node.parent.value) ||
!isTestIdAttribute(node.name)) {
return;
}
const value = node.parent.value.value;
const { fileName } = getFileNameData();
const regex = getTestIdValidator(fileName !== null && fileName !== void 0 ? fileName : '');
if (value && typeof value === 'string' && !regex.test(value)) {
context.report({
node,
messageId: 'consistentDataTestId',
data: {
attr: node.name,
value,
regex,
},
});
}
},
};
},
});