-
Notifications
You must be signed in to change notification settings - Fork 128
/
whitespace.js
166 lines (129 loc) · 5.79 KB
/
whitespace.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
157
158
159
160
161
162
163
164
165
166
/**
* @fileoverview Specify where whitespace is suitable and where it isn't
* @author Raghav Dua <duaraghav8@gmail.com>
*/
"use strict";
const { EOL } = require("os"),
jse = require("js-string-escape");
module.exports = {
meta: {
docs: {
recommended: true,
type: "warning",
description: "Specify where whitespace is suitable and where it isn't"
},
schema: []
},
create: function(context) {
let sourceCode = context.getSourceCode();
function inspectNameValueAssignment(emitted) {
if (emitted.exit) {
return;
}
let node = emitted.node,
codeBetweenNameAndValue = sourceCode.getStringBetweenNodes(node.name, node.value);
let validationRegexp = /^((: )|(:)|( : ))$/;
(!validationRegexp.test(codeBetweenNameAndValue)) && context.report({
location: {
column: sourceCode.getColumn(node.name) + 1
},
node: node,
message: ("Name '" + node.name.name +
"': Only \"N: V\", \"N : V\" or \"N:V\" spacing style should be used in Name-Value Mapping.")
});
//If this is not the last node of its parent array, ensure the comma spacing is acceptable
let parentArray = node.parent.arguments;
if (node.start === parentArray.slice(-1) [0].start) {
return;
}
let escapedEOL = jse(EOL),
codeAfterCurrentAssignment = sourceCode.getNextChars(node.value, 3);
// thirdCharRegexp is used in validationRegExp if EOL is unix-style, ie, len(EOL) = 1.
// If len(EOL) is 2, then comma + EOL cover 3 chars, then thirdCharRegexp gets treated as a checked for 4th character,
// resulting in false positive.
const thirdCharRegexp = `[^${escapedEOL}\\/]`;
validationRegexp = new RegExp(
`^((,[^ ${escapedEOL}\\/].)|(, [^ ${escapedEOL}\\/])|(,${escapedEOL}${EOL.length === 1 ? thirdCharRegexp : ""}))$`
);
(!validationRegexp.test(codeAfterCurrentAssignment)) && context.report({
location: {
column: sourceCode.getEndingColumn(node.value) + 1
},
node: node,
message: "\"" + sourceCode.getText(node.value) + "\" should be immediately followed by a comma, then an optional space."
});
}
function inspectMemberExpression(emitted) {
let node = emitted.node,
property = node.property;
/**
* If expression spans over multiple lines, below rule doesn't apply
* eg- myArray [
* fooBar ()
* .getIndex ()
* .toBase10 ()
* ];
*/
if (emitted.exit || (sourceCode.getLine(node) !== sourceCode.getEndingLine(property)) || !node.computed) {
return;
}
let charBeforeProperty = sourceCode.getPrevChar(property),
charAfterProperty = sourceCode.getNextChar(property);
(charBeforeProperty !== "[") && context.report({
node: property,
location: {
column: sourceCode.getColumn(property) - 1
},
message: "There should be no whitespace or comments between '[' and property."
});
(charAfterProperty !== "]") && context.report({
node: property,
location: {
column: sourceCode.getEndingColumn(property) + 1
},
message: "There should be no whitespace or comments between property and ']'."
});
}
function inspectBlockStatement(emitted) {
let node = emitted.node, blockBody = node.body,
lastBlockItem = blockBody.slice(-1) [0]; //if block is empty, this becomes undefined
//if block spans over multiple lines or is child of a function declaration, below rules don't apply
if (emitted.exit ||
(lastBlockItem && sourceCode.getLine(node) !== sourceCode.getEndingLine(lastBlockItem)) ||
["FunctionDeclaration", "ConstructorDeclaration"].includes(node.parent.type)
) {
return;
}
//for a 0-item block, ensure that block node's code is simply '{}'
if (!blockBody.length) {
let nodeCode = sourceCode.getText(node);
(nodeCode !== "{}") && context.report({
node: node,
message: "An empty block shouldn't have any whitespace or comments between the braces, i.e., '{}'."
});
return;
}
let charBeforeFirstItem = sourceCode.getPrevChar(blockBody [0]),
charAfterLastItem = sourceCode.getNextChar(lastBlockItem);
(charBeforeFirstItem !== "{") && context.report({
node: blockBody [0],
location: {
column: sourceCode.getColumn(blockBody [0]) - 1
},
message: "There should be no whitespace or comments between the opening brace '{' and first item."
});
(charAfterLastItem !== "}") && context.report({
node: lastBlockItem,
location: {
column: sourceCode.getEndingColumn(lastBlockItem) + 1
},
message: "There should be no whitespace or comments between the last item and closing brace '}'."
});
}
return {
BlockStatement: inspectBlockStatement,
MemberExpression: inspectMemberExpression,
NameValueAssignment: inspectNameValueAssignment
};
}
};