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
|
/**
* @fileoverview A rule to ensure blank lines within blocks.
* @author Mathias Schreck <https://github.com/lo1tuma>
* @copyright 2014 Mathias Schreck. All rights reserved.
*/
"use strict";
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
module.exports = function (context) {
var requirePadding = context.options[0] !== "never";
var ALWAYS_MESSAGE = "Block must be padded by blank lines.",
NEVER_MESSAGE = "Block must not be padded by blank lines.";
/**
* Checks if the given non empty block node has a blank line before its first child node.
* @param {ASTNode} node The AST node of a BlockStatement.
* @returns {boolean} Whether or not the block starts with a blank line.
*/
function isBlockTopPadded(node) {
var blockStart = node.loc.start.line,
first = node.body[0],
firstLine = first.loc.start.line,
expectedFirstLine = blockStart + 2,
leadingComments = context.getComments(first).leading;
if (leadingComments.length > 0) {
firstLine = leadingComments[0].loc.start.line;
}
return expectedFirstLine <= firstLine;
}
/**
* Checks if the given non empty block node has a blank line after its last child node.
* @param {ASTNode} node The AST node of a BlockStatement.
* @returns {boolean} Whether or not the block ends with a blank line.
*/
function isBlockBottomPadded(node) {
var blockEnd = node.loc.end.line,
last = node.body[node.body.length - 1],
lastLine = context.getLastToken(last).loc.end.line,
expectedLastLine = blockEnd - 2,
trailingComments = context.getComments(last).trailing;
if (trailingComments.length > 0) {
lastLine = trailingComments[trailingComments.length - 1].loc.end.line;
}
return lastLine <= expectedLastLine;
}
/**
* Checks the given BlockStatement node to be padded if the block is not empty.
* @param {ASTNode} node The AST node of a BlockStatement.
* @returns {void} undefined.
*/
function checkPadding(node) {
if (node.body.length > 0) {
var blockHasTopPadding = isBlockTopPadded(node),
blockHasBottomPadding = isBlockBottomPadded(node);
if (requirePadding) {
if (!blockHasTopPadding) {
context.report(node, ALWAYS_MESSAGE);
}
if (!blockHasBottomPadding) {
context.report(node, node.loc.end, ALWAYS_MESSAGE);
}
} else {
if (blockHasTopPadding) {
context.report(node, NEVER_MESSAGE);
}
if (blockHasBottomPadding) {
context.report(node, node.loc.end, NEVER_MESSAGE);
}
}
}
}
return {
"BlockStatement": checkPadding
};
};
module.exports.schema = [
{
"enum": ["always", "never"]
}
];
|
