forked from gajus/eslint-plugin-jsdoc
-
Notifications
You must be signed in to change notification settings - Fork 1
/
requireExample.js
91 lines (82 loc) · 1.95 KB
/
requireExample.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
import _ from 'lodash';
import iterateJsdoc from '../iterateJsdoc';
export default iterateJsdoc(({
context,
jsdoc,
report,
utils,
}) => {
if (utils.avoidDocs()) {
return;
}
const {
exemptNoArguments = false,
} = context.options[0] || {};
const targetTagName = 'example';
const functionExamples = _.filter(jsdoc.tags, {
tag: targetTagName,
});
if (!functionExamples.length) {
if (exemptNoArguments && utils.isIteratingFunction() &&
!utils.hasParams()
) {
return;
}
utils.reportJSDoc(`Missing JSDoc @${targetTagName} declaration.`, null, () => {
utils.addTag(targetTagName);
});
return;
}
functionExamples.forEach((example) => {
const exampleContent = _.compact(`${example.name} ${utils.getTagDescription(example)}`.trim().split('\n'));
if (!exampleContent.length) {
report(`Missing JSDoc @${targetTagName} description.`);
}
});
}, {
contextDefaults: true,
meta: {
docs: {
description: 'Requires that all functions have examples.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-example',
},
fixable: 'code',
schema: [
{
additionalProperties: false,
properties: {
checkConstructors: {
default: true,
type: 'boolean',
},
checkGetters: {
default: false,
type: 'boolean',
},
checkSetters: {
default: false,
type: 'boolean',
},
contexts: {
items: {
type: 'string',
},
type: 'array',
},
exemptedBy: {
items: {
type: 'string',
},
type: 'array',
},
exemptNoArguments: {
default: false,
type: 'boolean',
},
},
type: 'object',
},
],
type: 'suggestion',
},
});