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
|
"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)(({
jsdoc,
report,
context,
jsdocNode,
sourceCode,
indent,
utils
}) => {
let always;
if (!jsdoc.description.trim() || !jsdoc.tags.length) {
return;
}
if (0 in context.options) {
always = context.options[0] === 'always';
} else {
always = true;
}
const {
description,
lastDescriptionLine
} = utils.getDescription();
const descriptionEndsWithANewline = /\n\r?$/u.test(description);
if (always) {
if (!descriptionEndsWithANewline) {
const sourceLines = sourceCode.getText(jsdocNode).split('\n');
report('There must be a newline after the description of the JSDoc block.', fixer => {
// Add the new line
const injectedLine = `${indent} *` + (sourceLines[lastDescriptionLine].endsWith('\r') ? '\r' : '');
sourceLines.splice(lastDescriptionLine + 1, 0, injectedLine);
return fixer.replaceText(jsdocNode, sourceLines.join('\n'));
}, {
line: lastDescriptionLine
});
}
} else if (descriptionEndsWithANewline) {
const sourceLines = sourceCode.getText(jsdocNode).split('\n');
report('There must be no newline after the description of the JSDoc block.', fixer => {
// Remove the extra line
sourceLines.splice(lastDescriptionLine, 1);
return fixer.replaceText(jsdocNode, sourceLines.join('\n'));
}, {
line: lastDescriptionLine
});
}
}, {
iterateAllJsdocs: true,
meta: {
docs: {
description: 'Enforces a consistent padding of the block description.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-newline-after-description'
},
fixable: 'whitespace',
schema: [{
enum: ['always', 'never'],
type: 'string'
}],
type: 'layout'
}
});
exports.default = _default;
module.exports = exports.default;
//# sourceMappingURL=newlineAfterDescription.js.map
|
