-
-
Notifications
You must be signed in to change notification settings - Fork 153
/
requireParam.js
49 lines (45 loc) · 1.09 KB
/
requireParam.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
import iterateJsdoc from '../iterateJsdoc';
// eslint-disable-next-line complexity
export default iterateJsdoc(({
report,
utils
}) => {
const functionParameterNames = utils.getFunctionParameterNames();
const jsdocParameterNames = utils.getJsdocParameterNames();
if (!jsdocParameterNames) {
return;
}
if (utils.avoidDocs()) {
return;
}
// Param type is specified by type in @type
if (utils.hasTag('type')) {
return;
}
functionParameterNames.forEach((functionParameterName) => {
if (['<ObjectPattern>', '<ArrayPattern>'].includes(functionParameterName)) {
return;
}
if (!jsdocParameterNames.includes(functionParameterName)) {
report(`Missing JSDoc @${utils.getPreferredTagName({tagName: 'param'})} "${functionParameterName}" declaration.`);
}
});
}, {
meta: {
schema: [
{
additionalProperties: false,
properties: {
exemptedBy: {
items: {
type: 'string'
},
type: 'array'
}
},
type: 'object'
}
],
type: 'suggestion'
}
});