refactor(rxjs-prefer-add): Rename.

rxjs-no-wholesale makes more sense, as it can be use in combination with rxjs-no-add and rxjs-no-patched.
cartant · Jul 17, 2017 · e6648e5 · e6648e5
1 parent 680ec2e
commit e6648e5
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -57,7 +57,7 @@ The package includes the following rules:
 | `rxjs-no-patched` | Disallows the calling of patched methods. Operators must be imported and called explicitly - not via the `Observable` prototype. | None |
 | `rxjs-no-subject-unsubscribe` | Disallows the calling of `unsubscribe` directly upon `Subject` instances. For an explanation of why this can be a problem, see [this](https://stackoverflow.com/a/45112125/6680611) Stack Overflow answer. | None |
 | `rxjs-no-unused-add` | Disallows the importation of patched observables or operators that are not used in the module. | None |
-| `rxjs-prefer-add` | Disallows the importation of `rxjs` or `rxjs/Rx`. | None |
+| `rxjs-no-wholesale` | Disallows the wholesale importation of `rxjs` or `rxjs/Rx`. | None |
 
 ### Options
 

diff --git a/fixtures/import-all/fixture.ts → fixtures/import-wholesale/fixture.ts b/fixtures/import-all/fixture.ts → fixtures/import-wholesale/fixture.ts
diff --git a/fixtures/import-all/tsconfig.json → fixtures/import-wholesale/tsconfig.json b/fixtures/import-all/tsconfig.json → fixtures/import-wholesale/tsconfig.json
diff --git a/fixtures/tslint.json b/fixtures/tslint.json
@@ -4,7 +4,7 @@
   "rules": {
     "rxjs-add": { "severity": "error" },
     "rxjs-no-unused-add": { "severity": "error" },
-    "rxjs-prefer-add": { "severity": "error" }
+    "rxjs-no-wholesale": { "severity": "error" }
   },
   "rulesDirectory": "../build/rules"
 }
diff --git a/source/fixtures-spec.ts b/source/fixtures-spec.ts
@@ -46,15 +46,15 @@ describe("fixtures", function (): void {
             });
         });
 
-        describe("import-all", () => {
+        describe("import-wholesale", () => {
 
-            it("should effect 'rxjs-prefer-add' errors", () => {
+            it("should effect 'rxjs-no-wholesale' errors", () => {
 
-                const result = lint("import-all");
+                const result = lint("import-wholesale");
 
                 expect(result).to.have.property("errorCount", 2);
-                expect(result.failures[0]).to.have.property("ruleName", "rxjs-prefer-add");
-                expect(result.failures[1]).to.have.property("ruleName", "rxjs-prefer-add");
+                expect(result.failures[0]).to.have.property("ruleName", "rxjs-no-wholesale");
+                expect(result.failures[1]).to.have.property("ruleName", "rxjs-no-wholesale");
             });
         });
 

diff --git a/source/rules/rxjsNoWholesaleRule.ts b/source/rules/rxjsNoWholesaleRule.ts
@@ -0,0 +1,42 @@
+/**
+ * @license Copyright © 2017 Nicholas Jamieson. All Rights Reserved.
+ * 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";
+
+export class Rule extends Lint.Rules.AbstractRule {
+
+    public static metadata: Lint.IRuleMetadata = {
+        description: "Disallows the wholesale importation of `rxjs` or `rxjs/Rx`.",
+        options: null,
+        optionsDescription: "Not configurable.",
+        requiresTypeInfo: false,
+        ruleName: "rxjs-no-wholesale",
+        type: "style",
+        typescriptOnly: false
+    };
+
+    public static FAILURE_STRING = "Wholesale RxJS imports are forbidden";
+
+    public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        return this.applyWithWalker(new Walker(sourceFile, this.getOptions()));
+    }
+}
+
+class Walker extends Lint.RuleWalker {
+
+    public visitImportDeclaration(node: ts.ImportDeclaration): void {
+
+        const moduleSpecifier = node.moduleSpecifier.getText();
+
+        if (/^['"]rxjs(\/Rx)?['"]/.test(moduleSpecifier)) {
+            this.addFailureAtNode(node, Rule.FAILURE_STRING);
+        }
+
+        super.visitImportDeclaration(node);
+    }
+}
diff --git a/source/rules/rxjsPreferAddRule.ts b/source/rules/rxjsPreferAddRule.ts
@@ -8,35 +8,12 @@
 import * as Lint from "tslint";
 import * as ts from "typescript";
 
-export class Rule extends Lint.Rules.AbstractRule {
+import { Rule as NoWholesaleRule } from "./rxjsNoWholesaleRule";
 
-    public static metadata: Lint.IRuleMetadata = {
-        description: "Disallows the importation of `rxjs` or `rxjs/Rx`.",
-        options: null,
-        optionsDescription: "Not configurable.",
-        requiresTypeInfo: false,
-        ruleName: "rxjs-prefer-add",
-        type: "style",
-        typescriptOnly: false
-    };
+export class Rule extends NoWholesaleRule {
 
-    public static FAILURE_STRING = "RxJS add import is preferred";
-
-    public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
-        return this.applyWithWalker(new Walker(sourceFile, this.getOptions()));
-    }
-}
-
-class Walker extends Lint.RuleWalker {
-
-    public visitImportDeclaration(node: ts.ImportDeclaration): void {
-
-        const moduleSpecifier = node.moduleSpecifier.getText();
-
-        if (/^['"]rxjs(\/Rx)?['"]/.test(moduleSpecifier)) {
-            this.addFailureAtNode(node, Rule.FAILURE_STRING);
-        }
-
-        super.visitImportDeclaration(node);
-    }
+    public static metadata: Lint.IRuleMetadata = Object.assign({}, NoWholesaleRule.metadata, {
+        deprecationMessage: "rxjs-prefer-add has been renamed to rxjs-no-wholesale.",
+        ruleName: "rxjs-prefer-add"
+    });
 }