-
Notifications
You must be signed in to change notification settings - Fork 234
/
angularWhitespaceRule.ts
332 lines (292 loc) · 11.9 KB
/
angularWhitespaceRule.ts
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
import * as ast from '@angular/compiler';
import * as Lint from 'tslint';
import * as ts from 'typescript';
import { Config } from './angular/config';
import { ExpTypes } from './angular/expressionTypes';
import { NgWalker, NgWalkerConfig } from './angular/ngWalker';
import { BasicTemplateAstVisitor } from './angular/templates/basicTemplateAstVisitor';
import { RecursiveAngularExpressionVisitor } from './angular/templates/recursiveAngularExpressionVisitor';
// Check if ES6 'y' flag is usable.
const stickyFlagUsable = (() => {
try {
const reg = /d/y;
return true;
} catch {
return false;
}
})();
const [InterpolationOpen, InterpolationClose] = Config.interpolation;
const InterpolationWhitespaceRe = new RegExp(`${InterpolationOpen}(\\s*)(.*?)(\\s*)${InterpolationClose}`, 'g');
const SemicolonNoWhitespaceNotInSimpleQuoteRe = stickyFlagUsable
? new RegExp(`(?:[^';]|'[^']*'|;(?=\\s))+;(?=\\S)`, 'gy')
: /(?:[^';]|'[^']*')+;/g;
const SemicolonNoWhitespaceNotInDoubleQuoteRe = stickyFlagUsable
? new RegExp(`(?:[^";]|"[^"]*"|;(?=\\s))+;(?=\\S)`, 'gy')
: /(?:[^";]|"[^"]*")+;/g;
const getSemicolonReplacements = (absolutePosition: number) => {
return [new Lint.Replacement(absolutePosition, 1, '; ')];
};
interface CheckSemicolonNoWhitespaceMethod {
(reg: RegExp, context: BasicTemplateAstVisitor, expr: string, fixedOffset: number): void;
}
// Simplify the code when the 'y' flag of RegExp is usable.
const checkSemicolonNoWhitespaceWithSticky: CheckSemicolonNoWhitespaceMethod = (reg, context, expr, fixedOffset) => {
const error = "Missing whitespace after semicolon; expecting '; expr'";
let exprMatch: RegExpExecArray | null;
while ((exprMatch = reg.exec(expr))) {
const start = fixedOffset + reg.lastIndex;
const absolutePosition = context.getSourcePosition(start - 1);
context.addFailureAt(start, 2, error, getSemicolonReplacements(absolutePosition));
}
};
const checkSemicolonNoWhitespaceWithoutSticky: CheckSemicolonNoWhitespaceMethod = (reg, context, expr, fixedOffset) => {
const error = "Missing whitespace after semicolon; expecting '; expr'";
let lastIndex = 0;
let exprMatch: RegExpExecArray | null;
while ((exprMatch = reg.exec(expr))) {
// When the 'y' flag of RegExp is unusable, must compare lastIndex with match.index,
// otherwise the match results may be incorrect.
if (lastIndex !== exprMatch.index) {
break;
}
const nextIndex = reg.lastIndex;
// Check if the character after the semicolon is not a whitespace.
if (nextIndex < expr.length && /\S/.test(expr[nextIndex])) {
const start = fixedOffset + nextIndex;
const absolutePosition = context.getSourcePosition(start - 1);
context.addFailureAt(start, 2, error, getSemicolonReplacements(absolutePosition));
}
lastIndex = nextIndex;
}
};
const checkSemicolonNoWhitespace: CheckSemicolonNoWhitespaceMethod = stickyFlagUsable
? checkSemicolonNoWhitespaceWithSticky
: checkSemicolonNoWhitespaceWithoutSticky;
const OPTION_CHECK_INTERPOLATION = 'check-interpolation';
const OPTION_CHECK_PIPE = 'check-pipe';
const OPTION_CHECK_SEMICOLON = 'check-semicolon';
type CheckOption = typeof OPTION_CHECK_INTERPOLATION | typeof OPTION_CHECK_PIPE | typeof OPTION_CHECK_SEMICOLON;
interface ConfigurableVisitor {
getCheckOption(): CheckOption;
}
/* Interpolation visitors */
class InterpolationWhitespaceVisitor extends BasicTemplateAstVisitor implements ConfigurableVisitor {
visitBoundText(text: ast.BoundTextAst, context: BasicTemplateAstVisitor): any {
if (ExpTypes.ASTWithSource(text.value)) {
// Note that will not be reliable for different interpolation symbols
const expr = (text.value as any).source;
const checkWhiteSpace = (
subMatch: string,
location: 'start' | 'end',
fixTo: string,
position: number,
absolutePosition: number,
lengthFix: number
) => {
const { length } = subMatch;
if (length === 1) {
return;
}
const errorText = length === 0 ? 'Missing' : 'Extra';
context.addFailureAt(
position,
length + lengthFix,
`${errorText} whitespace in interpolation ${location}; expecting ${InterpolationOpen} expr ${InterpolationClose}`,
[new Lint.Replacement(absolutePosition, length + lengthFix, fixTo)]
);
};
InterpolationWhitespaceRe.lastIndex = 0;
let match: RegExpExecArray | null;
while ((match = InterpolationWhitespaceRe.exec(expr))) {
const start = text.sourceSpan.start.offset + match.index;
const absolutePosition = context.getSourcePosition(start);
checkWhiteSpace(match[1], 'start', `${InterpolationOpen} `, start, absolutePosition, InterpolationOpen.length);
const positionFix = InterpolationOpen.length + match[1].length + match[2].length;
checkWhiteSpace(
match[3],
'end',
` ${InterpolationClose}`,
start + positionFix,
absolutePosition + positionFix,
InterpolationClose.length
);
}
}
super.visitBoundText(text, context);
return null;
}
getCheckOption(): CheckOption {
return 'check-interpolation';
}
}
class SemicolonTemplateVisitor extends BasicTemplateAstVisitor implements ConfigurableVisitor {
visitDirectiveProperty(prop: ast.BoundDirectivePropertyAst, context: BasicTemplateAstVisitor): any {
if (prop.sourceSpan) {
const directive = prop.sourceSpan.toString();
const match = /^([^=]+=\s*)([^]*?)\s*$/.exec(directive)!;
const rawExpression = match[2];
const positionFix = match[1].length + 1;
const expr = rawExpression.slice(1, -1).trim();
const doubleQuote = rawExpression[0] === '"';
// Note that will not be reliable for different interpolation symbols
const reg = doubleQuote ? SemicolonNoWhitespaceNotInSimpleQuoteRe : SemicolonNoWhitespaceNotInDoubleQuoteRe;
reg.lastIndex = 0;
checkSemicolonNoWhitespace(reg, context, expr, prop.sourceSpan.start.offset + positionFix);
}
super.visitDirectiveProperty(prop, context);
}
getCheckOption(): CheckOption {
return 'check-semicolon';
}
}
class TemplateVisitorCtrl extends BasicTemplateAstVisitor {
private visitors: (BasicTemplateAstVisitor & ConfigurableVisitor)[] = [
new InterpolationWhitespaceVisitor(this.getSourceFile(), this.getOptions(), this.context, this.templateStart),
new SemicolonTemplateVisitor(this.getSourceFile(), this.getOptions(), this.context, this.templateStart)
];
visitBoundText(text: ast.BoundTextAst, context: BasicTemplateAstVisitor): any {
const options = this.getOptions();
this.visitors
.filter(v => options.indexOf(v.getCheckOption()) >= 0)
.map(v => v.visitBoundText(text, this))
.filter(Boolean)
.forEach(f =>
this.addFailureFromStartToEnd(f.getStartPosition().getPosition(), f.getEndPosition().getPosition(), f.getFailure(), f.getFix())
);
super.visitBoundText(text, context);
}
visitDirectiveProperty(prop: ast.BoundDirectivePropertyAst, context: BasicTemplateAstVisitor): any {
const options = this.getOptions();
this.visitors
.filter(v => options.indexOf(v.getCheckOption()) >= 0)
.map(v => v.visitDirectiveProperty(prop, this))
.filter(Boolean)
.forEach(f =>
this.addFailureFromStartToEnd(f.getStartPosition().getPosition(), f.getEndPosition().getPosition(), f.getFailure(), f.getFix())
);
super.visitDirectiveProperty(prop, context);
}
}
/* Expression visitors */
class PipeWhitespaceVisitor extends RecursiveAngularExpressionVisitor implements ConfigurableVisitor {
visitPipe(ast: ast.BindingPipe, context: RecursiveAngularExpressionVisitor): any {
let exprStart, exprEnd, exprText, sf;
exprStart = context.getSourcePosition(ast.exp.span.start);
exprEnd = context.getSourcePosition(ast.exp.span.end);
sf = context.getSourceFile().getFullText();
exprText = sf.substring(exprStart, exprEnd);
const replacements: Lint.Fix = [];
let parentheses = false;
let leftBeginning: number;
if (sf[exprEnd] === ')') {
parentheses = true;
leftBeginning = exprEnd + 1 + 2; // exprEnd === '|'
} else {
leftBeginning = exprEnd + 1; // exprEnd === '|'
}
// Handling the right side of the pipe
if (sf[leftBeginning] === ' ') {
let ignoreSpace = 1;
while (sf[leftBeginning + ignoreSpace] === ' ') {
ignoreSpace += 1;
}
if (ignoreSpace > 1) {
replacements.push(new Lint.Replacement(exprEnd + 1, ignoreSpace, ' '));
}
} else {
replacements.push(new Lint.Replacement(exprEnd + 1, 0, ' '));
}
// Handling the left side of the pipe
if (exprText[exprText.length - 1] === ' ') {
let ignoreSpace = 1;
while (exprText[exprText.length - 1 - ignoreSpace] === ' ') {
ignoreSpace += 1;
}
if (ignoreSpace > 1) {
replacements.push(new Lint.Replacement(exprEnd - ignoreSpace, ignoreSpace, ' '));
}
} else {
if (!parentheses) {
replacements.push(new Lint.Replacement(exprEnd, 0, ' '));
}
}
if (replacements.length) {
context.addFailureAt(
ast.exp.span.end - 1,
3,
'The pipe operator should be surrounded by one space on each side, i.e. " | ".',
replacements
);
}
super.visitPipe(ast, context);
return null;
}
getCheckOption(): CheckOption {
return 'check-pipe';
}
}
class ExpressionVisitorCtrl extends RecursiveAngularExpressionVisitor {
private visitors: (RecursiveAngularExpressionVisitor & ConfigurableVisitor)[] = [
new PipeWhitespaceVisitor(this.getSourceFile(), this.getOptions(), this.context, this.basePosition)
];
visitPipe(expr: ast.BindingPipe, context: BasicTemplateAstVisitor): any {
const options = this.getOptions();
this.visitors
.map(v => v.addParentAST(this.parentAST))
.filter(v => options.indexOf(v.getCheckOption()) >= 0)
.map(v => v.visitPipe(expr, this))
.filter(Boolean)
.forEach(f =>
this.addFailureFromStartToEnd(f.getStartPosition().getPosition(), f.getEndPosition().getPosition(), f.getFailure(), f.getFix())
);
}
}
export class Rule extends Lint.Rules.AbstractRule {
static readonly metadata: Lint.IRuleMetadata = {
deprecationMessage: 'Use a formatter like Prettier for formatting purposes.',
description: 'Ensures the proper formatting of Angular expressions.',
hasFix: true,
optionExamples: [
[true, OPTION_CHECK_INTERPOLATION],
[true, OPTION_CHECK_PIPE],
[true, OPTION_CHECK_SEMICOLON],
[true, OPTION_CHECK_INTERPOLATION, OPTION_CHECK_PIPE, OPTION_CHECK_SEMICOLON]
],
options: {
items: {
enum: [OPTION_CHECK_INTERPOLATION, OPTION_CHECK_PIPE, OPTION_CHECK_SEMICOLON],
type: 'string'
},
maxLength: 3,
minLength: 1,
type: 'array'
},
optionsDescription: Lint.Utils.dedent`
One (or both) of the following arguments must be provided:
* \`${OPTION_CHECK_INTERPOLATION}\` - checks for whitespace before and after the interpolation characters.
* \`${OPTION_CHECK_PIPE}\` - checks for whitespace before and after a pipe.
* \`${OPTION_CHECK_SEMICOLON}\` - checks for whitespace after semicolon.
`,
rationale: 'Having whitespace in the right places in an Angular expression makes the template more readable.',
ruleName: 'angular-whitespace',
type: 'style',
typescriptOnly: true
};
apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
const walkerConfig: NgWalkerConfig = {
expressionVisitorCtrl: ExpressionVisitorCtrl,
templateVisitorCtrl: TemplateVisitorCtrl
};
const walker = new NgWalker(sourceFile, this.getOptions(), walkerConfig);
return this.applyWithWalker(walker);
}
isEnabled(): boolean {
const {
metadata: {
options: { maxLength, minLength }
}
} = Rule;
const { length } = this.ruleArguments;
return super.isEnabled() && length >= minLength && length <= maxLength;
}
}