eslint-plugin-rxjs-x 0.7.6 → 0.8.0

package/dist/index.mjs

@@ -1,11 +1,12 @@
 // package.json
 var name = "eslint-plugin-rxjs-x";
-var version = "0.7.6";
+var version = "0.8.0";
 
 // src/configs/recommended.ts
 var createRecommendedConfig = (plugin2) => ({
   name: "rxjs-x/recommended",
   plugins: {
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion -- "A type annotation is necessary."
     "rxjs-x": plugin2
   },
   rules: {
@@ -36,6 +37,7 @@ var createRecommendedConfig = (plugin2) => ({
 var createStrictConfig = (plugin2) => ({
   name: "rxjs-x/strict",
   plugins: {
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion -- "A type annotation is necessary."
     "rxjs-x": plugin2
   },
   rules: {
@@ -218,6 +220,9 @@ import { AST_NODE_TYPES } from "@typescript-eslint/utils";
 function hasTypeAnnotation(node) {
   return "typeAnnotation" in node && !!node.typeAnnotation;
 }
+function isAccessorProperty(node) {
+  return node.type === AST_NODE_TYPES.AccessorProperty;
+}
 function isArrayExpression(node) {
   return node.type === AST_NODE_TYPES.ArrayExpression;
 }
@@ -435,6 +440,7 @@ import { ESLintUtils as ESLintUtils2 } from "@typescript-eslint/utils";
 var REPO_URL = "https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x";
 var ruleCreator = ESLintUtils2.RuleCreator(
   (name2) => `${REPO_URL}/blob/v${version}/docs/rules/${name2}.md`
+  // Ensure the resulting types are narrowed to exactly what each rule declares.
 );
 
 // src/rules/ban-observables.ts
@@ -2235,6 +2241,7 @@ var noInternalRule = ruleCreator({
 
 // src/rules/no-misused-observables.ts
 import { AST_NODE_TYPES as AST_NODE_TYPES6, ESLintUtils as ESLintUtils8 } from "@typescript-eslint/utils";
+import { getFunctionHeadLocation, isFunction } from "@typescript-eslint/utils/ast-utils";
 import * as tsutils2 from "ts-api-utils";
 import ts6 from "typescript";
 function parseChecksVoidReturn(checksVoidReturn) {
@@ -2376,10 +2383,14 @@ var noMisusedObservablesRule = ruleCreator({
       }
     }
     function checkJSXAttribute(node) {
-      if (!node.value || !isJSXExpressionContainer(node.value)) {
+      if (node.value == null || !isJSXExpressionContainer(node.value)) {
         return;
       }
-      if (couldReturnObservable(node.value.expression)) {
+      const expressionContainer = esTreeNodeToTSNodeMap.get(
+        node.value
+      );
+      const contextualType = checker.getContextualType(expressionContainer);
+      if (contextualType != null && isVoidReturningFunctionType(contextualType) && couldReturnObservable(node.value.expression)) {
         context.report({
           messageId: "forbiddenVoidReturnAttribute",
           node: node.value
@@ -2396,7 +2407,7 @@ var noMisusedObservablesRule = ruleCreator({
       for (const element of node.body.body) {
         const tsElement = esTreeNodeToTSNodeMap.get(element);
         const memberName = (_a = tsElement == null ? void 0 : tsElement.name) == null ? void 0 : _a.getText();
-        if (memberName === void 0) {
+        if (memberName == null) {
           continue;
         }
         if (!couldReturnObservable(element)) {
@@ -2407,7 +2418,7 @@ var noMisusedObservablesRule = ruleCreator({
         }
         for (const heritageType of heritageTypes) {
           const heritageMember = getMemberIfExists(heritageType, memberName);
-          if (heritageMember === void 0) {
+          if (heritageMember == null) {
             continue;
           }
           const memberType = checker.getTypeOfSymbolAtLocation(heritageMember, tsElement);
@@ -2425,7 +2436,7 @@ var noMisusedObservablesRule = ruleCreator({
     function checkProperty(node) {
       const tsNode = esTreeNodeToTSNodeMap.get(node);
       const contextualType = getPropertyContextualType(checker, tsNode);
-      if (contextualType === void 0) {
+      if (contextualType == null) {
         return;
       }
       if (!isVoidReturningFunctionType(contextualType)) {
@@ -2434,14 +2445,29 @@ var noMisusedObservablesRule = ruleCreator({
       if (!couldReturnObservable(node.value)) {
         return;
       }
-      context.report({
-        messageId: "forbiddenVoidReturnProperty",
-        node: node.value
-      });
+      if (isFunction(node.value)) {
+        const functionNode = node.value;
+        if (functionNode.returnType) {
+          context.report({
+            messageId: "forbiddenVoidReturnProperty",
+            node: functionNode.returnType.typeAnnotation
+          });
+        } else {
+          context.report({
+            messageId: "forbiddenVoidReturnProperty",
+            loc: getFunctionHeadLocation(functionNode, context.sourceCode)
+          });
+        }
+      } else {
+        context.report({
+          messageId: "forbiddenVoidReturnProperty",
+          node: node.value
+        });
+      }
     }
     function checkReturnStatement(node) {
       const tsNode = esTreeNodeToTSNodeMap.get(node);
-      if (tsNode.expression === void 0 || !node.argument) {
+      if (tsNode.expression == null || !node.argument) {
         return;
       }
       function getFunctionNode() {
@@ -2456,7 +2482,7 @@ var noMisusedObservablesRule = ruleCreator({
         return;
       }
       const contextualType = checker.getContextualType(tsNode.expression);
-      if (contextualType === void 0) {
+      if (contextualType == null) {
         return;
       }
       if (!isVoidReturningFunctionType(contextualType)) {
@@ -2484,7 +2510,7 @@ var noMisusedObservablesRule = ruleCreator({
     }
     function checkVariableDeclaration(node) {
       const tsNode = esTreeNodeToTSNodeMap.get(node);
-      if (tsNode.initializer === void 0 || !node.init || !node.id.typeAnnotation) {
+      if (tsNode.initializer == null || node.init == null || node.id.typeAnnotation == null) {
         return;
       }
       if (!isPossiblyFunctionType(node.id.typeAnnotation)) {
@@ -2531,6 +2557,9 @@ function isVoidReturningFunctionType(type) {
   for (const subType of tsutils2.unionTypeParts(type)) {
     for (const signature of subType.getCallSignatures()) {
       const returnType = signature.getReturnType();
+      if (couldBeType(returnType, "Observable")) {
+        return false;
+      }
       hasVoidReturn || (hasVoidReturn = tsutils2.isTypeFlagSet(returnType, ts6.TypeFlags.Void));
     }
   }
@@ -2547,7 +2576,7 @@ function getMemberIfExists(type, memberName) {
   return symbolMemberMatch != null ? symbolMemberMatch : tsutils2.getPropertyOfType(type, escapedMemberName);
 }
 function isStaticMember(node) {
-  return (isMethodDefinition(node) || isPropertyDefinition(node)) && node.static;
+  return (isMethodDefinition(node) || isPropertyDefinition(node) || isAccessorProperty(node)) && node.static;
 }
 function getPropertyContextualType(checker, tsNode) {
   if (ts6.isPropertyAssignment(tsNode)) {
@@ -2563,11 +2592,11 @@ function getPropertyContextualType(checker, tsNode) {
       return;
     }
     const objType = checker.getContextualType(obj);
-    if (objType === void 0) {
+    if (objType == null) {
       return;
     }
     const propertySymbol = checker.getPropertyOfType(objType, tsNode.name.text);
-    if (propertySymbol === void 0) {
+    if (propertySymbol == null) {
       return;
     }
     return checker.getTypeOfSymbolAtLocation(propertySymbol, tsNode.name);
@@ -4100,55 +4129,57 @@ var throwErrorRule = ruleCreator({
 });
 
 // src/index.ts
+var allRules = {
+  "ban-observables": banObservablesRule,
+  "ban-operators": banOperatorsRule,
+  "finnish": finnishRule,
+  "just": justRule,
+  "macro": macroRule,
+  "no-async-subscribe": noAsyncSubscribeRule,
+  "no-compat": noCompatRule,
+  "no-connectable": noConnectableRule,
+  "no-create": noCreateRule,
+  "no-cyclic-action": noCyclicActionRule,
+  "no-explicit-generics": noExplicitGenericsRule,
+  "no-exposed-subjects": noExposedSubjectsRule,
+  "no-finnish": noFinnishRule,
+  "no-floating-observables": noFloatingObservablesRule,
+  "no-ignored-default-value": noIgnoredDefaultValueRule,
+  "no-ignored-error": noIgnoredErrorRule,
+  "no-ignored-notifier": noIgnoredNotifierRule,
+  "no-ignored-replay-buffer": noIgnoredReplayBufferRule,
+  "no-ignored-subscribe": noIgnoredSubscribeRule,
+  "no-ignored-subscription": noIgnoredSubscriptionRule,
+  "no-ignored-takewhile-value": noIgnoredTakewhileValueRule,
+  "no-implicit-any-catch": noImplicitAnyCatchRule,
+  "no-index": noIndexRule,
+  "no-internal": noInternalRule,
+  "no-misused-observables": noMisusedObservablesRule,
+  "no-nested-subscribe": noNestedSubscribeRule,
+  "no-redundant-notify": noRedundantNotifyRule,
+  "no-sharereplay": noSharereplayRule,
+  "no-subclass": noSubclassRule,
+  "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,
+  "no-unsafe-catch": noUnsafeCatchRule,
+  "no-unsafe-first": noUnsafeFirstRule,
+  "no-unsafe-subject-next": noUnsafeSubjectNext,
+  "no-unsafe-switchmap": noUnsafeSwitchmapRule,
+  "no-unsafe-takeuntil": noUnsafeTakeuntilRule,
+  "prefer-observer": preferObserverRule,
+  "prefer-root-operators": preferRootOperatorsRule,
+  "suffix-subjects": suffixSubjectsRule,
+  "throw-error": throwErrorRule
+};
 var plugin = {
   meta: { name, version },
-  rules: {
-    "ban-observables": banObservablesRule,
-    "ban-operators": banOperatorsRule,
-    "finnish": finnishRule,
-    "just": justRule,
-    "macro": macroRule,
-    "no-async-subscribe": noAsyncSubscribeRule,
-    "no-compat": noCompatRule,
-    "no-connectable": noConnectableRule,
-    "no-create": noCreateRule,
-    "no-cyclic-action": noCyclicActionRule,
-    "no-explicit-generics": noExplicitGenericsRule,
-    "no-exposed-subjects": noExposedSubjectsRule,
-    "no-finnish": noFinnishRule,
-    "no-floating-observables": noFloatingObservablesRule,
-    "no-ignored-default-value": noIgnoredDefaultValueRule,
-    "no-ignored-error": noIgnoredErrorRule,
-    "no-ignored-notifier": noIgnoredNotifierRule,
-    "no-ignored-replay-buffer": noIgnoredReplayBufferRule,
-    "no-ignored-subscribe": noIgnoredSubscribeRule,
-    "no-ignored-subscription": noIgnoredSubscriptionRule,
-    "no-ignored-takewhile-value": noIgnoredTakewhileValueRule,
-    "no-implicit-any-catch": noImplicitAnyCatchRule,
-    "no-index": noIndexRule,
-    "no-internal": noInternalRule,
-    "no-misused-observables": noMisusedObservablesRule,
-    "no-nested-subscribe": noNestedSubscribeRule,
-    "no-redundant-notify": noRedundantNotifyRule,
-    "no-sharereplay": noSharereplayRule,
-    "no-subclass": noSubclassRule,
-    "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,
-    "no-unsafe-catch": noUnsafeCatchRule,
-    "no-unsafe-first": noUnsafeFirstRule,
-    "no-unsafe-subject-next": noUnsafeSubjectNext,
-    "no-unsafe-switchmap": noUnsafeSwitchmapRule,
-    "no-unsafe-takeuntil": noUnsafeTakeuntilRule,
-    "prefer-observer": preferObserverRule,
-    "prefer-root-operators": preferRootOperatorsRule,
-    "suffix-subjects": suffixSubjectsRule,
-    "throw-error": throwErrorRule
-  }
+  /** Compatibility with `defineConfig` until https://github.com/typescript-eslint/typescript-eslint/issues/11543 is addressed. */
+  rules: allRules
 };
 var rxjsX = {
   ...plugin,

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "eslint-plugin-rxjs-x",
   "type": "commonjs",
-  "version": "0.7.6",
-  "packageManager": "yarn@4.9.2+sha512.1fc009bc09d13cfd0e19efa44cbfc2b9cf6ca61482725eb35bbc5e257e093ebf4130db6dfe15d604ff4b79efd8e1e8e99b25fa7d0a6197c9f9826358d4d65c3c",
+  "version": "0.8.0",
+  "packageManager": "yarn@4.10.3+sha512.c38cafb5c7bb273f3926d04e55e1d8c9dfa7d9c3ea1f36a4868fa028b9e5f72298f0b7f401ad5eb921749eb012eb1c3bb74bf7503df3ee43fd600d14a018266f",
   "description": "ESLint v9+ plugin for RxJS",
   "author": "Jason Weinzierl <weinzierljason@gmail.com>",
   "license": "MIT",
@@ -72,29 +72,30 @@
     }
   },
   "devDependencies": {
-    "@eslint/js": "^9.29.0",
-    "@stylistic/eslint-plugin": "^4.4.1",
+    "@eslint/config-helpers": "0.4.1",
+    "@eslint/js": "^9.38.0",
+    "@stylistic/eslint-plugin": "^5.5.0",
     "@types/common-tags": "^1.8.4",
     "@types/node": "~18.18.0",
-    "@typescript-eslint/rule-tester": "^8.34.1",
+    "@typescript-eslint/rule-tester": "^8.46.2",
     "@typescript/vfs": "^1.6.1",
-    "@vitest/coverage-v8": "^3.2.3",
-    "@vitest/eslint-plugin": "^1.2.7",
-    "bumpp": "^10.1.1",
-    "eslint": "^9.29.0",
+    "@vitest/coverage-v8": "^3.2.4",
+    "@vitest/eslint-plugin": "^1.4.0",
+    "bumpp": "^10.3.1",
+    "eslint": "^9.38.0",
     "eslint-config-flat-gitignore": "^2.1.0",
-    "eslint-doc-generator": "^2.1.2",
-    "eslint-import-resolver-typescript": "^4.4.3",
-    "eslint-plugin-eslint-plugin": "^6.4.0",
-    "eslint-plugin-import-x": "^4.15.2",
-    "eslint-plugin-n": "^17.20.0",
+    "eslint-doc-generator": "~2.2.2",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-eslint-plugin": "^7.2.0",
+    "eslint-plugin-import-x": "^4.16.1",
+    "eslint-plugin-n": "^17.23.1",
     "markdownlint-cli2": "^0.18.1",
     "rxjs": "^7.8.2",
     "tsup": "^8.5.0",
     "typescript": "~5.8.3",
-    "typescript-eslint": "^8.34.1",
+    "typescript-eslint": "^8.46.2",
     "vite": "^6.3.5",
-    "vitest": "^3.2.3"
+    "vitest": "^3.2.4"
   },
   "engines": {
     "node": "^18.18.0 || ^20.9.0 || >= 21.1.0"