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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc"));
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
var _default = (0, _iterateJsdoc.default)(({
context,
jsdoc,
utils
}) => {
const [alwaysNever = 'never', {
count = 1,
dropEndLines = false,
noEndLines = false,
tags = {}
} = {}] = context.options;
jsdoc.tags.some((tg, tagIdx) => {
let lastTag;
let lastEmpty = null;
let reportIndex = null;
for (const [idx, {
tokens: {
tag,
name,
type,
description,
end
}
}] of tg.source.entries()) {
var _tags$lastTag$slice, _tags$lastTag$slice2;
// May be text after a line break within a tag description
if (description) {
reportIndex = null;
}
if (lastTag && ['any', 'always'].includes((_tags$lastTag$slice = tags[lastTag.slice(1)]) === null || _tags$lastTag$slice === void 0 ? void 0 : _tags$lastTag$slice.lines)) {
continue;
}
const empty = !tag && !name && !type && !description;
if (empty && !end && (alwaysNever === 'never' || lastTag && ((_tags$lastTag$slice2 = tags[lastTag.slice(1)]) === null || _tags$lastTag$slice2 === void 0 ? void 0 : _tags$lastTag$slice2.lines) === 'never')) {
reportIndex = idx;
continue;
}
if (!end) {
lastEmpty = empty ? idx : null;
}
lastTag = tag;
}
if (dropEndLines && lastEmpty !== null && tagIdx === jsdoc.tags.length - 1) {
const fixer = () => {
utils.removeTagItem(tagIdx, lastEmpty);
};
utils.reportJSDoc('Expected no trailing lines', {
line: tg.source[lastEmpty].number
}, fixer);
return true;
}
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;
for (const [idx, {
number,
tokens: {
tag,
name,
type,
description,
end
}
}] of tg.source.entries()) {
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 === null || currentTg === void 0 ? void 0 : currentTg.count;
const defaultAlways = alwaysNever === 'always' && (currentTg === null || currentTg === void 0 ? void 0 : currentTg.lines) !== 'never' && (currentTg === null || currentTg === void 0 ? void 0 : currentTg.lines) !== 'any' && lines.length < count;
let overrideAlways;
let fixCount = count;
if (!defaultAlways) {
fixCount = typeof tagCount === 'number' ? tagCount : count;
overrideAlways = (currentTg === null || currentTg === void 0 ? void 0 : currentTg.lines) === 'always' && lines.length < fixCount;
}
if (defaultAlways || overrideAlways) {
var _lines2;
const fixer = () => {
var _lines;
utils.addLines(tagIdx, ((_lines = lines[lines.length - 1]) === null || _lines === void 0 ? void 0 : _lines.idx) || tagSourceIdx + 1, fixCount - lines.length);
};
const line = ((_lines2 = lines[lines.length - 1]) === null || _lines2 === void 0 ? void 0 : _lines2.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'
}, {
additionalProperties: false,
properties: {
count: {
type: 'integer'
},
dropEndLines: {
type: 'boolean'
},
noEndLines: {
type: 'boolean'
},
tags: {
patternProperties: {
'.*': {
additionalProperties: false,
properties: {
count: {
type: 'integer'
},
lines: {
enum: ['always', 'never', 'any'],
type: 'string'
}
}
}
},
type: 'object'
}
},
type: 'object'
}],
type: 'suggestion'
}
});
exports.default = _default;
module.exports = exports.default;
//# sourceMappingURL=tagLines.js.map
|
