Skip to content

Commit

Permalink
feat(replay-buffer): Add rule.
Browse files Browse the repository at this point in the history
  • Loading branch information
cartant committed Nov 24, 2018
1 parent 5a5ba75 commit 5958750
Show file tree
Hide file tree
Showing 5 changed files with 104 additions and 1 deletion.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
"test": "yarn run lint && yarn run test:build && yarn run test:mocha && yarn run test:tslint-v5 && yarn run test:tslint-v6 && yarn run test:tslint-v6-compat",
"test:build": "yarn run test:clean && tsc -p tsconfig.json",
"test:clean": "rimraf build",
"test:debug": "tslint --test ./test/v6/fixtures/no-ignored-notifier/**/tslint.json",
"test:debug": "tslint --test ./test/v6/fixtures/no-ignored-replay-buffer/**/tslint.json",
"test:issues": "yarn run test:clean && tsc -p tsconfig.json && tslint --test ./test/v6/fixtures/issues/**/tslint.json",
"test:mocha": "mocha build/**/*-spec.js",
"test:tslint-v5": "yarn --cwd ./test/v5 install && yarn --cwd ./test/v5 upgrade && tslint --test ./test/v5/fixtures/**/tslint.json",
Expand Down
66 changes: 66 additions & 0 deletions source/rules/rxjsNoIgnoredReplayBufferRule.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/**
* @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
*/
/*tslint:disable:no-use-before-declare*/

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 using `ReplaySubject`, `publishReplay` or `shareReplay` without specifying the buffer size.",
options: null,
optionsDescription: "Not configurable.",
requiresTypeInfo: true,
ruleName: "rxjs-no-ignored-replay-buffer",
type: "functionality",
typescriptOnly: true
};

public static FAILURE_STRING = "Ignoring the buffer size is forbidden";

public applyWithProgram(sourceFile: ts.SourceFile, program: ts.Program): Lint.RuleFailure[] {

const failures: Lint.RuleFailure[] = [];

const newIdentifiers = tsquery(
sourceFile,
`NewExpression Identifier[name="ReplaySubject"]`
);
newIdentifiers.forEach(identifier => {
const newExpression = identifier.parent as ts.NewExpression;
if (!newExpression.arguments || newExpression.arguments.length === 0) {
failures.push(new Lint.RuleFailure(
sourceFile,
identifier.getStart(),
identifier.getStart() + identifier.getWidth(),
Rule.FAILURE_STRING,
this.ruleName
));
}
});

const callIdentifiers = tsquery(
sourceFile,
`CallExpression Identifier[name=/(publishReplay|shareReplay)/]`
);
callIdentifiers.forEach(identifier => {
const callExpression = identifier.parent as ts.CallExpression;
if (callExpression.arguments.length === 0) {
failures.push(new Lint.RuleFailure(
sourceFile,
identifier.getStart(),
identifier.getStart() + identifier.getWidth(),
Rule.FAILURE_STRING,
this.ruleName
));
}
});
return failures;
}
}
16 changes: 16 additions & 0 deletions test/v6/fixtures/no-ignored-replay-buffer/default/fixture.ts.lint
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { of, ReplaySubject } from "rxjs";
import { publishReplay, shareReplay } from "rxjs/operators";

const a = new ReplaySubject<string>(1);
const b = new ReplaySubject<string>();
~~~~~~~~~~~~~ [no-ignored-replay-buffer]

const c = of(42).pipe(publishReplay(1));
const d = of(42).pipe(publishReplay());
~~~~~~~~~~~~~ [no-ignored-replay-buffer]

const e = of(42).pipe(shareReplay(1));
const f = of(42).pipe(shareReplay());
~~~~~~~~~~~ [no-ignored-replay-buffer]

[no-ignored-replay-buffer]: Ignoring the buffer size is forbidden
13 changes: 13 additions & 0 deletions test/v6/fixtures/no-ignored-replay-buffer/default/tsconfig.json
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"]
}
8 changes: 8 additions & 0 deletions test/v6/fixtures/no-ignored-replay-buffer/default/tslint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"defaultSeverity": "error",
"jsRules": {},
"rules": {
"rxjs-no-ignored-replay-buffer": { "severity": "error" }
},
"rulesDirectory": "../../../../../build/rules"
}

0 comments on commit 5958750

Please sign in to comment.