/
noPipeImpureRule.ts
49 lines (39 loc) · 1.67 KB
/
noPipeImpureRule.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
import { sprintf } from 'sprintf-js';
import { IRuleMetadata, RuleFailure } from 'tslint';
import { AbstractRule } from 'tslint/lib/rules';
import { ClassDeclaration, Decorator, SourceFile, SyntaxKind } from 'typescript';
import { NgWalker } from './angular/ngWalker';
import { getClassName, getDecoratorPropertyInitializer } from './util/utils';
import { PipeMetadata } from './angular';
interface FailureParameters {
readonly className: string;
}
export const getFailureMessage = (failureParameters: FailureParameters): string =>
sprintf(Rule.FAILURE_STRING, failureParameters.className);
export class Rule extends AbstractRule {
static readonly metadata: IRuleMetadata = {
description: 'Disallows the declaration of impure pipes.',
options: null,
optionsDescription: 'Not configurable.',
rationale: 'Impure pipes should be avoided because they are invoked on each change-detection cycle.',
ruleName: 'no-pipe-impure',
type: 'functionality',
typescriptOnly: true
};
static readonly FAILURE_STRING = 'Impure pipe declared in class %s';
apply(sourceFile: SourceFile): RuleFailure[] {
return this.applyWithWalker(new ClassMetadataWalker(sourceFile, this.getOptions()));
}
}
export class ClassMetadataWalker extends NgWalker {
protected visitNgPipe(metadata: PipeMetadata): void {
this.validatePipe(metadata);
super.visitNgPipe(metadata);
}
private validatePipe(metadata: PipeMetadata): void {
if (!metadata.pure || metadata.pure.kind !== SyntaxKind.FalseKeyword) return;
const className = getClassName(metadata.controller)!;
const failure = getFailureMessage({ className });
this.addFailureAtNode(metadata.pure, failure);
}
}