-
-
Notifications
You must be signed in to change notification settings - Fork 153
/
tagLines.js
156 lines (140 loc) · 3.75 KB
/
tagLines.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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
import iterateJsdoc from '../iterateJsdoc';
export default iterateJsdoc(({
context,
jsdoc,
utils,
}) => {
const [
alwaysNever = 'never',
{
count = 1,
noEndLines = false,
tags = {},
} = {},
] = context.options;
jsdoc.tags.some((tg, tagIdx) => {
let lastTag;
let reportIndex = null;
tg.source.forEach(({tokens: {tag, name, type, description, end}}, idx) => {
// May be text after a line break within a tag description
if (description) {
reportIndex = null;
}
if (lastTag && tags[lastTag.slice(1)]?.lines === 'always') {
return;
}
if (
!tag && !name && !type && !description && !end &&
(alwaysNever === 'never' ||
lastTag && tags[lastTag.slice(1)]?.lines === 'never'
)
) {
reportIndex = idx;
return;
}
lastTag = tag;
});
if (reportIndex !== null) {
const fixer = () => {
utils.removeTagItem(tagIdx, reportIndex);
};
utils.reportJSDoc(
'Expected no lines between tags',
{line: tg.source[0].number + 1},
fixer,
);
return true;
}
return false;
});
(noEndLines ? jsdoc.tags.slice(0, -1) : jsdoc.tags).some((tg, tagIdx) => {
const lines = [];
let currentTag;
let tagSourceIdx = 0;
tg.source.forEach(({number, tokens: {tag, name, type, description, end}}, idx) => {
if (description) {
lines.splice(0, lines.length);
tagSourceIdx = idx;
}
if (tag) {
currentTag = tag;
}
if (!tag && !name && !type && !description && !end) {
lines.push({idx, number});
}
});
const currentTg = currentTag && tags[currentTag.slice(1)];
const tagCount = currentTg?.count;
const defaultAlways = alwaysNever === 'always' && currentTg?.lines !== 'never' &&
currentTg?.lines !== 'any' && lines.length < count;
let overrideAlways;
let fixCount = count;
if (!defaultAlways) {
fixCount = typeof tagCount === 'number' ? tagCount : count;
overrideAlways = currentTg?.lines === 'always' &&
lines.length < fixCount;
}
if (defaultAlways || overrideAlways) {
const fixer = () => {
utils.addLines(tagIdx, lines[lines.length - 1]?.idx || tagSourceIdx + 1, fixCount - lines.length);
};
const line = lines[lines.length - 1]?.number || tg.source[tagSourceIdx].number;
utils.reportJSDoc(
`Expected ${fixCount} line${fixCount === 1 ? '' : 's'} between tags but found ${lines.length}`,
{
line,
},
fixer,
);
return true;
}
return false;
});
}, {
iterateAllJsdocs: true,
meta: {
docs: {
description: 'Enforces lines (or no lines) between tags.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-tag-lines',
},
fixable: 'code',
schema: [
{
enum: ['always', 'any', 'never'],
type: 'string',
},
{
additionalProperies: false,
properties: {
count: {
type: 'integer',
},
noEndLines: {
type: 'boolean',
},
tags: {
properties: {
patternProperties: {
'.*': {
additionalProperties: false,
properties: {
count: {
type: 'integer',
},
lines: {
enum: ['always', 'never'],
type: 'string',
},
},
},
},
},
type: 'object',
},
},
type: 'object',
},
],
type: 'suggestion',
},
});