eslint-plugin-rxjs-x 0.9.3 → 0.9.5

package/README.md

@@ -4,7 +4,7 @@
 [![NPM version](https://img.shields.io/npm/v/eslint-plugin-rxjs-x.svg)](https://www.npmjs.com/package/eslint-plugin-rxjs-x)
 [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/JasonWeinzierl/eslint-plugin-rxjs-x/badge)](https://scorecard.dev/viewer/?uri=github.com/JasonWeinzierl/eslint-plugin-rxjs-x)
 
-This ESLint plugin is intended to prevent issues with [RxJS](https://github.com/ReactiveX/rxjs).
+This ESLint plugin is intended to prevent issues with [RxJS 7](https://github.com/ReactiveX/rxjs/tree/7.x).
 
 Most of these rules require TypeScript typed linting and are indicated as such below.
 

package/dist/index.d.mts

@@ -258,9 +258,10 @@ declare const allRules: {
         description: "Disallow importing operators from `rxjs/operators`.";
         recommended: "recommended";
     }, TSESLint.RuleListener>;
-    'suffix-subjects': TSESLint.RuleModule<"forbidden", readonly {
+    'suffix-subjects': TSESLint.RuleModule<"forbidden" | "forbiddenProperty", readonly {
         parameters?: boolean;
         properties?: boolean;
+        objects?: boolean;
         suffix?: string;
         types?: Record<string, boolean>;
         variables?: boolean;

package/dist/index.d.ts

@@ -258,9 +258,10 @@ declare const allRules: {
         description: "Disallow importing operators from `rxjs/operators`.";
         recommended: "recommended";
     }, TSESLint.RuleListener>;
-    'suffix-subjects': TSESLint.RuleModule<"forbidden", readonly {
+    'suffix-subjects': TSESLint.RuleModule<"forbidden" | "forbiddenProperty", readonly {
         parameters?: boolean;
         properties?: boolean;
+        objects?: boolean;
         suffix?: string;
         types?: Record<string, boolean>;
         variables?: boolean;

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.9.3";
+var version = "0.9.5";
 
 // src/configs/recommended.ts
 var createRecommendedConfig = (plugin2) => ({
@@ -412,52 +412,6 @@ function findIsLastOperatorOrderValid(pipeCallExpression, operatorsRegExp, allow
   return { isOrderValid, operatorNode };
 }
 
-// src/constants.ts
-var defaultObservable = String.raw`[Aa]ction(s|s\$|\$)$`;
-var SOURCES_OBJECT_ACCEPTING_STATIC_OBSERVABLE_CREATORS = [
-  "combineLatest",
-  "forkJoin"
-];
-var MULTIPLE_OBSERVABLE_ACCEPTING_STATIC_OBSERVABLE_CREATORS = [
-  "combineLatest",
-  "forkJoin",
-  "merge",
-  "zip",
-  "concat",
-  "race"
-];
-var DEFAULT_UNBOUND_ALLOWED_TYPES = [
-  "Signal"
-];
-var DEFAULT_VALID_POST_COMPLETION_OPERATORS = [
-  "count",
-  "defaultIfEmpty",
-  "endWith",
-  "every",
-  "finalize",
-  "finally",
-  "isEmpty",
-  "last",
-  "max",
-  "min",
-  "publish",
-  "publishBehavior",
-  "publishLast",
-  "publishReplay",
-  "reduce",
-  "share",
-  "shareReplay",
-  "skipLast",
-  "takeLast",
-  "throwIfEmpty",
-  "toArray"
-];
-
-// src/utils/is-sources-object-accepting-static-observable-creator.ts
-function isSourcesObjectAcceptingStaticObservableCreator(expression) {
-  return isCallExpression(expression) && isIdentifier(expression.callee) && SOURCES_OBJECT_ACCEPTING_STATIC_OBSERVABLE_CREATORS.includes(expression.callee.name);
-}
-
 // src/utils/rule-creator.ts
 
 var REPO_URL = "https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x";
@@ -755,6 +709,9 @@ var finnishRule = ruleCreator({
       },
       "PropertyDefinition[computed=false]": (node) => {
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key);
         }
       },
@@ -784,19 +741,44 @@ var finnishRule = ruleCreator({
       },
       "MethodDefinition[kind='get'][computed=false]": (node) => {
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key, node);
         }
       },
       "MethodDefinition[kind='method'][computed=false]": (node) => {
         if (validate.methods) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key, node);
         }
       },
       "MethodDefinition[kind='set'][computed=false]": (node) => {
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key, node);
         }
       },
+      "TSAbstractMethodDefinition[computed=false]": (node) => {
+        if (node.override) {
+          return;
+        }
+        if (validate.methods && node.kind === "method") {
+          checkNode(node.key, node);
+        }
+        if (validate.properties && (node.kind === "get" || node.kind === "set")) {
+          checkNode(node.key, node);
+        }
+        if (validate.parameters) {
+          node.value.params.forEach((param) => {
+            checkNode(param);
+          });
+        }
+      },
       "ObjectExpression > Property[computed=false] > Identifier": (node) => {
         if (!validate.objects) {
           return;
@@ -1150,6 +1132,49 @@ var noCreateRule = ruleCreator({
 
 
 
+
+// src/constants.ts
+var defaultObservable = String.raw`[Aa]ction(s|s\$|\$)$`;
+var SOURCES_OBJECT_ACCEPTING_STATIC_OBSERVABLE_CREATORS = [
+  "combineLatest",
+  "forkJoin"
+];
+var MULTIPLE_OBSERVABLE_ACCEPTING_STATIC_OBSERVABLE_CREATORS = [
+  "combineLatest",
+  "forkJoin",
+  "merge",
+  "zip",
+  "concat",
+  "race"
+];
+var DEFAULT_UNBOUND_ALLOWED_TYPES = [
+  "Signal"
+];
+var DEFAULT_VALID_POST_COMPLETION_OPERATORS = [
+  "count",
+  "defaultIfEmpty",
+  "endWith",
+  "every",
+  "finalize",
+  "finally",
+  "isEmpty",
+  "last",
+  "max",
+  "min",
+  "publish",
+  "publishBehavior",
+  "publishLast",
+  "publishReplay",
+  "reduce",
+  "share",
+  "shareReplay",
+  "skipLast",
+  "takeLast",
+  "throwIfEmpty",
+  "toArray"
+];
+
+// src/rules/no-cyclic-action.ts
 function isTypeReference2(type) {
   return Boolean(type.target);
 }
@@ -4139,6 +4164,7 @@ var preferRootOperatorsRule = ruleCreator({
 // src/rules/suffix-subjects.ts
 
 var defaultOptions18 = [];
+var baseShouldHaveSuffix = 'Subject identifiers must end with "{{suffix}}".';
 var suffixSubjectsRule = ruleCreator({
   defaultOptions: defaultOptions18,
   meta: {
@@ -4147,13 +4173,15 @@ var suffixSubjectsRule = ruleCreator({
       requiresTypeChecking: true
     },
     messages: {
-      forbidden: `Subject identifiers must end with "{{suffix}}".`
+      forbidden: baseShouldHaveSuffix,
+      forbiddenProperty: `${baseShouldHaveSuffix} Add a type annotation, assertion, or 'satisfies' to silence this rule.`
     },
     schema: [
       {
         properties: {
           parameters: { type: "boolean", description: "Require for parameters." },
-          properties: { type: "boolean", description: "Require for properties." },
+          properties: { type: "boolean", description: 'Require for properties, except object literal keys (see "objects" option).' },
+          objects: { type: "boolean", description: "Require for object literal keys." },
           suffix: { type: "string", description: "The suffix to enforce." },
           types: { type: "object", description: "Enforce for specific types. Keys are a RegExp, values are a boolean." },
           variables: { type: "boolean", description: "Require for variables." }
@@ -4171,6 +4199,7 @@ var suffixSubjectsRule = ruleCreator({
     const validate = {
       parameters: true,
       properties: true,
+      objects: true,
       variables: true,
       ...config
     };
@@ -4192,7 +4221,7 @@ var suffixSubjectsRule = ruleCreator({
       String.raw`${escapeRegExp(suffix)}\$?$`,
       "i"
     );
-    function checkNode(nameNode, typeNode) {
+    function checkNode(nameNode, typeNode, shouldMessage = "forbidden") {
       const tsNode = esTreeNodeToTSNodeMap.get(nameNode);
       const text = tsNode.getText();
       if (!suffixRegex.test(text) && couldBeType2(typeNode != null ? typeNode : nameNode, "Subject")) {
@@ -4205,7 +4234,7 @@ var suffixSubjectsRule = ruleCreator({
         context.report({
           data: { suffix },
           loc: getLoc(tsNode),
-          messageId: "forbidden"
+          messageId: shouldMessage
         });
       }
     }
@@ -4221,7 +4250,7 @@ var suffixSubjectsRule = ruleCreator({
         if (!found) {
           return;
         }
-        if (!validate.variables && found.type === _utils.AST_NODE_TYPES.VariableDeclarator) {
+        if (!validate.variables && isVariableDeclarator(found)) {
           return;
         }
         if (!validate.parameters) {
@@ -4240,6 +4269,9 @@ var suffixSubjectsRule = ruleCreator({
       "PropertyDefinition[computed=false]": (node) => {
         const anyNode = node;
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(anyNode.key);
         }
       },
@@ -4261,21 +4293,58 @@ var suffixSubjectsRule = ruleCreator({
       },
       "MethodDefinition[kind='get'][computed=false]": (node) => {
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key, node);
         }
       },
       "MethodDefinition[kind='set'][computed=false]": (node) => {
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key, node);
         }
       },
+      "TSAbstractMethodDefinition[computed=false]": (node) => {
+        if (node.override) {
+          return;
+        }
+        if (validate.properties && (node.kind === "get" || node.kind === "set")) {
+          checkNode(node.key, node);
+        }
+        if (validate.parameters) {
+          node.value.params.forEach((param) => {
+            checkNode(param);
+          });
+        }
+      },
       "ObjectExpression > Property[computed=false] > Identifier": (node) => {
-        if (validate.properties) {
-          const parent = node.parent;
-          if (node === parent.key && !isSourcesObjectAcceptingStaticObservableCreator(parent.parent.parent)) {
-            checkNode(node);
+        if (!validate.objects) {
+          return;
+        }
+        const parent = node.parent;
+        if (node !== parent.key) {
+          return;
+        }
+        const found = findParent(
+          node,
+          "CallExpression",
+          "VariableDeclarator",
+          "TSSatisfiesExpression",
+          "TSAsExpression"
+        );
+        if (found) {
+          if (isCallExpression(found)) {
+            return;
+          } else if (isVariableDeclarator(found) && !!found.id.typeAnnotation) {
+            return;
+          } else if (isTSAsExpression(found) || isTSSatisfiesExpression(found)) {
+            return;
           }
         }
+        checkNode(node, void 0, "forbiddenProperty");
       },
       "ObjectPattern > Property > Identifier": (node) => {
         const found = findParent(
@@ -4288,7 +4357,7 @@ var suffixSubjectsRule = ruleCreator({
         if (!found) {
           return;
         }
-        if (!validate.variables && found.type === _utils.AST_NODE_TYPES.VariableDeclarator) {
+        if (!validate.variables && isVariableDeclarator(found)) {
           return;
         }
         if (!validate.parameters) {

package/dist/index.mjs

@@ -1,6 +1,6 @@
 // package.json
 var name = "eslint-plugin-rxjs-x";
-var version = "0.9.3";
+var version = "0.9.5";
 
 // src/configs/recommended.ts
 var createRecommendedConfig = (plugin2) => ({
@@ -412,52 +412,6 @@ function findIsLastOperatorOrderValid(pipeCallExpression, operatorsRegExp, allow
   return { isOrderValid, operatorNode };
 }
 
-// src/constants.ts
-var defaultObservable = String.raw`[Aa]ction(s|s\$|\$)$`;
-var SOURCES_OBJECT_ACCEPTING_STATIC_OBSERVABLE_CREATORS = [
-  "combineLatest",
-  "forkJoin"
-];
-var MULTIPLE_OBSERVABLE_ACCEPTING_STATIC_OBSERVABLE_CREATORS = [
-  "combineLatest",
-  "forkJoin",
-  "merge",
-  "zip",
-  "concat",
-  "race"
-];
-var DEFAULT_UNBOUND_ALLOWED_TYPES = [
-  "Signal"
-];
-var DEFAULT_VALID_POST_COMPLETION_OPERATORS = [
-  "count",
-  "defaultIfEmpty",
-  "endWith",
-  "every",
-  "finalize",
-  "finally",
-  "isEmpty",
-  "last",
-  "max",
-  "min",
-  "publish",
-  "publishBehavior",
-  "publishLast",
-  "publishReplay",
-  "reduce",
-  "share",
-  "shareReplay",
-  "skipLast",
-  "takeLast",
-  "throwIfEmpty",
-  "toArray"
-];
-
-// src/utils/is-sources-object-accepting-static-observable-creator.ts
-function isSourcesObjectAcceptingStaticObservableCreator(expression) {
-  return isCallExpression(expression) && isIdentifier(expression.callee) && SOURCES_OBJECT_ACCEPTING_STATIC_OBSERVABLE_CREATORS.includes(expression.callee.name);
-}
-
 // src/utils/rule-creator.ts
 import { ESLintUtils as ESLintUtils2 } from "@typescript-eslint/utils";
 var REPO_URL = "https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x";
@@ -755,6 +709,9 @@ var finnishRule = ruleCreator({
       },
       "PropertyDefinition[computed=false]": (node) => {
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key);
         }
       },
@@ -784,19 +741,44 @@ var finnishRule = ruleCreator({
       },
       "MethodDefinition[kind='get'][computed=false]": (node) => {
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key, node);
         }
       },
       "MethodDefinition[kind='method'][computed=false]": (node) => {
         if (validate.methods) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key, node);
         }
       },
       "MethodDefinition[kind='set'][computed=false]": (node) => {
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key, node);
         }
       },
+      "TSAbstractMethodDefinition[computed=false]": (node) => {
+        if (node.override) {
+          return;
+        }
+        if (validate.methods && node.kind === "method") {
+          checkNode(node.key, node);
+        }
+        if (validate.properties && (node.kind === "get" || node.kind === "set")) {
+          checkNode(node.key, node);
+        }
+        if (validate.parameters) {
+          node.value.params.forEach((param) => {
+            checkNode(param);
+          });
+        }
+      },
       "ObjectExpression > Property[computed=false] > Identifier": (node) => {
         if (!validate.objects) {
           return;
@@ -1150,6 +1132,49 @@ var noCreateRule = ruleCreator({
 import { ESLintUtils as ESLintUtils4 } from "@typescript-eslint/utils";
 import { stripIndent as stripIndent3 } from "common-tags";
 import ts4 from "typescript";
+
+// src/constants.ts
+var defaultObservable = String.raw`[Aa]ction(s|s\$|\$)$`;
+var SOURCES_OBJECT_ACCEPTING_STATIC_OBSERVABLE_CREATORS = [
+  "combineLatest",
+  "forkJoin"
+];
+var MULTIPLE_OBSERVABLE_ACCEPTING_STATIC_OBSERVABLE_CREATORS = [
+  "combineLatest",
+  "forkJoin",
+  "merge",
+  "zip",
+  "concat",
+  "race"
+];
+var DEFAULT_UNBOUND_ALLOWED_TYPES = [
+  "Signal"
+];
+var DEFAULT_VALID_POST_COMPLETION_OPERATORS = [
+  "count",
+  "defaultIfEmpty",
+  "endWith",
+  "every",
+  "finalize",
+  "finally",
+  "isEmpty",
+  "last",
+  "max",
+  "min",
+  "publish",
+  "publishBehavior",
+  "publishLast",
+  "publishReplay",
+  "reduce",
+  "share",
+  "shareReplay",
+  "skipLast",
+  "takeLast",
+  "throwIfEmpty",
+  "toArray"
+];
+
+// src/rules/no-cyclic-action.ts
 function isTypeReference2(type) {
   return Boolean(type.target);
 }
@@ -4137,8 +4162,9 @@ var preferRootOperatorsRule = ruleCreator({
 });
 
 // src/rules/suffix-subjects.ts
-import { AST_NODE_TYPES as AST_NODE_TYPES8, ESLintUtils as ESLintUtils12 } from "@typescript-eslint/utils";
+import { ESLintUtils as ESLintUtils12 } from "@typescript-eslint/utils";
 var defaultOptions18 = [];
+var baseShouldHaveSuffix = 'Subject identifiers must end with "{{suffix}}".';
 var suffixSubjectsRule = ruleCreator({
   defaultOptions: defaultOptions18,
   meta: {
@@ -4147,13 +4173,15 @@ var suffixSubjectsRule = ruleCreator({
       requiresTypeChecking: true
     },
     messages: {
-      forbidden: `Subject identifiers must end with "{{suffix}}".`
+      forbidden: baseShouldHaveSuffix,
+      forbiddenProperty: `${baseShouldHaveSuffix} Add a type annotation, assertion, or 'satisfies' to silence this rule.`
     },
     schema: [
       {
         properties: {
           parameters: { type: "boolean", description: "Require for parameters." },
-          properties: { type: "boolean", description: "Require for properties." },
+          properties: { type: "boolean", description: 'Require for properties, except object literal keys (see "objects" option).' },
+          objects: { type: "boolean", description: "Require for object literal keys." },
           suffix: { type: "string", description: "The suffix to enforce." },
           types: { type: "object", description: "Enforce for specific types. Keys are a RegExp, values are a boolean." },
           variables: { type: "boolean", description: "Require for variables." }
@@ -4171,6 +4199,7 @@ var suffixSubjectsRule = ruleCreator({
     const validate = {
       parameters: true,
       properties: true,
+      objects: true,
       variables: true,
       ...config
     };
@@ -4192,7 +4221,7 @@ var suffixSubjectsRule = ruleCreator({
       String.raw`${escapeRegExp(suffix)}\$?$`,
       "i"
     );
-    function checkNode(nameNode, typeNode) {
+    function checkNode(nameNode, typeNode, shouldMessage = "forbidden") {
       const tsNode = esTreeNodeToTSNodeMap.get(nameNode);
       const text = tsNode.getText();
       if (!suffixRegex.test(text) && couldBeType2(typeNode != null ? typeNode : nameNode, "Subject")) {
@@ -4205,7 +4234,7 @@ var suffixSubjectsRule = ruleCreator({
         context.report({
           data: { suffix },
           loc: getLoc(tsNode),
-          messageId: "forbidden"
+          messageId: shouldMessage
         });
       }
     }
@@ -4221,7 +4250,7 @@ var suffixSubjectsRule = ruleCreator({
         if (!found) {
           return;
         }
-        if (!validate.variables && found.type === AST_NODE_TYPES8.VariableDeclarator) {
+        if (!validate.variables && isVariableDeclarator(found)) {
           return;
         }
         if (!validate.parameters) {
@@ -4240,6 +4269,9 @@ var suffixSubjectsRule = ruleCreator({
       "PropertyDefinition[computed=false]": (node) => {
         const anyNode = node;
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(anyNode.key);
         }
       },
@@ -4261,21 +4293,58 @@ var suffixSubjectsRule = ruleCreator({
       },
       "MethodDefinition[kind='get'][computed=false]": (node) => {
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key, node);
         }
       },
       "MethodDefinition[kind='set'][computed=false]": (node) => {
         if (validate.properties) {
+          if (node.override) {
+            return;
+          }
           checkNode(node.key, node);
         }
       },
+      "TSAbstractMethodDefinition[computed=false]": (node) => {
+        if (node.override) {
+          return;
+        }
+        if (validate.properties && (node.kind === "get" || node.kind === "set")) {
+          checkNode(node.key, node);
+        }
+        if (validate.parameters) {
+          node.value.params.forEach((param) => {
+            checkNode(param);
+          });
+        }
+      },
       "ObjectExpression > Property[computed=false] > Identifier": (node) => {
-        if (validate.properties) {
-          const parent = node.parent;
-          if (node === parent.key && !isSourcesObjectAcceptingStaticObservableCreator(parent.parent.parent)) {
-            checkNode(node);
+        if (!validate.objects) {
+          return;
+        }
+        const parent = node.parent;
+        if (node !== parent.key) {
+          return;
+        }
+        const found = findParent(
+          node,
+          "CallExpression",
+          "VariableDeclarator",
+          "TSSatisfiesExpression",
+          "TSAsExpression"
+        );
+        if (found) {
+          if (isCallExpression(found)) {
+            return;
+          } else if (isVariableDeclarator(found) && !!found.id.typeAnnotation) {
+            return;
+          } else if (isTSAsExpression(found) || isTSSatisfiesExpression(found)) {
+            return;
           }
         }
+        checkNode(node, void 0, "forbiddenProperty");
       },
       "ObjectPattern > Property > Identifier": (node) => {
         const found = findParent(
@@ -4288,7 +4357,7 @@ var suffixSubjectsRule = ruleCreator({
         if (!found) {
           return;
         }
-        if (!validate.variables && found.type === AST_NODE_TYPES8.VariableDeclarator) {
+        if (!validate.variables && isVariableDeclarator(found)) {
           return;
         }
         if (!validate.parameters) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-rxjs-x",
   "type": "commonjs",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "packageManager": "yarn@4.12.0+sha512.f45ab632439a67f8bc759bf32ead036a1f413287b9042726b7cc4818b7b49e14e9423ba49b18f9e06ea4941c1ad062385b1d8760a8d5091a1a31e5f6219afca8",
   "description": "Modern ESLint plugin for RxJS",
   "author": "Jason Weinzierl <weinzierljason@gmail.com>",
@@ -67,8 +67,8 @@
   },
   "peerDependencies": {
     "eslint": "^8.57.0 || ^9.0.0",
-    "rxjs": ">=7.2.0",
-    "typescript": ">=4.8.4"
+    "rxjs": "^7.2.0",
+    "typescript": ">=4.8.4 <6.0.0"
   },
   "peerDependenciesMeta": {
     "rxjs": {