-
-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
96 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
/** | ||
* @license Use of this source code is governed by an MIT-style license that | ||
* can be found in the LICENSE file at https://github.com/cartant/rxjs-tslint-rules | ||
*/ | ||
|
||
import * as Lint from "tslint"; | ||
import * as ts from "typescript"; | ||
import * as tsutils from "tsutils"; | ||
import { tsquery } from "@phenomnomnominal/tsquery"; | ||
import { couldBeType } from "../support/util"; | ||
|
||
export class Rule extends Lint.Rules.TypedRule { | ||
|
||
public static metadata: Lint.IRuleMetadata = { | ||
description: "Disallows the calling of `subscribe` within an Angular component.", | ||
options: null, | ||
optionsDescription: "Not configurable.", | ||
requiresTypeInfo: true, | ||
ruleName: "rxjs-prefer-async-pipe", | ||
type: "style", | ||
typescriptOnly: true | ||
}; | ||
|
||
public static FAILURE_STRING = "Prefer async pipe over subscribe"; | ||
|
||
public applyWithProgram(sourceFile: ts.SourceFile, program: ts.Program): Lint.RuleFailure[] { | ||
|
||
const failures: Lint.RuleFailure[] = []; | ||
const typeChecker = program.getTypeChecker(); | ||
|
||
const componentIdentifiers = tsquery( | ||
sourceFile, | ||
`ClassDeclaration Identifier[name=/Component$/]` | ||
); | ||
componentIdentifiers.forEach(componentIdentifier => { | ||
const { parent: classDeclaration } = componentIdentifier; | ||
const propertyAccessExpressions = tsquery( | ||
classDeclaration, | ||
`CallExpression PropertyAccessExpression[name.name="subscribe"]` | ||
); | ||
propertyAccessExpressions.forEach(propertyAccessExpression => { | ||
if (tsutils.isPropertyAccessExpression(propertyAccessExpression)) { | ||
const type = typeChecker.getTypeAtLocation(propertyAccessExpression.expression); | ||
if (couldBeType(type, "Observable")) { | ||
const { name } = propertyAccessExpression; | ||
failures.push(new Lint.RuleFailure( | ||
sourceFile, | ||
name.getStart(), | ||
name.getStart() + name.getWidth(), | ||
Rule.FAILURE_STRING, | ||
this.ruleName | ||
)); | ||
} | ||
} | ||
}); | ||
}); | ||
return failures; | ||
} | ||
} |
15 changes: 15 additions & 0 deletions
15
test/v6/fixtures/prefer-async-pipe/default/fixture.ts.lint
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
import { Component OnInit } from "@angular/core"; | ||
import { of } from "rxjs"; | ||
|
||
@Component({ | ||
selector: "some-component", | ||
template: "<span>something</span>" | ||
}) | ||
export class SomeComponent implements OnInit { | ||
ngOnInit() { | ||
of("foo").subscribe(); | ||
~~~~~~~~~ [prefer-async-pipe] | ||
} | ||
} | ||
|
||
[prefer-async-pipe]: Prefer async pipe over subscribe |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{ | ||
"compilerOptions": { | ||
"baseUrl": ".", | ||
"lib": ["es2015"], | ||
"noEmit": true, | ||
"paths": { | ||
"rxjs": ["../../node_modules/rxjs"] | ||
}, | ||
"skipLibCheck": true, | ||
"target": "es5" | ||
}, | ||
"include": ["fixture.ts"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"defaultSeverity": "error", | ||
"jsRules": {}, | ||
"rules": { | ||
"rxjs-prefer-async-pipe": { "severity": "error" } | ||
}, | ||
"rulesDirectory": "../../../../../build/rules" | ||
} |