-
-
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,65 @@ | ||
/** | ||
* @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 async functions to subscribe.", | ||
options: null, | ||
optionsDescription: "Not configurable.", | ||
requiresTypeInfo: false, | ||
ruleName: "rxjs-no-async-subscribe", | ||
type: "functionality", | ||
typescriptOnly: false | ||
}; | ||
|
||
public static FAILURE_STRING = "Passing async functions to subscribe is forbidden"; | ||
|
||
public applyWithProgram(sourceFile: ts.SourceFile, program: ts.Program): Lint.RuleFailure[] { | ||
|
||
const failures: Lint.RuleFailure[] = []; | ||
const typeChecker = program.getTypeChecker(); | ||
|
||
const callExpressions = tsquery( | ||
sourceFile, | ||
`CallExpression[expression.name.text="subscribe"]` | ||
); | ||
callExpressions.forEach(node => { | ||
const callExpression = node as ts.CallExpression; | ||
if (tsutils.isPropertyAccessExpression(callExpression.expression)) { | ||
const propertyAccessExpression = callExpression.expression; | ||
const { arguments: args } = callExpression; | ||
let observable: boolean | undefined = undefined; | ||
args.forEach(arg => { | ||
if (tsutils.isArrowFunction(arg) || tsutils.isFunctionExpression(arg)) { | ||
const modifier = tsutils.getModifier(arg, ts.SyntaxKind.AsyncKeyword); | ||
if (modifier) { | ||
if (observable === undefined) { | ||
const type = typeChecker.getTypeAtLocation(propertyAccessExpression.expression); | ||
observable = couldBeType(type, "Observable"); | ||
} | ||
if (observable) { | ||
failures.push(new Lint.RuleFailure( | ||
sourceFile, | ||
modifier.getStart(), | ||
modifier.getStart() + modifier.getWidth(), | ||
Rule.FAILURE_STRING, | ||
this.ruleName | ||
)); | ||
} | ||
} | ||
} | ||
}); | ||
} | ||
}); | ||
return failures; | ||
} | ||
} |
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,9 @@ | ||
import { of } from "rxjs"; | ||
|
||
of("a").subscribe(async () => { | ||
~~~~~ [no-async-subscribe] | ||
return await "a"; | ||
}); | ||
of("b").subscribe(() => {}); | ||
|
||
[no-async-subscribe]: Passing async functions to subscribe is forbidden |
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-no-async-subscribe": { "severity": "error" } | ||
}, | ||
"rulesDirectory": "../../../../../build/rules" | ||
} |