eslint-plugin-rxjs-x 0.5.1 → 0.6.1

package/README.md

@@ -86,7 +86,7 @@ The package includes the following rules.
 | [no-connectable](docs/rules/no-connectable.md)                         | Disallow operators that return connectable observables.                                                   |      |    |    | 💭 |    |
 | [no-create](docs/rules/no-create.md)                                   | Disallow the static `Observable.create` function.                                                         | ✅ 🔒 |    |    | 💭 |    |
 | [no-cyclic-action](docs/rules/no-cyclic-action.md)                     | Disallow cyclic actions in effects and epics.                                                             |      |    |    | 💭 |    |
-| [no-explicit-generics](docs/rules/no-explicit-generics.md)             | Disallow unnecessary explicit generic type arguments.                                                     | 🔒   |    |    |    |    |
+| [no-explicit-generics](docs/rules/no-explicit-generics.md)             | Disallow unnecessary explicit generic type arguments.                                                     |      |    |    |    |    |
 | [no-exposed-subjects](docs/rules/no-exposed-subjects.md)               | Disallow public and protected subjects.                                                                   | 🔒   |    |    | 💭 |    |
 | [no-finnish](docs/rules/no-finnish.md)                                 | Disallow Finnish notation.                                                                                |      |    |    | 💭 |    |
 | [no-floating-observables](docs/rules/no-floating-observables.md)       | Require Observables to be handled appropriately.                                                          | 🔒   |    |    | 💭 |    |
@@ -108,6 +108,7 @@ The package includes the following rules.
 | [no-subject-unsubscribe](docs/rules/no-subject-unsubscribe.md)         | Disallow calling the `unsubscribe` method of subjects.                                                    | ✅ 🔒 |    |    | 💭 |    |
 | [no-subject-value](docs/rules/no-subject-value.md)                     | Disallow accessing the `value` property of a `BehaviorSubject` instance.                                  |      |    |    | 💭 |    |
 | [no-subscribe-handlers](docs/rules/no-subscribe-handlers.md)           | Disallow passing handlers to `subscribe`.                                                                 |      |    |    | 💭 |    |
+| [no-subscribe-in-pipe](docs/rules/no-subscribe-in-pipe.md)             | Disallow calling of `subscribe` within any RxJS operator inside a `pipe`.                                 | ✅ 🔒 |    |    | 💭 |    |
 | [no-tap](docs/rules/no-tap.md)                                         | Disallow the `tap` operator.                                                                              |      |    |    |    | ❌  |
 | [no-topromise](docs/rules/no-topromise.md)                             | Disallow use of the `toPromise` method.                                                                   | ✅ 🔒 |    | 💡 | 💭 |    |
 | [no-unbound-methods](docs/rules/no-unbound-methods.md)                 | Disallow passing unbound methods.                                                                         | ✅ 🔒 |    |    | 💭 |    |

package/dist/index.d.mts

@@ -35,6 +35,7 @@ declare const rxjsX: {
                 'rxjs-x/no-redundant-notify': "error";
                 'rxjs-x/no-sharereplay': "error";
                 'rxjs-x/no-subject-unsubscribe': "error";
+                'rxjs-x/no-subscribe-in-pipe': "error";
                 'rxjs-x/no-topromise': "error";
                 'rxjs-x/no-unbound-methods': "error";
                 'rxjs-x/no-unsafe-subject-next': "error";
@@ -52,7 +53,6 @@ declare const rxjsX: {
             rules: {
                 'rxjs-x/no-async-subscribe': "error";
                 'rxjs-x/no-create': "error";
-                'rxjs-x/no-explicit-generics': "error";
                 'rxjs-x/no-exposed-subjects': "error";
                 'rxjs-x/no-floating-observables': "error";
                 'rxjs-x/no-ignored-default-value': "error";
@@ -71,6 +71,7 @@ declare const rxjsX: {
                 'rxjs-x/no-sharereplay': "error";
                 'rxjs-x/no-subclass': "error";
                 'rxjs-x/no-subject-unsubscribe': "error";
+                'rxjs-x/no-subscribe-in-pipe': "error";
                 'rxjs-x/no-topromise': "error";
                 'rxjs-x/no-unbound-methods': "error";
                 'rxjs-x/no-unsafe-subject-next': "error";
@@ -143,6 +144,7 @@ declare const rxjsX: {
         'no-subject-unsubscribe': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;
         'no-subject-value': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;
         'no-subscribe-handlers': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;
+        'no-subscribe-in-pipe': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;
         'no-tap': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;
         'no-topromise': TSESLint.RuleModule<"forbidden" | "suggestLastValueFrom" | "suggestFirstValueFrom", [], RxjsXRuleDocs, TSESLint.RuleListener>;
         'no-unbound-methods': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;

package/dist/index.d.ts

@@ -35,6 +35,7 @@ declare const rxjsX: {
                 'rxjs-x/no-redundant-notify': "error";
                 'rxjs-x/no-sharereplay': "error";
                 'rxjs-x/no-subject-unsubscribe': "error";
+                'rxjs-x/no-subscribe-in-pipe': "error";
                 'rxjs-x/no-topromise': "error";
                 'rxjs-x/no-unbound-methods': "error";
                 'rxjs-x/no-unsafe-subject-next': "error";
@@ -52,7 +53,6 @@ declare const rxjsX: {
             rules: {
                 'rxjs-x/no-async-subscribe': "error";
                 'rxjs-x/no-create': "error";
-                'rxjs-x/no-explicit-generics': "error";
                 'rxjs-x/no-exposed-subjects': "error";
                 'rxjs-x/no-floating-observables': "error";
                 'rxjs-x/no-ignored-default-value': "error";
@@ -71,6 +71,7 @@ declare const rxjsX: {
                 'rxjs-x/no-sharereplay': "error";
                 'rxjs-x/no-subclass': "error";
                 'rxjs-x/no-subject-unsubscribe': "error";
+                'rxjs-x/no-subscribe-in-pipe': "error";
                 'rxjs-x/no-topromise': "error";
                 'rxjs-x/no-unbound-methods': "error";
                 'rxjs-x/no-unsafe-subject-next': "error";
@@ -143,6 +144,7 @@ declare const rxjsX: {
         'no-subject-unsubscribe': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;
         'no-subject-value': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;
         'no-subscribe-handlers': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;
+        'no-subscribe-in-pipe': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;
         'no-tap': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;
         'no-topromise': TSESLint.RuleModule<"forbidden" | "suggestLastValueFrom" | "suggestFirstValueFrom", [], RxjsXRuleDocs, TSESLint.RuleListener>;
         'no-unbound-methods': TSESLint.RuleModule<"forbidden", [], RxjsXRuleDocs, TSESLint.RuleListener>;

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } } function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }// package.json
 var name = "eslint-plugin-rxjs-x";
-var version = "0.5.1";
+var version = "0.6.1";
 
 // src/configs/recommended.ts
 var createRecommendedConfig = (plugin2) => ({
@@ -21,6 +21,7 @@ var createRecommendedConfig = (plugin2) => ({
     "rxjs-x/no-redundant-notify": "error",
     "rxjs-x/no-sharereplay": "error",
     "rxjs-x/no-subject-unsubscribe": "error",
+    "rxjs-x/no-subscribe-in-pipe": "error",
     "rxjs-x/no-topromise": "error",
     "rxjs-x/no-unbound-methods": "error",
     "rxjs-x/no-unsafe-subject-next": "error",
@@ -40,7 +41,6 @@ var createStrictConfig = (plugin2) => ({
   rules: {
     "rxjs-x/no-async-subscribe": "error",
     "rxjs-x/no-create": "error",
-    "rxjs-x/no-explicit-generics": "error",
     "rxjs-x/no-exposed-subjects": "error",
     "rxjs-x/no-floating-observables": "error",
     "rxjs-x/no-ignored-default-value": "error",
@@ -59,6 +59,7 @@ var createStrictConfig = (plugin2) => ({
     "rxjs-x/no-sharereplay": "error",
     "rxjs-x/no-subclass": "error",
     "rxjs-x/no-subject-unsubscribe": "error",
+    "rxjs-x/no-subscribe-in-pipe": "error",
     "rxjs-x/no-topromise": "error",
     "rxjs-x/no-unbound-methods": "error",
     "rxjs-x/no-unsafe-subject-next": "error",
@@ -1094,8 +1095,7 @@ var noExplicitGenericsRule = ruleCreator({
   defaultOptions: [],
   meta: {
     docs: {
-      description: "Disallow unnecessary explicit generic type arguments.",
-      recommended: "strict"
+      description: "Disallow unnecessary explicit generic type arguments."
     },
     messages: {
       forbidden: "Explicit generic type arguments are forbidden."
@@ -2814,6 +2814,53 @@ var noSubscribeHandlersRule = ruleCreator({
   }
 });
 
+// src/rules/no-subscribe-in-pipe.ts
+
+var noSubscribeInPipeRule = ruleCreator({
+  defaultOptions: [],
+  meta: {
+    docs: {
+      description: "Disallow calling of `subscribe` within any RxJS operator inside a `pipe`.",
+      recommended: "recommended",
+      requiresTypeChecking: true
+    },
+    fixable: void 0,
+    hasSuggestions: false,
+    messages: {
+      forbidden: "Subscribe calls within pipe operators are forbidden."
+    },
+    schema: [],
+    type: "problem"
+  },
+  name: "no-subscribe-in-pipe",
+  create: (context) => {
+    const { couldBeObservable, couldBeType: couldBeType2 } = getTypeServices(context);
+    function isWithinPipe(node) {
+      let parent = node.parent;
+      while (parent) {
+        if (parent.type === _utils.AST_NODE_TYPES.CallExpression && parent.callee.type === _utils.AST_NODE_TYPES.MemberExpression && parent.callee.property.type === _utils.AST_NODE_TYPES.Identifier && parent.callee.property.name === "pipe") {
+          return true;
+        }
+        parent = parent.parent;
+      }
+      return false;
+    }
+    return {
+      "CallExpression > MemberExpression[property.name='subscribe']": (node) => {
+        if (!couldBeObservable(node.object) && !couldBeType2(node.object, "Subscribable")) {
+          return;
+        }
+        if (isWithinPipe(node)) {
+          context.report({
+            messageId: "forbidden",
+            node: node.property
+          });
+        }
+      }
+    };
+  }
+});
+
 // src/rules/no-tap.ts
 var noTapRule = ruleCreator({
   defaultOptions: [],
@@ -3972,6 +4019,7 @@ var plugin = {
     "no-subject-unsubscribe": noSubjectUnsubscribeRule,
     "no-subject-value": noSubjectValueRule,
     "no-subscribe-handlers": noSubscribeHandlersRule,
+    "no-subscribe-in-pipe": noSubscribeInPipeRule,
     "no-tap": noTapRule,
     "no-topromise": noTopromiseRule,
     "no-unbound-methods": noUnboundMethodsRule,

package/dist/index.mjs

@@ -1,6 +1,6 @@
 // package.json
 var name = "eslint-plugin-rxjs-x";
-var version = "0.5.1";
+var version = "0.6.1";
 
 // src/configs/recommended.ts
 var createRecommendedConfig = (plugin2) => ({
@@ -21,6 +21,7 @@ var createRecommendedConfig = (plugin2) => ({
     "rxjs-x/no-redundant-notify": "error",
     "rxjs-x/no-sharereplay": "error",
     "rxjs-x/no-subject-unsubscribe": "error",
+    "rxjs-x/no-subscribe-in-pipe": "error",
     "rxjs-x/no-topromise": "error",
     "rxjs-x/no-unbound-methods": "error",
     "rxjs-x/no-unsafe-subject-next": "error",
@@ -40,7 +41,6 @@ var createStrictConfig = (plugin2) => ({
   rules: {
     "rxjs-x/no-async-subscribe": "error",
     "rxjs-x/no-create": "error",
-    "rxjs-x/no-explicit-generics": "error",
     "rxjs-x/no-exposed-subjects": "error",
     "rxjs-x/no-floating-observables": "error",
     "rxjs-x/no-ignored-default-value": "error",
@@ -59,6 +59,7 @@ var createStrictConfig = (plugin2) => ({
     "rxjs-x/no-sharereplay": "error",
     "rxjs-x/no-subclass": "error",
     "rxjs-x/no-subject-unsubscribe": "error",
+    "rxjs-x/no-subscribe-in-pipe": "error",
     "rxjs-x/no-topromise": "error",
     "rxjs-x/no-unbound-methods": "error",
     "rxjs-x/no-unsafe-subject-next": "error",
@@ -1094,8 +1095,7 @@ var noExplicitGenericsRule = ruleCreator({
   defaultOptions: [],
   meta: {
     docs: {
-      description: "Disallow unnecessary explicit generic type arguments.",
-      recommended: "strict"
+      description: "Disallow unnecessary explicit generic type arguments."
     },
     messages: {
       forbidden: "Explicit generic type arguments are forbidden."
@@ -2814,6 +2814,53 @@ var noSubscribeHandlersRule = ruleCreator({
   }
 });
 
+// src/rules/no-subscribe-in-pipe.ts
+import { AST_NODE_TYPES as AST_NODE_TYPES8 } from "@typescript-eslint/utils";
+var noSubscribeInPipeRule = ruleCreator({
+  defaultOptions: [],
+  meta: {
+    docs: {
+      description: "Disallow calling of `subscribe` within any RxJS operator inside a `pipe`.",
+      recommended: "recommended",
+      requiresTypeChecking: true
+    },
+    fixable: void 0,
+    hasSuggestions: false,
+    messages: {
+      forbidden: "Subscribe calls within pipe operators are forbidden."
+    },
+    schema: [],
+    type: "problem"
+  },
+  name: "no-subscribe-in-pipe",
+  create: (context) => {
+    const { couldBeObservable, couldBeType: couldBeType2 } = getTypeServices(context);
+    function isWithinPipe(node) {
+      let parent = node.parent;
+      while (parent) {
+        if (parent.type === AST_NODE_TYPES8.CallExpression && parent.callee.type === AST_NODE_TYPES8.MemberExpression && parent.callee.property.type === AST_NODE_TYPES8.Identifier && parent.callee.property.name === "pipe") {
+          return true;
+        }
+        parent = parent.parent;
+      }
+      return false;
+    }
+    return {
+      "CallExpression > MemberExpression[property.name='subscribe']": (node) => {
+        if (!couldBeObservable(node.object) && !couldBeType2(node.object, "Subscribable")) {
+          return;
+        }
+        if (isWithinPipe(node)) {
+          context.report({
+            messageId: "forbidden",
+            node: node.property
+          });
+        }
+      }
+    };
+  }
+});
+
 // src/rules/no-tap.ts
 var noTapRule = ruleCreator({
   defaultOptions: [],
@@ -3660,7 +3707,7 @@ var preferRootOperatorsRule = ruleCreator({
 });
 
 // src/rules/suffix-subjects.ts
-import { AST_NODE_TYPES as AST_NODE_TYPES8, ESLintUtils as ESLintUtils11 } from "@typescript-eslint/utils";
+import { AST_NODE_TYPES as AST_NODE_TYPES9, ESLintUtils as ESLintUtils11 } from "@typescript-eslint/utils";
 var defaultOptions15 = [];
 var suffixSubjectsRule = ruleCreator({
   defaultOptions: defaultOptions15,
@@ -3744,7 +3791,7 @@ var suffixSubjectsRule = ruleCreator({
         if (!found) {
           return;
         }
-        if (!validate.variables && found.type === AST_NODE_TYPES8.VariableDeclarator) {
+        if (!validate.variables && found.type === AST_NODE_TYPES9.VariableDeclarator) {
           return;
         }
         if (!validate.parameters) {
@@ -3811,7 +3858,7 @@ var suffixSubjectsRule = ruleCreator({
         if (!found) {
           return;
         }
-        if (!validate.variables && found.type === AST_NODE_TYPES8.VariableDeclarator) {
+        if (!validate.variables && found.type === AST_NODE_TYPES9.VariableDeclarator) {
           return;
         }
         if (!validate.parameters) {
@@ -3972,6 +4019,7 @@ var plugin = {
     "no-subject-unsubscribe": noSubjectUnsubscribeRule,
     "no-subject-value": noSubjectValueRule,
     "no-subscribe-handlers": noSubscribeHandlersRule,
+    "no-subscribe-in-pipe": noSubscribeInPipeRule,
     "no-tap": noTapRule,
     "no-topromise": noTopromiseRule,
     "no-unbound-methods": noUnboundMethodsRule,

package/docs/rules/no-explicit-generics.md

@@ -1,7 +1,5 @@
 # Disallow unnecessary explicit generic type arguments (`rxjs-x/no-explicit-generics`)
 
-💼 This rule is enabled in the 🔒 `strict` config.
-
 <!-- end auto-generated rule header -->
 
 This rule prevents the use of explicit type arguments when the type arguments can be inferred.
@@ -21,3 +19,7 @@ Examples of **correct** code for this rule:
 import { BehaviorSubject } from "rxjs";
 const subject = new BehaviorSubject(42);
 ```
+
+## Known problems
+
+- ([#77](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/issues/77)) Type unions cause false positives e.g. `new BehaviorSubject<number | null>(null)` will be incorrectly caught by this rule.

package/docs/rules/no-subscribe-in-pipe.md

@@ -0,0 +1,37 @@
+# Disallow calling of `subscribe` within any RxJS operator inside a `pipe` (`rxjs-x/no-subscribe-in-pipe`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
+
+This rule effects failures if `subscribe` is called within any operator inside a `pipe` operation.
+
+## Rule details
+
+Examples of **incorrect** code for this rule:
+
+```ts
+import { of } from "rxjs";
+import { map } from "rxjs/operators";
+
+of(42, 54).pipe(
+  map(value => {
+    of(value).subscribe(console.log); // This will trigger the rule
+    return value * 2;
+  })
+).subscribe(result => console.log(result));
+```
+
+Examples of **correct** code for this rule:
+
+```ts
+import { of } from "rxjs";
+import { map, tap } from "rxjs/operators";
+
+of(42, 54).pipe(
+  tap(value => console.log(value)),
+  map(value => value * 2)
+).subscribe(result => console.log(result));
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-rxjs-x",
   "type": "commonjs",
-  "version": "0.5.1",
+  "version": "0.6.1",
   "packageManager": "yarn@4.5.3+sha512.3003a14012e2987072d244c720506549c1aab73ee728208f1b2580a9fd67b92d61ba6b08fe93f6dce68fd771e3af1e59a0afa28dd242dd0940d73b95fedd4e90",
   "description": "ESLint v9+ plugin for RxJS",
   "author": "Jason Weinzierl <weinzierljason@gmail.com>",
@@ -65,7 +65,7 @@
   "peerDependencies": {
     "eslint": "^8.57.0 || ^9.0.0",
     "rxjs": ">=7.2.0",
-    "typescript": ">=4.7.4"
+    "typescript": ">=4.8.4"
   },
   "peerDependenciesMeta": {
     "rxjs": {