/
valid-suite-description.js
114 lines (94 loc) · 3.08 KB
/
valid-suite-description.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
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
'use strict';
const { getStringIfConstant } = require('eslint-utils');
/**
* @fileoverview Match suite descriptions to match a pre-configured regular expression
* @author Alexander Afanasyev
*/
const defaultSuiteNames = [ 'describe', 'context', 'suite' ];
function inlineOptions(options) {
const [
stringPattern,
suiteNames = defaultSuiteNames,
message
] = options;
const pattern = new RegExp(stringPattern, 'u');
return { pattern, suiteNames, message };
}
function objectOptions(options) {
const {
pattern: stringPattern,
suiteNames = defaultSuiteNames,
message
} = options;
const pattern = new RegExp(stringPattern, 'u');
return { pattern, suiteNames, message };
}
const patternSchema = {
type: 'string'
};
const suiteNamesSchema = {
type: 'array',
items: {
type: 'string'
}
};
const messageSchema = {
type: 'string'
};
module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'Require suite descriptions to match a pre-configured regular expression',
url: 'https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/docs/rules/valid-suite-description.md'
},
schema: [
{
oneOf: [ patternSchema, {
type: 'object',
properties: {
pattern: patternSchema,
suiteNames: suiteNamesSchema,
message: messageSchema
},
additionalProperties: false
} ]
},
suiteNamesSchema,
messageSchema
]
},
create(context) {
const options = context.options[0];
const { pattern, suiteNames, message } = typeof options === 'object' ?
objectOptions(options) :
inlineOptions(context.options);
function isSuite(node) {
return node.callee && node.callee.name && suiteNames.includes(node.callee.name);
}
function hasValidSuiteDescription(mochaCallExpression) {
const args = mochaCallExpression.arguments;
const descriptionArgument = args[0];
const description = getStringIfConstant(descriptionArgument, context.getScope());
if (description) {
return pattern.test(description);
}
return true;
}
function hasValidOrNoSuiteDescription(mochaCallExpression) {
const args = mochaCallExpression.arguments;
const hasNoSuiteDescription = args.length === 0;
return hasNoSuiteDescription || hasValidSuiteDescription(mochaCallExpression);
}
return {
CallExpression(node) {
const callee = node.callee;
if (isSuite(node)) {
if (!hasValidOrNoSuiteDescription(node)) {
context.report({ node, message: message || `Invalid "${ callee.name }()" description found.` });
}
}
}
};
}
};