-
-
Notifications
You must be signed in to change notification settings - Fork 153
/
newlineAfterDescription.js
70 lines (63 loc) · 1.93 KB
/
newlineAfterDescription.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
import _ from 'lodash';
import iterateJsdoc from '../iterateJsdoc';
export default iterateJsdoc(({
jsdoc,
report,
context,
jsdocNode,
sourceCode,
indent,
}) => {
let always;
if (!jsdoc.description || !jsdoc.tags.length) {
return;
}
if (_.has(context.options, 0)) {
always = context.options[0] === 'always';
} else {
always = true;
}
const descriptionEndsWithANewline = jsdoc.description.endsWith('\n');
if (always) {
if (!descriptionEndsWithANewline) {
const sourceLines = sourceCode.getText(jsdocNode).split('\n');
const lastDescriptionLine = _.findLastIndex(sourceLines, (line) => {
return line.replace(/^\s*\*\s*/u, '') === _.last(jsdoc.description.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');
const lastDescriptionLine = _.findLastIndex(sourceLines, (line) => {
return line.replace(/^\s*\*\s*/u, '') === _.last(jsdoc.description.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: {
fixable: 'whitespace',
schema: [
{
enum: ['always', 'never'],
type: 'string',
},
],
type: 'layout',
},
noTrim: true,
});