chore: Fix up rule deprecations.

cartant · Nov 29, 2019 · 392106c · 392106c
1 parent 3c75115
commit 392106c
Show file tree

Hide file tree

Showing 30 changed files with 52 additions and 13 deletions.
diff --git a/source/rules/rxjsAddRule.ts b/source/rules/rxjsAddRule.ts
@@ -17,7 +17,7 @@ import { UsedWalker } from "../support/used-walker";
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
     deprecationMessage:
-      peer.v6 && !peer.compat ? "Rule not needed for v6." : undefined,
+      peer.v6 && !peer.compat ? peer.v6NotNeededMessage : undefined,
     description:
       "Enforces the importation of patched observables and operators used in the module.",
     options: {

diff --git a/source/rules/rxjsDeepOperatorsRule.ts b/source/rules/rxjsDeepOperatorsRule.ts
@@ -11,7 +11,7 @@ import * as peer from "../support/peer";
 export class Rule extends Lint.Rules.AbstractRule {
   public static metadata: Lint.IRuleMetadata = {
     deprecationMessage:
-      peer.v6 && !peer.compat ? "Rule not needed for v6." : undefined,
+      peer.v6 && !peer.compat ? peer.v6NotNeededMessage : undefined,
     description: "Enforces deep importation from within 'rxjs/operators'.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoAddRule.ts b/source/rules/rxjsNoAddRule.ts
@@ -11,7 +11,7 @@ import * as peer from "../support/peer";
 export class Rule extends Lint.Rules.AbstractRule {
   public static metadata: Lint.IRuleMetadata = {
     deprecationMessage:
-      peer.v6 && !peer.compat ? "Rule not needed for v6." : undefined,
+      peer.v6 && !peer.compat ? peer.v6NotNeededMessage : undefined,
     description:
       "Disallows the importation of patched observables and operators.",
     options: {

diff --git a/source/rules/rxjsNoAsyncSubscribeRule.ts b/source/rules/rxjsNoAsyncSubscribeRule.ts
@@ -7,10 +7,12 @@ import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as tsutils from "tsutils";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description: "Disallows passing async functions to subscribe.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoCompatRule.ts b/source/rules/rxjsNoCompatRule.ts
@@ -6,10 +6,11 @@
 import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 
 export class Rule extends Lint.Rules.AbstractRule {
   public static metadata: Lint.IRuleMetadata = {
-    deprecationMessage: undefined,
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description:
       "Disallows importation from locations that depend upon 'rxjs-compat'.",
     options: null,

diff --git a/source/rules/rxjsNoConnectableRule.ts b/source/rules/rxjsNoConnectableRule.ts
@@ -6,10 +6,12 @@
 import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeFunction } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description: "Disallows operators that return connectable observables.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoDeepOperatorsRule.ts b/source/rules/rxjsNoDeepOperatorsRule.ts
@@ -11,7 +11,7 @@ import * as peer from "../support/peer";
 export class Rule extends Lint.Rules.AbstractRule {
   public static metadata: Lint.IRuleMetadata = {
     deprecationMessage:
-      peer.v6 && !peer.compat ? "Rule not needed for v6." : undefined,
+      peer.v6 && !peer.compat ? peer.v6NotNeededMessage : undefined,
     description: "Disallows deep importation from 'rxjs/operators'.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoExplicitGenericsRule.ts b/source/rules/rxjsNoExplicitGenericsRule.ts
@@ -7,9 +7,11 @@ import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as tsutils from "tsutils";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 
 export class Rule extends Lint.Rules.AbstractRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description: "Disallows explicit generic type arguments.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoExposedSubjectsRule.ts b/source/rules/rxjsNoExposedSubjectsRule.ts
@@ -7,12 +7,14 @@
 import * as Lint from "tslint";
 import * as tsutils from "tsutils";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType } from "../support/util";
 
 const defaultAllowedTypesRegExp = /^EventEmitter$/;
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description: "Disallows exposed subjects.",
     options: {
       properties: {

diff --git a/source/rules/rxjsNoIgnoredNotifierRule.ts b/source/rules/rxjsNoIgnoredNotifierRule.ts
@@ -7,10 +7,12 @@ import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as tsutils from "tsutils";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description:
       "Disallows observables not composed from the `repeatWhen` or `retryWhen` notifier.",
     options: null,

diff --git a/source/rules/rxjsNoIgnoredObservableRule.ts b/source/rules/rxjsNoIgnoredObservableRule.ts
@@ -6,10 +6,12 @@
 import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description: "Disallows the ignoring of observables returned by functions.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoIgnoredReplayBufferRule.ts b/source/rules/rxjsNoIgnoredReplayBufferRule.ts
@@ -6,9 +6,11 @@
 import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 
 export class Rule extends Lint.Rules.AbstractRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description:
       "Disallows using `ReplaySubject`, `publishReplay` or `shareReplay` without specifying the buffer size.",
     options: null,

diff --git a/source/rules/rxjsNoIgnoredSubscriptionRule.ts b/source/rules/rxjsNoIgnoredSubscriptionRule.ts
@@ -7,10 +7,12 @@ import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as tsutils from "tsutils";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description: "Disallows ignoring the subscription returned by subscribe.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoIndexRule.ts b/source/rules/rxjsNoIndexRule.ts
@@ -6,10 +6,11 @@
 
 import * as Lint from "tslint";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 
 export class Rule extends Lint.Rules.AbstractRule {
   public static metadata: Lint.IRuleMetadata = {
-    deprecationMessage: undefined,
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description: "Disallows the importation from index modules.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoInternalRule.ts b/source/rules/rxjsNoInternalRule.ts
@@ -6,10 +6,11 @@
 
 import * as Lint from "tslint";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 
 export class Rule extends Lint.Rules.AbstractRule {
   public static metadata: Lint.IRuleMetadata = {
-    deprecationMessage: undefined,
+    deprecationMessage: peer.v5 ? peer.v6OnlyMessage : undefined,
     description: "Disallows the importation of internals.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoNestedSubscribeRule.ts b/source/rules/rxjsNoNestedSubscribeRule.ts
@@ -7,10 +7,12 @@ import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as tsutils from "tsutils";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description:
       "Disallows the calling of `subscribe` within a `subscribe` callback.",
     options: null,

diff --git a/source/rules/rxjsNoOperatorRule.ts b/source/rules/rxjsNoOperatorRule.ts
@@ -11,7 +11,7 @@ import * as peer from "../support/peer";
 export class Rule extends Lint.Rules.AbstractRule {
   public static metadata: Lint.IRuleMetadata = {
     deprecationMessage:
-      peer.v6 && !peer.compat ? "Rule not needed for v6." : undefined,
+      peer.v6 && !peer.compat ? peer.v6NotNeededMessage : undefined,
     description: "Disallows importation from 'rxjs/operator'.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoPatchedRule.ts b/source/rules/rxjsNoPatchedRule.ts
@@ -13,7 +13,7 @@ import { UsedWalker } from "../support/used-walker";
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
     deprecationMessage:
-      peer.v6 && !peer.compat ? "Rule not needed for v6." : undefined,
+      peer.v6 && !peer.compat ? peer.v6NotNeededMessage : undefined,
     description: "Disallows the calling of patched methods.",
     options: {
       properties: {

diff --git a/source/rules/rxjsNoRedundantNotifyRule.ts b/source/rules/rxjsNoRedundantNotifyRule.ts
@@ -6,10 +6,12 @@
 import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description:
       "Disallows redundant notifications from completed or errored observables.",
     options: null,

diff --git a/source/rules/rxjsNoSharereplayRule.ts b/source/rules/rxjsNoSharereplayRule.ts
@@ -7,9 +7,11 @@ import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as tsutils from "tsutils";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 
 export class Rule extends Lint.Rules.AbstractRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description: "Disallows using the `shareReplay` operator.",
     options: {
       properties: {

diff --git a/source/rules/rxjsNoSubclassRule.ts b/source/rules/rxjsNoSubclassRule.ts
@@ -6,10 +6,12 @@
 import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description: "Disallows subclassing RxJS classes.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoUnboundMethodsRule.ts b/source/rules/rxjsNoUnboundMethodsRule.ts
@@ -13,7 +13,7 @@ import { couldBeType } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
-    deprecationMessage: peer.v5 || peer.compat ? "Rule is v6-only." : undefined,
+    deprecationMessage: peer.v5 ? peer.v6OnlyMessage : undefined,
     description: "Disallows the passing of unbound methods.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsNoUnusedAddRule.ts b/source/rules/rxjsNoUnusedAddRule.ts
@@ -14,7 +14,7 @@ import { UsedWalker } from "../support/used-walker";
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
     deprecationMessage:
-      peer.v6 && !peer.compat ? "Rule not needed for v6." : undefined,
+      peer.v6 && !peer.compat ? peer.v6NotNeededMessage : undefined,
     description:
       "Disallows the importation of patched observables or operators that are not used in the module.",
     options: null,

diff --git a/source/rules/rxjsNoWholesaleRule.ts b/source/rules/rxjsNoWholesaleRule.ts
@@ -11,7 +11,7 @@ import * as peer from "../support/peer";
 export class Rule extends Lint.Rules.AbstractRule {
   public static metadata: Lint.IRuleMetadata = {
     deprecationMessage:
-      peer.v6 && !peer.compat ? "Rule not needed for v6." : undefined,
+      peer.v6 && !peer.compat ? peer.v6NotNeededMessage : undefined,
     description: "Disallows the wholesale importation of `rxjs` or `rxjs/Rx`.",
     options: null,
     optionsDescription: "Not configurable.",

diff --git a/source/rules/rxjsPreferAngularAsyncPipeRule.ts b/source/rules/rxjsPreferAngularAsyncPipeRule.ts
@@ -6,10 +6,12 @@
 import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description:
       "Disallows the calling of `subscribe` within an Angular component.",
     options: null,

diff --git a/source/rules/rxjsPreferAngularCompositionRule.ts b/source/rules/rxjsPreferAngularCompositionRule.ts
@@ -6,10 +6,12 @@
 import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType, isThis } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description:
       "Enforces the composition of subscriptions within an Angular component.",
     options: null,

diff --git a/source/rules/rxjsPreferAngularTakeuntilRule.ts b/source/rules/rxjsPreferAngularTakeuntilRule.ts
@@ -8,10 +8,12 @@ import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as tsutils from "tsutils";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType, isThis } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description: Lint.Utils
       .dedent`Enforces the application of the takeUntil operator
       when calling subscribe within an Angular component.`,

diff --git a/source/rules/rxjsPreferObserverRule.ts b/source/rules/rxjsPreferObserverRule.ts
@@ -12,7 +12,7 @@ import { couldBeFunction, couldBeType } from "../support/util";
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
-    deprecationMessage: peer.v5 || peer.compat ? "Rule is v6-only." : undefined,
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description: "Enforces the passing of observers to `subscribe` and `tap`.",
     options: {
       properties: {

diff --git a/source/rules/rxjsSuffixSubjectsRule.ts b/source/rules/rxjsSuffixSubjectsRule.ts
@@ -6,12 +6,14 @@
 import { tsquery } from "@phenomnomnominal/tsquery";
 import * as Lint from "tslint";
 import * as ts from "typescript";
+import * as peer from "../support/peer";
 import { couldBeType } from "../support/util";
 
 const defaultTypesRegExp = /^EventEmitter$/;
 
 export class Rule extends Lint.Rules.TypedRule {
   public static metadata: Lint.IRuleMetadata = {
+    deprecationMessage: peer.v5 ? peer.v5NotSupportedMessage : undefined,
     description:
       "Disalllows subjects that don't end with the specified `suffix` option.",
     options: {

diff --git a/source/support/peer.ts b/source/support/peer.ts
@@ -36,7 +36,11 @@ export const compat = peerDir
 export const dir = peerDir;
 export const version = peerVersion;
 export const v5 = peerVersion && semver.satisfies(peerVersion, "^5.0.0");
+export const v5NotSupportedMessage =
+  "This rule is v6-only. The rule might work with v5, it has not been tested and is not supported.";
 export const v6 = peerVersion && semver.satisfies(peerVersion, "^6.0.0-rc.0");
+export const v6NotNeededMessage = "Rule not needed for v6.";
+export const v6OnlyMessage = "This rule is v6-only.";
 
 export function warn(dir: string = ""): void {
   /*tslint:disable-next-line:no-console*/