-
-
Notifications
You must be signed in to change notification settings - Fork 153
/
noMultiAsterisks.js
101 lines (90 loc) · 2.16 KB
/
noMultiAsterisks.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
import iterateJsdoc from '../iterateJsdoc';
const middleAsterisks = /^[* \t]+/u;
export default iterateJsdoc(({
context,
jsdoc,
utils,
}) => {
const {
preventAtEnd = true,
preventAtMiddleLines = true,
} = context.options[0] || {};
jsdoc.source.some(({tokens, number}) => {
const {
delimiter, tag, name, type, description, end,
} = tokens;
if (
preventAtMiddleLines &&
!end && !tag && !type && !name && middleAsterisks.test(description)
) {
const fix = () => {
tokens.description = description.replace(middleAsterisks, '');
};
utils.reportJSDoc(
'Should be no multiple asterisks on middle lines.',
{
line: number,
},
fix,
true,
);
return true;
}
if (!preventAtEnd || !end) {
return false;
}
const isSingleLineBlock = delimiter === '/**';
const delim = isSingleLineBlock ? '*' : delimiter;
const endAsterisks = isSingleLineBlock ?
/\*((?:\*|(?: |\t))*)\*$/u :
/((?:\*|(?: |\t))*)\*$/u;
const endingAsterisksAndSpaces = (description + delim).match(
endAsterisks,
);
if (
!endingAsterisksAndSpaces ||
!isSingleLineBlock && endingAsterisksAndSpaces[1] && !endingAsterisksAndSpaces[1].trim()
) {
return false;
}
const endFix = () => {
if (!isSingleLineBlock) {
tokens.delimiter = '';
}
tokens.description = (description + delim).replace(endAsterisks, '');
};
utils.reportJSDoc(
'Should be no multiple asterisks on end lines.',
{
line: number,
},
endFix,
true,
);
return true;
});
}, {
iterateAllJsdocs: true,
meta: {
docs: {
description: '',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-multi-asterisks',
},
fixable: 'code',
schema: [
{
additionalProperies: false,
properties: {
preventAtEnd: {
type: 'boolean',
},
preventAtMiddleLines: {
type: 'boolean',
},
},
type: 'object',
},
],
type: 'suggestion',
},
});