@ngrx/eslint-plugin 20.0.0 → 20.1.0

package/src/index.d.ts

@@ -123,43 +123,43 @@ declare const _default: {
         };
     };
     rules: {
-        'avoid-combining-component-store-selectors': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidCombiningComponentStoreSelectors", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'avoid-mapping-component-store-selectors': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidMappingComponentStoreSelectors", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'updater-explicit-return-type': import("@typescript-eslint/utils/ts-eslint").RuleModule<"updaterExplicitReturnType", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'require-super-ondestroy': import("@typescript-eslint/utils/ts-eslint").RuleModule<"requireSuperOnDestroy", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'avoid-cyclic-effects': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidCyclicEffects", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'no-dispatch-in-effects': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noDispatchInEffects" | "noDispatchInEffectsSuggest", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'no-effects-in-providers': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noEffectsInProviders", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'no-multiple-actions-in-effects': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noMultipleActionsInEffects", readonly unknown[], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'prefer-action-creator-in-of-type': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferActionCreatorInOfType", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'prefer-effect-callback-in-block-statement': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferEffectCallbackInBlockStatement", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'use-effects-lifecycle-interface': import("@typescript-eslint/utils/ts-eslint").RuleModule<"useEffectsLifecycleInterface", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'avoid-combining-selectors': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidCombiningSelectors", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'avoid-dispatching-multiple-actions-sequentially': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidDispatchingMultipleActionsSequentially", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'avoid-duplicate-actions-in-reducer': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidDuplicateActionsInReducer" | "avoidDuplicateActionsInReducerSuggest", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'avoid-mapping-selectors': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidMapppingSelectors", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'good-action-hygiene': import("@typescript-eslint/utils/ts-eslint").RuleModule<"goodActionHygiene", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'no-multiple-global-stores': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noMultipleGlobalStores" | "noMultipleGlobalStoresSuggest", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'no-reducer-in-key-names': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noReducerInKeyNames" | "noReducerInKeyNamesSuggest", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'no-store-subscription': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noStoreSubscription", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'no-typed-global-store': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noTypedStore" | "noTypedStoreSuggest", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'on-function-explicit-return-type': import("@typescript-eslint/utils/ts-eslint").RuleModule<"onFunctionExplicitReturnType" | "onFunctionExplicitReturnTypeSuggest", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'prefer-action-creator': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferActionCreator", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'prefer-action-creator-in-dispatch': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferActionCreatorInDispatch", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'prefer-inline-action-props': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferInlineActionProps" | "preferInlineActionPropsSuggest", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'prefer-one-generic-in-create-for-feature-selector': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferOneGenericInCreateForFeatureSelector" | "preferOneGenericInCreateForFeatureSelectorSuggest", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'prefer-selector-in-select': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferSelectorInSelect", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'prefix-selectors-with-select': import("@typescript-eslint/utils/ts-eslint").RuleModule<"prefixSelectorsWithSelect" | "prefixSelectorsWithSelectSuggest", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'select-style': import("@typescript-eslint/utils/ts-eslint").RuleModule<"operator" | "method", readonly ["operator" | "method"], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'use-consistent-global-store-name': import("@typescript-eslint/utils/ts-eslint").RuleModule<"useConsistentGlobalStoreName" | "useConsistentGlobalStoreNameSuggest", readonly [string], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'avoid-combining-component-store-selectors': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidCombiningComponentStoreSelectors", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'avoid-mapping-component-store-selectors': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidMappingComponentStoreSelectors", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'updater-explicit-return-type': import("@typescript-eslint/utils/ts-eslint").RuleModule<"updaterExplicitReturnType", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'require-super-ondestroy': import("@typescript-eslint/utils/ts-eslint").RuleModule<"requireSuperOnDestroy", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'avoid-cyclic-effects': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidCyclicEffects", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'no-dispatch-in-effects': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noDispatchInEffects" | "noDispatchInEffectsSuggest", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'no-effects-in-providers': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noEffectsInProviders", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'no-multiple-actions-in-effects': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noMultipleActionsInEffects", readonly unknown[], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'prefer-action-creator-in-of-type': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferActionCreatorInOfType", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'prefer-effect-callback-in-block-statement': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferEffectCallbackInBlockStatement", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'use-effects-lifecycle-interface': import("@typescript-eslint/utils/ts-eslint").RuleModule<"useEffectsLifecycleInterface", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'avoid-combining-selectors': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidCombiningSelectors", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'avoid-dispatching-multiple-actions-sequentially': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidDispatchingMultipleActionsSequentially", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'avoid-duplicate-actions-in-reducer': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidDuplicateActionsInReducer" | "avoidDuplicateActionsInReducerSuggest", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'avoid-mapping-selectors': import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidMapppingSelectors", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'good-action-hygiene': import("@typescript-eslint/utils/ts-eslint").RuleModule<"goodActionHygiene", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'no-multiple-global-stores': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noMultipleGlobalStores" | "noMultipleGlobalStoresSuggest", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'no-reducer-in-key-names': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noReducerInKeyNames" | "noReducerInKeyNamesSuggest", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'no-store-subscription': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noStoreSubscription", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'no-typed-global-store': import("@typescript-eslint/utils/ts-eslint").RuleModule<"noTypedStore" | "noTypedStoreSuggest", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'on-function-explicit-return-type': import("@typescript-eslint/utils/ts-eslint").RuleModule<"onFunctionExplicitReturnType" | "onFunctionExplicitReturnTypeSuggest", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'prefer-action-creator': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferActionCreator", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'prefer-action-creator-in-dispatch': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferActionCreatorInDispatch", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'prefer-inline-action-props': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferInlineActionProps" | "preferInlineActionPropsSuggest", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'prefer-one-generic-in-create-for-feature-selector': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferOneGenericInCreateForFeatureSelector" | "preferOneGenericInCreateForFeatureSelectorSuggest", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'prefer-selector-in-select': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferSelectorInSelect", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'prefix-selectors-with-select': import("@typescript-eslint/utils/ts-eslint").RuleModule<"prefixSelectorsWithSelect" | "prefixSelectorsWithSelectSuggest", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'select-style': import("@typescript-eslint/utils/ts-eslint").RuleModule<"operator" | "method", readonly ["operator" | "method"], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'use-consistent-global-store-name': import("@typescript-eslint/utils/ts-eslint").RuleModule<"useConsistentGlobalStoreName" | "useConsistentGlobalStoreNameSuggest", readonly [string], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
         'prefer-concat-latest-from': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferConcatLatestFrom", readonly [{
             readonly strict: boolean;
-        }], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'signal-state-no-arrays-at-root-level': import("@typescript-eslint/utils/ts-eslint").RuleModule<"signalStateNoArraysAtRootLevel", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'signal-store-feature-should-use-generic-type': import("@typescript-eslint/utils/ts-eslint").RuleModule<"signalStoreFeatureShouldUseGenericType", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'prefer-protected-state': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferProtectedState" | "preferProtectedStateSuggest", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'with-state-no-arrays-at-root-level': import("@typescript-eslint/utils/ts-eslint").RuleModule<"withStateNoArraysAtRootLevel", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        'enforce-type-call': import("@typescript-eslint/utils/ts-eslint").RuleModule<"enforceTypeCall", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        }], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'signal-state-no-arrays-at-root-level': import("@typescript-eslint/utils/ts-eslint").RuleModule<"signalStateNoArraysAtRootLevel", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'signal-store-feature-should-use-generic-type': import("@typescript-eslint/utils/ts-eslint").RuleModule<"signalStoreFeatureShouldUseGenericType", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'prefer-protected-state': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferProtectedState" | "preferProtectedStateSuggest", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'with-state-no-arrays-at-root-level': import("@typescript-eslint/utils/ts-eslint").RuleModule<"withStateNoArraysAtRootLevel", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        'enforce-type-call': import("@typescript-eslint/utils/ts-eslint").RuleModule<"enforceTypeCall", readonly [], import("./rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
     };
 };
 export = _default;

package/src/rule-creator.d.ts

@@ -1,24 +1,8 @@
-import type { TSESLint } from '@typescript-eslint/utils';
-import type { NGRX_MODULE } from './utils';
-type Meta<TMessageIds extends string, TOptions extends readonly unknown[]> = TSESLint.RuleMetaData<TMessageIds, TOptions> & {
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { NGRX_MODULE } from './utils';
+export interface NgRxRuleDocs {
     ngrxModule: NGRX_MODULE;
-    version?: string;
-    docs: {
-        requiresTypeChecking?: boolean;
-    };
-};
-type CreateRuleMeta<TMessageIds extends string, TOptions extends readonly unknown[]> = {
-    docs: Omit<TSESLint.RuleMetaDataDocs, 'url'> & {
-        requiresTypeChecking?: boolean;
-    };
-} & Omit<Meta<TMessageIds, TOptions>, 'docs'>;
-export type NgRxRuleModule<TOptions extends readonly unknown[], TMessageIds extends string> = Omit<TSESLint.RuleModule<TMessageIds, TOptions>, 'meta'> & {
-    meta: Meta<TMessageIds, TOptions>;
-};
-export declare function createRule<TOptions extends readonly unknown[], TMessageIds extends string>(config: Readonly<{
-    name: string;
-    meta: CreateRuleMeta<TMessageIds, TOptions>;
-    defaultOptions: Readonly<TOptions>;
-    create: (context: Readonly<TSESLint.RuleContext<TMessageIds, TOptions>>, optionsWithDefault: Readonly<TOptions>) => TSESLint.RuleListener;
-}>): TSESLint.RuleModule<TMessageIds, TOptions>;
-export {};
+    requiresTypeChecking?: boolean;
+}
+export type NgRxRule = ReturnType<ReturnType<typeof ESLintUtils.RuleCreator<NgRxRuleDocs>>>;
+export declare const createRule: <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, NgRxRuleDocs>>) => ESLintUtils.RuleModule<MessageIds, Options, NgRxRuleDocs, ESLintUtils.RuleListener>;

package/src/rule-creator.js

@@ -1,23 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRule = createRule;
+exports.createRule = void 0;
 const utils_1 = require("@typescript-eslint/utils");
-const utils_2 = require("./utils");
-function createRule(config) {
-    const configOverwrite = {
-        ...config,
-        create: (context, optionsWithDefault) => {
-            const { meta: { ngrxModule, version }, } = config;
-            if (version !== undefined &&
-                !(0, utils_2.ngrxVersionSatisfies)(utils_2.NGRX_MODULE_PATHS[ngrxModule], version)) {
-                return {};
-            }
-            return config.create(context, optionsWithDefault);
-        },
+/**
+ * We need to patch the RuleCreator in order to preserve the defaultOptions
+ * to use as part of documentation generation.
+ */
+const patchedRuleCreator = (urlCreator) => {
+    return function createRule({ name, meta, defaultOptions, create }) {
+        return {
+            meta: Object.assign(Object.assign({}, meta), {
+                docs: Object.assign(Object.assign({}, meta.docs), {
+                    url: urlCreator(name),
+                }),
+            }),
+            defaultOptions,
+            create(context) {
+                const optionsWithDefault = utils_1.ESLintUtils.applyDefault(defaultOptions, context.options);
+                return create(context, optionsWithDefault);
+            },
+        };
     };
-    for (const [key, message] of Object.entries(configOverwrite.meta.messages)) {
-        configOverwrite.meta.messages[key] = `${message} (${(0, utils_2.docsUrl)(config.name)})`;
-    }
-    return utils_1.ESLintUtils.RuleCreator(utils_2.docsUrl)(configOverwrite);
-}
+};
+patchedRuleCreator.withoutDocs = utils_1.ESLintUtils.RuleCreator.withoutDocs;
+exports.createRule = patchedRuleCreator((ruleName) => `https://ngrx.io/guide/eslint-plugin/rules/${ruleName}`);
 //# sourceMappingURL=rule-creator.js.map

package/src/rule-creator.js.map

@@ -1 +1 @@
-{"version":3,"file":"rule-creator.js","sourceRoot":"","sources":["../../../../modules/eslint-plugin/src/rule-creator.ts"],"names":[],"mappings":";;AA2BA,gCAyCC;AAnED,oDAAuD;AAEvD,mCAA2E;AAwB3E,SAAgB,UAAU,CAIxB,MAQE;IAEF,MAAM,eAAe,GAAG;QACtB,GAAG,MAAM;QACT,MAAM,EAAE,CACN,OAA8D,EAC9D,kBAAsC,EACtC,EAAE;YACF,MAAM,EACJ,IAAI,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,GAC9B,GAAG,MAAM,CAAC;YACX,IACE,OAAO,KAAK,SAAS;gBACrB,CAAC,IAAA,4BAAoB,EAAC,yBAAiB,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,EAC7D,CAAC;gBACD,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;QACpD,CAAC;KACF,CAAC;IAEF,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1E,eAAe,CAAC,IAAI,CAAC,QAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,OAAO,KAAK,IAAA,eAAO,EAClE,MAAM,CAAC,IAAI,CACZ,GAAG,CAAC;IACP,CAAC;IAED,OAAO,mBAAW,CAAC,WAAW,CAAC,eAAO,CAAC,CAAC,eAAe,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["import type { TSESLint } from '@typescript-eslint/utils';\nimport { ESLintUtils } from '@typescript-eslint/utils';\nimport type { NGRX_MODULE } from './utils';\nimport { docsUrl, ngrxVersionSatisfies, NGRX_MODULE_PATHS } from './utils';\n\ntype Meta<TMessageIds extends string, TOptions extends readonly unknown[]> =\n  | TSESLint.RuleMetaData<TMessageIds, TOptions> & {\n      ngrxModule: NGRX_MODULE;\n      version?: string;\n      docs: { requiresTypeChecking?: boolean };\n    };\n\ntype CreateRuleMeta<\n  TMessageIds extends string,\n  TOptions extends readonly unknown[]\n> = {\n  docs: Omit<TSESLint.RuleMetaDataDocs, 'url'> & {\n    requiresTypeChecking?: boolean;\n  };\n} & Omit<Meta<TMessageIds, TOptions>, 'docs'>;\nexport type NgRxRuleModule<\n  TOptions extends readonly unknown[],\n  TMessageIds extends string\n> = Omit<TSESLint.RuleModule<TMessageIds, TOptions>, 'meta'> & {\n  meta: Meta<TMessageIds, TOptions>;\n};\n\nexport function createRule<\n  TOptions extends readonly unknown[],\n  TMessageIds extends string\n>(\n  config: Readonly<{\n    name: string;\n    meta: CreateRuleMeta<TMessageIds, TOptions>;\n    defaultOptions: Readonly<TOptions>;\n    create: (\n      context: Readonly<TSESLint.RuleContext<TMessageIds, TOptions>>,\n      optionsWithDefault: Readonly<TOptions>\n    ) => TSESLint.RuleListener;\n  }>\n): TSESLint.RuleModule<TMessageIds, TOptions> {\n  const configOverwrite = {\n    ...config,\n    create: (\n      context: Readonly<TSESLint.RuleContext<TMessageIds, TOptions>>,\n      optionsWithDefault: Readonly<TOptions>\n    ) => {\n      const {\n        meta: { ngrxModule, version },\n      } = config;\n      if (\n        version !== undefined &&\n        !ngrxVersionSatisfies(NGRX_MODULE_PATHS[ngrxModule], version)\n      ) {\n        return {};\n      }\n\n      return config.create(context, optionsWithDefault);\n    },\n  };\n\n  for (const [key, message] of Object.entries(configOverwrite.meta.messages)) {\n    (configOverwrite.meta.messages as any)[key] = `${message} (${docsUrl(\n      config.name\n    )})`;\n  }\n\n  return ESLintUtils.RuleCreator(docsUrl)(configOverwrite);\n}\n"]}
+{"version":3,"file":"rule-creator.js","sourceRoot":"","sources":["../../../../modules/eslint-plugin/src/rule-creator.ts"],"names":[],"mappings":";;;AAAA,oDAAuD;AAYvD;;;GAGG;AACH,MAAM,kBAAkB,GAAmC,CAAC,UAAU,EAAE,EAAE;IACxE,OAAO,SAAS,UAAU,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE;QAC/D,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE;gBAC3C,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE;oBAChD,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC;iBACtB,CAAC;aACH,CAAC;YACF,cAAc;YACd,MAAM,CAAC,OAAO;gBACZ,MAAM,kBAAkB,GAAG,mBAAW,CAAC,YAAY,CACjD,cAAc,EACd,OAAO,CAAC,OAAO,CAChB,CAAC;gBACF,OAAO,MAAM,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;YAC7C,CAAC;SACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AACF,kBAAkB,CAAC,WAAW,GAAG,mBAAW,CAAC,WAAW,CAAC,WAAW,CAAC;AAExD,QAAA,UAAU,GAAG,kBAAkB,CAC1C,CAAC,QAAQ,EAAE,EAAE,CAAC,6CAA6C,QAAQ,EAAE,CACtE,CAAC","sourcesContent":["import { ESLintUtils } from '@typescript-eslint/utils';\nimport { NGRX_MODULE } from './utils';\n\nexport interface NgRxRuleDocs {\n  ngrxModule: NGRX_MODULE;\n  requiresTypeChecking?: boolean;\n}\n\nexport type NgRxRule = ReturnType<\n  ReturnType<typeof ESLintUtils.RuleCreator<NgRxRuleDocs>>\n>;\n\n/**\n * We need to patch the RuleCreator in order to preserve the defaultOptions\n * to use as part of documentation generation.\n */\nconst patchedRuleCreator: typeof ESLintUtils.RuleCreator = (urlCreator) => {\n  return function createRule({ name, meta, defaultOptions, create }) {\n    return {\n      meta: Object.assign(Object.assign({}, meta), {\n        docs: Object.assign(Object.assign({}, meta.docs), {\n          url: urlCreator(name),\n        }),\n      }),\n      defaultOptions,\n      create(context) {\n        const optionsWithDefault = ESLintUtils.applyDefault(\n          defaultOptions,\n          context.options\n        );\n        return create(context, optionsWithDefault);\n      },\n    };\n  };\n};\npatchedRuleCreator.withoutDocs = ESLintUtils.RuleCreator.withoutDocs;\n\nexport const createRule = patchedRuleCreator<NgRxRuleDocs>(\n  (ruleName) => `https://ngrx.io/guide/eslint-plugin/rules/${ruleName}`\n);\n"]}

package/src/rules/component-store/avoid-combining-component-store-selectors.d.ts

@@ -1,3 +1,3 @@
 export declare const messageId = "avoidCombiningComponentStoreSelectors";
-declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidCombiningComponentStoreSelectors", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidCombiningComponentStoreSelectors", readonly [], import("../../rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
 export default _default;

package/src/rules/component-store/avoid-combining-component-store-selectors.js

@@ -42,9 +42,9 @@ exports.default = (0, rule_creator_1.createRule)({
     name: path.parse(__filename).name,
     meta: {
         type: 'suggestion',
-        ngrxModule: 'component-store',
         docs: {
             description: 'Prefer combining selectors at the selector level.',
+            ngrxModule: 'component-store',
         },
         schema: [],
         messages: {

package/src/rules/component-store/avoid-combining-component-store-selectors.js.map

@@ -1 +1 @@
-{"version":3,"file":"avoid-combining-component-store-selectors.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/component-store/avoid-combining-component-store-selectors.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAChD,uCAA0E;AAC7D,QAAA,SAAS,GAAG,uCAAuC,CAAC;AAIjE,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,UAAU,EAAE,iBAAiB;QAC7B,IAAI,EAAE;YACJ,WAAW,EAAE,mDAAmD;SACjE;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EAAE,0CAA0C;SACxD;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,UAAU,GAAG,IAAA,kCAA0B,EAAC,OAAO,CAAC,CAAC;QAEvD,MAAM,WAAW,GAAG,oFAAoF,CAAC;QACzG,MAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,IAAA,uBAAe,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAErE,MAAM,cAAc,GAA8B,EAAE,CAAC;QACrD,OAAO;YACL,CAAC,yFAAyF,WAAW,MAAM,WAAW,EAAE,CAAC,CACvH,IAA6B;gBAE7B,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;YACD,CAAC,+CAA+C,YAAY,MAAM,YAAY,EAAE,CAAC,CAC/E,IAA6B;gBAE7B,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;YACD,CAAC,kDAAkD,CAAC;gBAClD,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;oBAClC,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI;wBACJ,SAAS,EAAT,iBAAS;qBACV,CAAC,CAAC;gBACL,CAAC;gBACD,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;YAC5B,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport { getNgrxComponentStoreNames, namedExpression } from '../../utils';\nexport const messageId = 'avoidCombiningComponentStoreSelectors';\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'suggestion',\n    ngrxModule: 'component-store',\n    docs: {\n      description: 'Prefer combining selectors at the selector level.',\n    },\n    schema: [],\n    messages: {\n      [messageId]: 'Combine selectors at the selector level.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const storeNames = getNgrxComponentStoreNames(context);\n\n    const thisSelects = `CallExpression[callee.object.type='ThisExpression'][callee.property.name='select']`;\n    const storeSelects = storeNames ? namedExpression(storeNames) : null;\n\n    const selectsInArray: TSESTree.CallExpression[] = [];\n    return {\n      [`ClassDeclaration[superClass.name=/Store/] CallExpression[callee.name='combineLatest'] ${thisSelects} ~ ${thisSelects}`](\n        node: TSESTree.CallExpression\n      ) {\n        selectsInArray.push(node);\n      },\n      [`CallExpression[callee.name='combineLatest'] ${storeSelects} ~ ${storeSelects}`](\n        node: TSESTree.CallExpression\n      ) {\n        selectsInArray.push(node);\n      },\n      [`CallExpression[callee.name='combineLatest']:exit`]() {\n        for (const node of selectsInArray) {\n          context.report({\n            node,\n            messageId,\n          });\n        }\n        selectsInArray.length = 0;\n      },\n    };\n  },\n});\n"]}
+{"version":3,"file":"avoid-combining-component-store-selectors.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/component-store/avoid-combining-component-store-selectors.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAChD,uCAA0E;AAC7D,QAAA,SAAS,GAAG,uCAAuC,CAAC;AAIjE,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EAAE,mDAAmD;YAChE,UAAU,EAAE,iBAAiB;SAC9B;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EAAE,0CAA0C;SACxD;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,UAAU,GAAG,IAAA,kCAA0B,EAAC,OAAO,CAAC,CAAC;QAEvD,MAAM,WAAW,GAAG,oFAAoF,CAAC;QACzG,MAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,IAAA,uBAAe,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAErE,MAAM,cAAc,GAA8B,EAAE,CAAC;QACrD,OAAO;YACL,CAAC,yFAAyF,WAAW,MAAM,WAAW,EAAE,CAAC,CACvH,IAA6B;gBAE7B,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;YACD,CAAC,+CAA+C,YAAY,MAAM,YAAY,EAAE,CAAC,CAC/E,IAA6B;gBAE7B,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;YACD,CAAC,kDAAkD,CAAC;gBAClD,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;oBAClC,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI;wBACJ,SAAS,EAAT,iBAAS;qBACV,CAAC,CAAC;gBACL,CAAC;gBACD,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;YAC5B,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport { getNgrxComponentStoreNames, namedExpression } from '../../utils';\nexport const messageId = 'avoidCombiningComponentStoreSelectors';\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'suggestion',\n    docs: {\n      description: 'Prefer combining selectors at the selector level.',\n      ngrxModule: 'component-store',\n    },\n    schema: [],\n    messages: {\n      [messageId]: 'Combine selectors at the selector level.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const storeNames = getNgrxComponentStoreNames(context);\n\n    const thisSelects = `CallExpression[callee.object.type='ThisExpression'][callee.property.name='select']`;\n    const storeSelects = storeNames ? namedExpression(storeNames) : null;\n\n    const selectsInArray: TSESTree.CallExpression[] = [];\n    return {\n      [`ClassDeclaration[superClass.name=/Store/] CallExpression[callee.name='combineLatest'] ${thisSelects} ~ ${thisSelects}`](\n        node: TSESTree.CallExpression\n      ) {\n        selectsInArray.push(node);\n      },\n      [`CallExpression[callee.name='combineLatest'] ${storeSelects} ~ ${storeSelects}`](\n        node: TSESTree.CallExpression\n      ) {\n        selectsInArray.push(node);\n      },\n      [`CallExpression[callee.name='combineLatest']:exit`]() {\n        for (const node of selectsInArray) {\n          context.report({\n            node,\n            messageId,\n          });\n        }\n        selectsInArray.length = 0;\n      },\n    };\n  },\n});\n"]}

package/src/rules/component-store/avoid-mapping-component-store-selectors.d.ts

@@ -1,3 +1,3 @@
 export declare const messageId = "avoidMappingComponentStoreSelectors";
-declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidMappingComponentStoreSelectors", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"avoidMappingComponentStoreSelectors", readonly [], import("../../rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
 export default _default;

package/src/rules/component-store/avoid-mapping-component-store-selectors.js

@@ -42,9 +42,9 @@ exports.default = (0, rule_creator_1.createRule)({
     name: path.parse(__filename).name,
     meta: {
         type: 'problem',
-        ngrxModule: 'component-store',
         docs: {
             description: 'Avoid mapping logic outside the selector level.',
+            ngrxModule: 'component-store',
         },
         schema: [],
         messages: {

package/src/rules/component-store/avoid-mapping-component-store-selectors.js.map

@@ -1 +1 @@
-{"version":3,"file":"avoid-mapping-component-store-selectors.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/component-store/avoid-mapping-component-store-selectors.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAChD,uCAGqB;AAER,QAAA,SAAS,GAAG,qCAAqC,CAAC;AAK/D,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,iBAAiB;QAC7B,IAAI,EAAE;YACJ,WAAW,EAAE,iDAAiD;SAC/D;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EAAE,0CAA0C;SACxD;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,UAAU,GAAG,IAAA,kCAA0B,EAAC,OAAO,CAAC,CAAC;QAEvD,MAAM,mBAAmB,GAAG,+DAA+D,CAAC;QAC5F,MAAM,SAAS,GAAG;YAChB,mJAAmJ,mBAAmB,EAAE;YACxK,UAAU;gBACR,GAAG,IAAA,+BAAuB,EAAC,UAAU,CAAC,GAAG,mBAAmB,EAAE;SACjE;aACE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,GAAG,CAAC,CAAC;QAEb,OAAO;YACL,CAAC,SAAS,CAAC,CAAC,IAAsC;gBAChD,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,SAAS,EAAT,iBAAS;iBACV,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport {\n  getNgrxComponentStoreNames,\n  namedCallableExpression,\n} from '../../utils';\n\nexport const messageId = 'avoidMappingComponentStoreSelectors';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    ngrxModule: 'component-store',\n    docs: {\n      description: 'Avoid mapping logic outside the selector level.',\n    },\n    schema: [],\n    messages: {\n      [messageId]: 'Map logic at the selector level instead.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const storeNames = getNgrxComponentStoreNames(context);\n\n    const mapOperatorSelector = `[callee.property.name=pipe] > CallExpression[callee.name=map]`;\n    const selectors = [\n      `ClassDeclaration[superClass.name=/Store/] CallExpression:has(CallExpression[callee.object.type='ThisExpression'][callee.property.name='select'])${mapOperatorSelector}`,\n      storeNames &&\n        `${namedCallableExpression(storeNames)}${mapOperatorSelector}`,\n    ]\n      .filter(Boolean)\n      .join(',');\n\n    return {\n      [selectors](node: TSESTree.ArrowFunctionExpression) {\n        context.report({\n          node,\n          messageId,\n        });\n      },\n    };\n  },\n});\n"]}
+{"version":3,"file":"avoid-mapping-component-store-selectors.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/component-store/avoid-mapping-component-store-selectors.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAChD,uCAGqB;AAER,QAAA,SAAS,GAAG,qCAAqC,CAAC;AAK/D,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,iDAAiD;YAC9D,UAAU,EAAE,iBAAiB;SAC9B;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EAAE,0CAA0C;SACxD;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,UAAU,GAAG,IAAA,kCAA0B,EAAC,OAAO,CAAC,CAAC;QAEvD,MAAM,mBAAmB,GAAG,+DAA+D,CAAC;QAC5F,MAAM,SAAS,GAAG;YAChB,mJAAmJ,mBAAmB,EAAE;YACxK,UAAU;gBACR,GAAG,IAAA,+BAAuB,EAAC,UAAU,CAAC,GAAG,mBAAmB,EAAE;SACjE;aACE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,GAAG,CAAC,CAAC;QAEb,OAAO;YACL,CAAC,SAAS,CAAC,CAAC,IAAsC;gBAChD,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,SAAS,EAAT,iBAAS;iBACV,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport {\n  getNgrxComponentStoreNames,\n  namedCallableExpression,\n} from '../../utils';\n\nexport const messageId = 'avoidMappingComponentStoreSelectors';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    docs: {\n      description: 'Avoid mapping logic outside the selector level.',\n      ngrxModule: 'component-store',\n    },\n    schema: [],\n    messages: {\n      [messageId]: 'Map logic at the selector level instead.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const storeNames = getNgrxComponentStoreNames(context);\n\n    const mapOperatorSelector = `[callee.property.name=pipe] > CallExpression[callee.name=map]`;\n    const selectors = [\n      `ClassDeclaration[superClass.name=/Store/] CallExpression:has(CallExpression[callee.object.type='ThisExpression'][callee.property.name='select'])${mapOperatorSelector}`,\n      storeNames &&\n        `${namedCallableExpression(storeNames)}${mapOperatorSelector}`,\n    ]\n      .filter(Boolean)\n      .join(',');\n\n    return {\n      [selectors](node: TSESTree.ArrowFunctionExpression) {\n        context.report({\n          node,\n          messageId,\n        });\n      },\n    };\n  },\n});\n"]}

package/src/rules/component-store/require-super-ondestroy.d.ts

@@ -1,3 +1,3 @@
 export declare const messageId = "requireSuperOnDestroy";
-declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"requireSuperOnDestroy", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"requireSuperOnDestroy", readonly [], import("../../rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
 export default _default;

package/src/rules/component-store/require-super-ondestroy.js

@@ -41,9 +41,9 @@ exports.default = (0, rule_creator_1.createRule)({
     name: path.parse(__filename).name,
     meta: {
         type: 'problem',
-        ngrxModule: 'component-store',
         docs: {
             description: 'Overriden ngOnDestroy method in component stores require a call to super.ngOnDestroy().',
+            ngrxModule: 'component-store',
         },
         schema: [],
         messages: {

package/src/rules/component-store/require-super-ondestroy.js.map

@@ -1 +1 @@
-{"version":3,"file":"require-super-ondestroy.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/component-store/require-super-ondestroy.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA6B;AAC7B,qDAAgD;AAGnC,QAAA,SAAS,GAAG,uBAAuB,CAAC;AAIjD,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,iBAAiB;QAC7B,IAAI,EAAE;YACJ,WAAW,EACT,yFAAyF;SAC5F;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EACT,yEAAyE;SAC5E;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,yBAAyB,GAAG,0CAA0C,CAAC;QAC7E,MAAM,uBAAuB,GAAG,gBAAgB,CAAC;QAEjD,IAAI,2BAA2B,GAAG,KAAK,CAAC;QAExC,OAAO;YACL,CAAC,0FAA0F,uBAAuB,IAAI,CAAC,CACrH,CAA2B;gBAE3B,2BAA2B,GAAG,IAAI,CAAC;YACrC,CAAC;YACD,CAAC,oCAAoC,uBAAuB,KAAK,yBAAyB,mGAAmG,CAAC,CAC5L,IAAyB;gBAEzB,IAAI,CAAC,2BAA2B,EAAE,CAAC;oBACjC,OAAO;gBACT,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,SAAS,EAAT,iBAAS;iBACV,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport { TSESTree } from '@typescript-eslint/types';\n\nexport const messageId = 'requireSuperOnDestroy';\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    ngrxModule: 'component-store',\n    docs: {\n      description:\n        'Overriden ngOnDestroy method in component stores require a call to super.ngOnDestroy().',\n    },\n    schema: [],\n    messages: {\n      [messageId]:\n        \"Call super.ngOnDestroy() inside a component store's ngOnDestroy method.\",\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const ngOnDestroyMethodSelector = `MethodDefinition[key.name='ngOnDestroy']`;\n    const componentStoreClassName = 'ComponentStore';\n\n    let hasNgrxComponentStoreImport = false;\n\n    return {\n      [`ImportDeclaration[source.value='@ngrx/component-store'] ImportSpecifier[imported.name='${componentStoreClassName}']`](\n        _: TSESTree.ImportSpecifier\n      ) {\n        hasNgrxComponentStoreImport = true;\n      },\n      [`ClassDeclaration[superClass.name=${componentStoreClassName}] ${ngOnDestroyMethodSelector}:not(:has(CallExpression[callee.object.type='Super'][callee.property.name='ngOnDestroy'])) > .key`](\n        node: TSESTree.Identifier\n      ) {\n        if (!hasNgrxComponentStoreImport) {\n          return;\n        }\n\n        context.report({\n          node,\n          messageId,\n        });\n      },\n    };\n  },\n});\n"]}
+{"version":3,"file":"require-super-ondestroy.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/component-store/require-super-ondestroy.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA6B;AAC7B,qDAAgD;AAGnC,QAAA,SAAS,GAAG,uBAAuB,CAAC;AAIjD,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,yFAAyF;YAC3F,UAAU,EAAE,iBAAiB;SAC9B;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EACT,yEAAyE;SAC5E;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,yBAAyB,GAAG,0CAA0C,CAAC;QAC7E,MAAM,uBAAuB,GAAG,gBAAgB,CAAC;QAEjD,IAAI,2BAA2B,GAAG,KAAK,CAAC;QAExC,OAAO;YACL,CAAC,0FAA0F,uBAAuB,IAAI,CAAC,CACrH,CAA2B;gBAE3B,2BAA2B,GAAG,IAAI,CAAC;YACrC,CAAC;YACD,CAAC,oCAAoC,uBAAuB,KAAK,yBAAyB,mGAAmG,CAAC,CAC5L,IAAyB;gBAEzB,IAAI,CAAC,2BAA2B,EAAE,CAAC;oBACjC,OAAO;gBACT,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,SAAS,EAAT,iBAAS;iBACV,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport { TSESTree } from '@typescript-eslint/types';\n\nexport const messageId = 'requireSuperOnDestroy';\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    docs: {\n      description:\n        'Overriden ngOnDestroy method in component stores require a call to super.ngOnDestroy().',\n      ngrxModule: 'component-store',\n    },\n    schema: [],\n    messages: {\n      [messageId]:\n        \"Call super.ngOnDestroy() inside a component store's ngOnDestroy method.\",\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const ngOnDestroyMethodSelector = `MethodDefinition[key.name='ngOnDestroy']`;\n    const componentStoreClassName = 'ComponentStore';\n\n    let hasNgrxComponentStoreImport = false;\n\n    return {\n      [`ImportDeclaration[source.value='@ngrx/component-store'] ImportSpecifier[imported.name='${componentStoreClassName}']`](\n        _: TSESTree.ImportSpecifier\n      ) {\n        hasNgrxComponentStoreImport = true;\n      },\n      [`ClassDeclaration[superClass.name=${componentStoreClassName}] ${ngOnDestroyMethodSelector}:not(:has(CallExpression[callee.object.type='Super'][callee.property.name='ngOnDestroy'])) > .key`](\n        node: TSESTree.Identifier\n      ) {\n        if (!hasNgrxComponentStoreImport) {\n          return;\n        }\n\n        context.report({\n          node,\n          messageId,\n        });\n      },\n    };\n  },\n});\n"]}

package/src/rules/component-store/updater-explicit-return-type.d.ts

@@ -1,3 +1,3 @@
 export declare const messageId = "updaterExplicitReturnType";
-declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"updaterExplicitReturnType", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"updaterExplicitReturnType", readonly [], import("../../rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
 export default _default;

package/src/rules/component-store/updater-explicit-return-type.js

@@ -42,9 +42,9 @@ exports.default = (0, rule_creator_1.createRule)({
     name: path.parse(__filename).name,
     meta: {
         type: 'problem',
-        ngrxModule: 'component-store',
         docs: {
             description: '`Updater` should have an explicit return type.',
+            ngrxModule: 'component-store',
         },
         schema: [],
         messages: {

package/src/rules/component-store/updater-explicit-return-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"updater-explicit-return-type.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/component-store/updater-explicit-return-type.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAChD,uCAA0E;AAE7D,QAAA,SAAS,GAAG,2BAA2B,CAAC;AAKrD,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,iBAAiB;QAC7B,IAAI,EAAE;YACJ,WAAW,EAAE,gDAAgD;SAC9D;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EACT,6HAA6H;SAChI;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,UAAU,GAAG,IAAA,kCAA0B,EAAC,OAAO,CAAC,CAAC;QACvD,MAAM,qBAAqB,GAAG,0DAA0D,CAAC;QACzF,MAAM,SAAS,GAAG;YAChB,mIAAmI,qBAAqB,EAAE;YAC1J,UAAU;gBACR,GAAG,IAAA,uBAAe,EAChB,UAAU,CACX,sCAAsC,qBAAqB,EAAE;SACjE;aACE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,GAAG,CAAC,CAAC;QAEb,OAAO;YACL,CAAC,SAAS,CAAC,CAAC,IAAsC;gBAChD,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,SAAS,EAAT,iBAAS;iBACV,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport { getNgrxComponentStoreNames, namedExpression } from '../../utils';\n\nexport const messageId = 'updaterExplicitReturnType';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    ngrxModule: 'component-store',\n    docs: {\n      description: '`Updater` should have an explicit return type.',\n    },\n    schema: [],\n    messages: {\n      [messageId]:\n        '`Updater` should have an explicit return type when using arrow functions: `this.store.updater((state, value): State => {}`.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const storeNames = getNgrxComponentStoreNames(context);\n    const withoutTypeAnnotation = `ArrowFunctionExpression:not([returnType.typeAnnotation])`;\n    const selectors = [\n      `ClassDeclaration[superClass.name=/Store/] CallExpression[callee.object.type='ThisExpression'][callee.property.name='updater'] > ${withoutTypeAnnotation}`,\n      storeNames &&\n        `${namedExpression(\n          storeNames\n        )}[callee.property.name='updater'] > ${withoutTypeAnnotation}`,\n    ]\n      .filter(Boolean)\n      .join(',');\n\n    return {\n      [selectors](node: TSESTree.ArrowFunctionExpression) {\n        context.report({\n          node,\n          messageId,\n        });\n      },\n    };\n  },\n});\n"]}
+{"version":3,"file":"updater-explicit-return-type.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/component-store/updater-explicit-return-type.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAChD,uCAA0E;AAE7D,QAAA,SAAS,GAAG,2BAA2B,CAAC;AAKrD,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,gDAAgD;YAC7D,UAAU,EAAE,iBAAiB;SAC9B;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EACT,6HAA6H;SAChI;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,UAAU,GAAG,IAAA,kCAA0B,EAAC,OAAO,CAAC,CAAC;QACvD,MAAM,qBAAqB,GAAG,0DAA0D,CAAC;QACzF,MAAM,SAAS,GAAG;YAChB,mIAAmI,qBAAqB,EAAE;YAC1J,UAAU;gBACR,GAAG,IAAA,uBAAe,EAChB,UAAU,CACX,sCAAsC,qBAAqB,EAAE;SACjE;aACE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,GAAG,CAAC,CAAC;QAEb,OAAO;YACL,CAAC,SAAS,CAAC,CAAC,IAAsC;gBAChD,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,SAAS,EAAT,iBAAS;iBACV,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport { getNgrxComponentStoreNames, namedExpression } from '../../utils';\n\nexport const messageId = 'updaterExplicitReturnType';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    docs: {\n      description: '`Updater` should have an explicit return type.',\n      ngrxModule: 'component-store',\n    },\n    schema: [],\n    messages: {\n      [messageId]:\n        '`Updater` should have an explicit return type when using arrow functions: `this.store.updater((state, value): State => {}`.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const storeNames = getNgrxComponentStoreNames(context);\n    const withoutTypeAnnotation = `ArrowFunctionExpression:not([returnType.typeAnnotation])`;\n    const selectors = [\n      `ClassDeclaration[superClass.name=/Store/] CallExpression[callee.object.type='ThisExpression'][callee.property.name='updater'] > ${withoutTypeAnnotation}`,\n      storeNames &&\n        `${namedExpression(\n          storeNames\n        )}[callee.property.name='updater'] > ${withoutTypeAnnotation}`,\n    ]\n      .filter(Boolean)\n      .join(',');\n\n    return {\n      [selectors](node: TSESTree.ArrowFunctionExpression) {\n        context.report({\n          node,\n          messageId,\n        });\n      },\n    };\n  },\n});\n"]}

package/src/rules/effects/avoid-cyclic-effects.d.ts

@@ -1,4 +1,4 @@
 import { ESLintUtils } from '@typescript-eslint/utils';
 export declare const messageId = "avoidCyclicEffects";
-declare const _default: ESLintUtils.RuleModule<"avoidCyclicEffects", readonly [], unknown, ESLintUtils.RuleListener>;
+declare const _default: ESLintUtils.RuleModule<"avoidCyclicEffects", readonly [], import("../../rule-creator").NgRxRuleDocs, ESLintUtils.RuleListener>;
 export default _default;

package/src/rules/effects/avoid-cyclic-effects.js

@@ -47,9 +47,9 @@ exports.default = (0, rule_creator_1.createRule)({
     name: path.parse(__filename).name,
     meta: {
         type: 'problem',
-        ngrxModule: 'effects',
         docs: {
             description: 'Avoid `Effect` that re-emit filtered actions.',
+            ngrxModule: 'effects',
             requiresTypeChecking: true,
         },
         schema: [],

package/src/rules/effects/avoid-cyclic-effects.js.map

@@ -1 +1 @@
-{"version":3,"file":"avoid-cyclic-effects.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/effects/avoid-cyclic-effects.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAsE;AACtE,2CAA6B;AAC7B,+CAAiC;AACjC,qDAAgD;AAChD,uCAOqB;AAER,QAAA,SAAS,GAAG,oBAAoB,CAAC;AAK9C,mGAAmG;AACnG,uIAAuI;AACvI,0CAA0C;AAE1C,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,SAAS;QACrB,IAAI,EAAE;YACJ,WAAW,EAAE,+CAA+C;YAC5D,oBAAoB,EAAE,IAAI;SAC3B;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EAAE,uDAAuD;SACrE;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,EAAE,WAAW,GAAG,EAAE,EAAE,GAAG,IAAA,4BAAoB,EAAC,OAAO,CAAC,CAAC;QAC3D,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,iBAAS,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAE5E,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,QAAQ,GAAG,mBAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QAEtD,SAAS,SAAS,CAAC,kBAA2C;YAC5D,MAAM,sBAAsB,GAAG,kBAAkB,CAAC,SAAS,CAAC,IAAI,CAC9D,CAAC,GAAG,EAAE,EAAE,CACN,IAAA,wBAAgB,EAAC,GAAG,CAAC;gBACrB,IAAA,oBAAY,EAAC,GAAG,CAAC,MAAM,CAAC;gBACxB,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAC/B,CAAC;YACF,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAC5B,OAAO;YACT,CAAC;YACD,MAAM,YAAY,GAAG,QAAQ,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;YACxE,MAAM,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,mBAAmB,CACjD,YAAY,EACZ,EAAE,CAAC,aAAa,CAAC,IAAI,CACtB,CAAC;YAEF,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO;YACT,CAAC;YACD,MAAM,kBAAkB,GACtB,WAAW,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;YAClD,IAAI,CAAC,IAAA,uBAAe,EAAC,kBAAkB,CAAC,EAAE,CAAC;gBACzC,OAAO;YACT,CAAC;YACD,MAAM,CAAC,mBAAmB,CAAC,GACzB,WAAW,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;YACnD,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;YAChE,IAAI,CAAC,IAAA,uBAAe,EAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/B,OAAO;YACT,CAAC;YACD,MAAM,CAAC,eAAe,CAAC,GAAG,WAAW,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACjE,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,OAAO;YACT,CAAC;YAED,MAAM,mBAAmB,GAAG,cAAc,CAAC,mBAAmB,CAAC,CAAC;YAChE,MAAM,eAAe,GAAG,cAAc,CAAC,eAAe,CAAC,CAAC;YAExD,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE,CAAC;gBAC7C,IAAI,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;oBACzC,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,kBAAkB,CAAC,MAAM;wBAC/B,SAAS,EAAT,iBAAS;qBACV,CAAC,CAAC;oBACH,OAAO;gBACT,CAAC;YACH,CAAC;QACH,CAAC;QAED,SAAS,aAAa,CAAC,MAAiB;YACtC,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;YAEpC,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,OAAO,IAAI,CAAC;YACd,CAAC;YAED,IAAI,gBAAgB,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC;gBAChE,MAAM,EAAE,MAAM,EAAE,GAAG,MAA+C,CAAC;gBACnE,OAAO,MAAM,CAAC,gBAAgB;oBAC5B,CAAC,CAAC,WAAW,CAAC,yBAAyB,CACnC,MAAM,EACN,MAAM,CAAC,gBAAgB,CACxB;oBACH,CAAC,CAAC,IAAI,CAAC;YACX,CAAC;YAED,OAAO,WAAW,CAAC,yBAAyB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACzE,CAAC;QAED,SAAS,cAAc,CAAC,IAAa;YACnC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;gBACnB,MAAM,iBAAiB,GAAa,EAAE,CAAC;gBACvC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACpC,iBAAiB,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;gBACxD,CAAC;gBACD,OAAO,iBAAiB,CAAC;YAC3B,CAAC;YAED,MAAM,MAAM,GAAG,WAAW,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAE3D,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YAEzC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,gCAAgC;YAChC,iFAAiF;YACjF,IAAI,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACtD,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,SAAS,GAAG,IAAI,CAAC;QACrB,OAAO;YACL,CAAC,GAAG,8BAAsB,qJAAqJ,YAAY,GAAG,CAAC,CAC7L,IAAI;gBAEJ,IAAI,SAAS,EAAE,CAAC;oBACd,SAAS,CAAC,IAAI,CAAC,CAAC;oBAChB,SAAS,GAAG,KAAK,CAAC;oBAClB,OAAO;gBACT,CAAC;YACH,CAAC;YAED,CAAC,GAAG,8BAAsB,4HAA4H,CAAC;gBACrJ,SAAS,GAAG,IAAI,CAAC;YACnB,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import { ESLintUtils, type TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport * as ts from 'typescript';\nimport { createRule } from '../../rule-creator';\nimport {\n  asPattern,\n  createEffectExpression,\n  getNgRxEffectActions,\n  isCallExpression,\n  isIdentifier,\n  isTypeReference,\n} from '../../utils';\n\nexport const messageId = 'avoidCyclicEffects';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\n// This rule is a modified version (to support dispatch: false) from the eslint-plugin-rxjs plugin.\n// The original implementation can be found at https://github.com/cartant/eslint-plugin-rxjs/blob/main/source/rules/no-cyclic-action.ts\n// Thank you Nicholas Jamieson (@cartant).\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    ngrxModule: 'effects',\n    docs: {\n      description: 'Avoid `Effect` that re-emit filtered actions.',\n      requiresTypeChecking: true,\n    },\n    schema: [],\n    messages: {\n      [messageId]: '`Effect` that re-emit filtered actions are forbidden.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const { identifiers = [] } = getNgRxEffectActions(context);\n    const actionsNames = identifiers.length > 0 ? asPattern(identifiers) : null;\n\n    if (!actionsNames) {\n      return {};\n    }\n\n    const services = ESLintUtils.getParserServices(context);\n    const typeChecker = services.program.getTypeChecker();\n\n    function checkNode(pipeCallExpression: TSESTree.CallExpression) {\n      const operatorCallExpression = pipeCallExpression.arguments.find(\n        (arg) =>\n          isCallExpression(arg) &&\n          isIdentifier(arg.callee) &&\n          arg.callee.name === 'ofType'\n      );\n      if (!operatorCallExpression) {\n        return;\n      }\n      const operatorType = services.getTypeAtLocation(operatorCallExpression);\n      const [signature] = typeChecker.getSignaturesOfType(\n        operatorType,\n        ts.SignatureKind.Call\n      );\n\n      if (!signature) {\n        return;\n      }\n      const operatorReturnType =\n        typeChecker.getReturnTypeOfSignature(signature);\n      if (!isTypeReference(operatorReturnType)) {\n        return;\n      }\n      const [operatorElementType] =\n        typeChecker.getTypeArguments(operatorReturnType);\n      if (!operatorElementType) {\n        return;\n      }\n\n      const pipeType = services.getTypeAtLocation(pipeCallExpression);\n      if (!isTypeReference(pipeType)) {\n        return;\n      }\n      const [pipeElementType] = typeChecker.getTypeArguments(pipeType);\n      if (!pipeElementType) {\n        return;\n      }\n\n      const operatorActionTypes = getActionTypes(operatorElementType);\n      const pipeActionTypes = getActionTypes(pipeElementType);\n\n      for (const actionType of operatorActionTypes) {\n        if (pipeActionTypes.includes(actionType)) {\n          context.report({\n            node: pipeCallExpression.callee,\n            messageId,\n          });\n          return;\n        }\n      }\n    }\n\n    function getActionType(symbol: ts.Symbol): ts.Type | null {\n      const { valueDeclaration } = symbol;\n\n      if (!valueDeclaration) {\n        return null;\n      }\n\n      if (valueDeclaration.kind === ts.SyntaxKind.PropertyDeclaration) {\n        const { parent } = symbol as typeof symbol & { parent: ts.Symbol };\n        return parent.valueDeclaration\n          ? typeChecker.getTypeOfSymbolAtLocation(\n              parent,\n              parent.valueDeclaration\n            )\n          : null;\n      }\n\n      return typeChecker.getTypeOfSymbolAtLocation(symbol, valueDeclaration);\n    }\n\n    function getActionTypes(type: ts.Type): string[] {\n      if (type.isUnion()) {\n        const memberActionTypes: string[] = [];\n        for (const memberType of type.types) {\n          memberActionTypes.push(...getActionTypes(memberType));\n        }\n        return memberActionTypes;\n      }\n\n      const symbol = typeChecker.getPropertyOfType(type, 'type');\n\n      if (!symbol) {\n        return [];\n      }\n\n      const actionType = getActionType(symbol);\n\n      if (!actionType) {\n        return [];\n      }\n\n      // TODO: support \"dynamic\" types\n      // e.g. const genericFoo = createAction(`${subject} FOO`); (resolves to 'string')\n      if (typeChecker.typeToString(actionType) === 'string') {\n        return [];\n      }\n      return [typeChecker.typeToString(actionType)];\n    }\n\n    let firstPipe = true;\n    return {\n      [`${createEffectExpression}:not([arguments.1]:has(Property[key.name='dispatch'][value.value=false])) CallExpression[callee.property.name='pipe'][callee.object.property.name=${actionsNames}]`](\n        node\n      ) {\n        if (firstPipe) {\n          checkNode(node);\n          firstPipe = false;\n          return;\n        }\n      },\n\n      [`${createEffectExpression}:not([arguments.1]:has(Property[key.name='dispatch'][value.value=false])) CallExpression[callee.property.name='pipe']:exit`]() {\n        firstPipe = true;\n      },\n    };\n  },\n});\n"]}
+{"version":3,"file":"avoid-cyclic-effects.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/effects/avoid-cyclic-effects.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAsE;AACtE,2CAA6B;AAC7B,+CAAiC;AACjC,qDAAgD;AAChD,uCAOqB;AAER,QAAA,SAAS,GAAG,oBAAoB,CAAC;AAK9C,mGAAmG;AACnG,uIAAuI;AACvI,0CAA0C;AAE1C,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,+CAA+C;YAC5D,UAAU,EAAE,SAAS;YACrB,oBAAoB,EAAE,IAAI;SAC3B;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EAAE,uDAAuD;SACrE;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,EAAE,WAAW,GAAG,EAAE,EAAE,GAAG,IAAA,4BAAoB,EAAC,OAAO,CAAC,CAAC;QAC3D,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,iBAAS,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAE5E,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,QAAQ,GAAG,mBAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QAEtD,SAAS,SAAS,CAAC,kBAA2C;YAC5D,MAAM,sBAAsB,GAAG,kBAAkB,CAAC,SAAS,CAAC,IAAI,CAC9D,CAAC,GAAG,EAAE,EAAE,CACN,IAAA,wBAAgB,EAAC,GAAG,CAAC;gBACrB,IAAA,oBAAY,EAAC,GAAG,CAAC,MAAM,CAAC;gBACxB,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAC/B,CAAC;YACF,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAC5B,OAAO;YACT,CAAC;YACD,MAAM,YAAY,GAAG,QAAQ,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;YACxE,MAAM,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,mBAAmB,CACjD,YAAY,EACZ,EAAE,CAAC,aAAa,CAAC,IAAI,CACtB,CAAC;YAEF,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO;YACT,CAAC;YACD,MAAM,kBAAkB,GACtB,WAAW,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;YAClD,IAAI,CAAC,IAAA,uBAAe,EAAC,kBAAkB,CAAC,EAAE,CAAC;gBACzC,OAAO;YACT,CAAC;YACD,MAAM,CAAC,mBAAmB,CAAC,GACzB,WAAW,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;YACnD,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;YAChE,IAAI,CAAC,IAAA,uBAAe,EAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/B,OAAO;YACT,CAAC;YACD,MAAM,CAAC,eAAe,CAAC,GAAG,WAAW,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACjE,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,OAAO;YACT,CAAC;YAED,MAAM,mBAAmB,GAAG,cAAc,CAAC,mBAAmB,CAAC,CAAC;YAChE,MAAM,eAAe,GAAG,cAAc,CAAC,eAAe,CAAC,CAAC;YAExD,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE,CAAC;gBAC7C,IAAI,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;oBACzC,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,kBAAkB,CAAC,MAAM;wBAC/B,SAAS,EAAT,iBAAS;qBACV,CAAC,CAAC;oBACH,OAAO;gBACT,CAAC;YACH,CAAC;QACH,CAAC;QAED,SAAS,aAAa,CAAC,MAAiB;YACtC,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;YAEpC,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,OAAO,IAAI,CAAC;YACd,CAAC;YAED,IAAI,gBAAgB,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC;gBAChE,MAAM,EAAE,MAAM,EAAE,GAAG,MAA+C,CAAC;gBACnE,OAAO,MAAM,CAAC,gBAAgB;oBAC5B,CAAC,CAAC,WAAW,CAAC,yBAAyB,CACnC,MAAM,EACN,MAAM,CAAC,gBAAgB,CACxB;oBACH,CAAC,CAAC,IAAI,CAAC;YACX,CAAC;YAED,OAAO,WAAW,CAAC,yBAAyB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACzE,CAAC;QAED,SAAS,cAAc,CAAC,IAAa;YACnC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;gBACnB,MAAM,iBAAiB,GAAa,EAAE,CAAC;gBACvC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACpC,iBAAiB,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;gBACxD,CAAC;gBACD,OAAO,iBAAiB,CAAC;YAC3B,CAAC;YAED,MAAM,MAAM,GAAG,WAAW,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAE3D,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YAEzC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,gCAAgC;YAChC,iFAAiF;YACjF,IAAI,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACtD,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,SAAS,GAAG,IAAI,CAAC;QACrB,OAAO;YACL,CAAC,GAAG,8BAAsB,qJAAqJ,YAAY,GAAG,CAAC,CAC7L,IAAI;gBAEJ,IAAI,SAAS,EAAE,CAAC;oBACd,SAAS,CAAC,IAAI,CAAC,CAAC;oBAChB,SAAS,GAAG,KAAK,CAAC;oBAClB,OAAO;gBACT,CAAC;YACH,CAAC;YAED,CAAC,GAAG,8BAAsB,4HAA4H,CAAC;gBACrJ,SAAS,GAAG,IAAI,CAAC;YACnB,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import { ESLintUtils, type TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport * as ts from 'typescript';\nimport { createRule } from '../../rule-creator';\nimport {\n  asPattern,\n  createEffectExpression,\n  getNgRxEffectActions,\n  isCallExpression,\n  isIdentifier,\n  isTypeReference,\n} from '../../utils';\n\nexport const messageId = 'avoidCyclicEffects';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\n// This rule is a modified version (to support dispatch: false) from the eslint-plugin-rxjs plugin.\n// The original implementation can be found at https://github.com/cartant/eslint-plugin-rxjs/blob/main/source/rules/no-cyclic-action.ts\n// Thank you Nicholas Jamieson (@cartant).\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    docs: {\n      description: 'Avoid `Effect` that re-emit filtered actions.',\n      ngrxModule: 'effects',\n      requiresTypeChecking: true,\n    },\n    schema: [],\n    messages: {\n      [messageId]: '`Effect` that re-emit filtered actions are forbidden.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const { identifiers = [] } = getNgRxEffectActions(context);\n    const actionsNames = identifiers.length > 0 ? asPattern(identifiers) : null;\n\n    if (!actionsNames) {\n      return {};\n    }\n\n    const services = ESLintUtils.getParserServices(context);\n    const typeChecker = services.program.getTypeChecker();\n\n    function checkNode(pipeCallExpression: TSESTree.CallExpression) {\n      const operatorCallExpression = pipeCallExpression.arguments.find(\n        (arg) =>\n          isCallExpression(arg) &&\n          isIdentifier(arg.callee) &&\n          arg.callee.name === 'ofType'\n      );\n      if (!operatorCallExpression) {\n        return;\n      }\n      const operatorType = services.getTypeAtLocation(operatorCallExpression);\n      const [signature] = typeChecker.getSignaturesOfType(\n        operatorType,\n        ts.SignatureKind.Call\n      );\n\n      if (!signature) {\n        return;\n      }\n      const operatorReturnType =\n        typeChecker.getReturnTypeOfSignature(signature);\n      if (!isTypeReference(operatorReturnType)) {\n        return;\n      }\n      const [operatorElementType] =\n        typeChecker.getTypeArguments(operatorReturnType);\n      if (!operatorElementType) {\n        return;\n      }\n\n      const pipeType = services.getTypeAtLocation(pipeCallExpression);\n      if (!isTypeReference(pipeType)) {\n        return;\n      }\n      const [pipeElementType] = typeChecker.getTypeArguments(pipeType);\n      if (!pipeElementType) {\n        return;\n      }\n\n      const operatorActionTypes = getActionTypes(operatorElementType);\n      const pipeActionTypes = getActionTypes(pipeElementType);\n\n      for (const actionType of operatorActionTypes) {\n        if (pipeActionTypes.includes(actionType)) {\n          context.report({\n            node: pipeCallExpression.callee,\n            messageId,\n          });\n          return;\n        }\n      }\n    }\n\n    function getActionType(symbol: ts.Symbol): ts.Type | null {\n      const { valueDeclaration } = symbol;\n\n      if (!valueDeclaration) {\n        return null;\n      }\n\n      if (valueDeclaration.kind === ts.SyntaxKind.PropertyDeclaration) {\n        const { parent } = symbol as typeof symbol & { parent: ts.Symbol };\n        return parent.valueDeclaration\n          ? typeChecker.getTypeOfSymbolAtLocation(\n              parent,\n              parent.valueDeclaration\n            )\n          : null;\n      }\n\n      return typeChecker.getTypeOfSymbolAtLocation(symbol, valueDeclaration);\n    }\n\n    function getActionTypes(type: ts.Type): string[] {\n      if (type.isUnion()) {\n        const memberActionTypes: string[] = [];\n        for (const memberType of type.types) {\n          memberActionTypes.push(...getActionTypes(memberType));\n        }\n        return memberActionTypes;\n      }\n\n      const symbol = typeChecker.getPropertyOfType(type, 'type');\n\n      if (!symbol) {\n        return [];\n      }\n\n      const actionType = getActionType(symbol);\n\n      if (!actionType) {\n        return [];\n      }\n\n      // TODO: support \"dynamic\" types\n      // e.g. const genericFoo = createAction(`${subject} FOO`); (resolves to 'string')\n      if (typeChecker.typeToString(actionType) === 'string') {\n        return [];\n      }\n      return [typeChecker.typeToString(actionType)];\n    }\n\n    let firstPipe = true;\n    return {\n      [`${createEffectExpression}:not([arguments.1]:has(Property[key.name='dispatch'][value.value=false])) CallExpression[callee.property.name='pipe'][callee.object.property.name=${actionsNames}]`](\n        node\n      ) {\n        if (firstPipe) {\n          checkNode(node);\n          firstPipe = false;\n          return;\n        }\n      },\n\n      [`${createEffectExpression}:not([arguments.1]:has(Property[key.name='dispatch'][value.value=false])) CallExpression[callee.property.name='pipe']:exit`]() {\n        firstPipe = true;\n      },\n    };\n  },\n});\n"]}

package/src/rules/effects/no-dispatch-in-effects.d.ts

@@ -1,5 +1,5 @@
 export declare const noDispatchInEffects = "noDispatchInEffects";
 export declare const noDispatchInEffectsSuggest = "noDispatchInEffectsSuggest";
 type MessageIds = typeof noDispatchInEffects | typeof noDispatchInEffectsSuggest;
-declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<MessageIds, readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<MessageIds, readonly [], import("../../rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
 export default _default;

package/src/rules/effects/no-dispatch-in-effects.js

@@ -43,10 +43,10 @@ exports.default = (0, rule_creator_1.createRule)({
     name: path.parse(__filename).name,
     meta: {
         type: 'suggestion',
-        ngrxModule: 'effects',
         hasSuggestions: true,
         docs: {
             description: '`Effect` should not call `store.dispatch`.',
+            ngrxModule: 'effects',
         },
         schema: [],
         messages: {

package/src/rules/effects/no-dispatch-in-effects.js.map

@@ -1 +1 @@
-{"version":3,"file":"no-dispatch-in-effects.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/effects/no-dispatch-in-effects.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAChD,uCAMqB;AAER,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;AAC5C,QAAA,0BAA0B,GAAG,4BAA4B,CAAC;AAUvE,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,UAAU,EAAE,SAAS;QACrB,cAAc,EAAE,IAAI;QACpB,IAAI,EAAE;YACJ,WAAW,EAAE,4CAA4C;SAC1D;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,2BAAmB,CAAC,EACnB,oDAAoD;YACtD,CAAC,kCAA0B,CAAC,EAAE,0BAA0B;SACzD;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,EAAE,WAAW,GAAG,EAAE,EAAE,GAAG,IAAA,qBAAa,EAAC,OAAO,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,iBAAS,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAE1E,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO;YACL,CAAC,IAAA,yBAAiB,EAAC,UAAU,CAAC,CAAC,CAC7B,IAA0C;gBAE1C,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;gBAC3C,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI,EAAE,YAAY;oBAClB,SAAS,EAAE,2BAAmB;oBAC9B,OAAO,EAAE;wBACP;4BACE,SAAS,EAAE,kCAA0B;4BACrC,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC;yBAC3C;qBACF;iBACF,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,eAAe,CAAC,IAA0C;IACjE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IACvC,OAAO,WAAW;QAChB,CAAC,IAAA,iCAAyB,EAAC,WAAW,CAAC,IAAI,IAAA,yBAAiB,EAAC,WAAW,CAAC,CAAC;QAC1E,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,MAAM,CAAC;AACb,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport {\n  asPattern,\n  dispatchInEffects,\n  getNgRxStores,\n  isArrowFunctionExpression,\n  isReturnStatement,\n} from '../../utils';\n\nexport const noDispatchInEffects = 'noDispatchInEffects';\nexport const noDispatchInEffectsSuggest = 'noDispatchInEffectsSuggest';\n\ntype MessageIds =\n  | typeof noDispatchInEffects\n  | typeof noDispatchInEffectsSuggest;\ntype Options = readonly [];\ntype MemberExpressionWithinCallExpression = TSESTree.MemberExpression & {\n  parent: TSESTree.CallExpression;\n};\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'suggestion',\n    ngrxModule: 'effects',\n    hasSuggestions: true,\n    docs: {\n      description: '`Effect` should not call `store.dispatch`.',\n    },\n    schema: [],\n    messages: {\n      [noDispatchInEffects]:\n        'Calling `store.dispatch` in `Effect` is forbidden.',\n      [noDispatchInEffectsSuggest]: 'Remove `store.dispatch`.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const { identifiers = [] } = getNgRxStores(context);\n    const storeNames = identifiers.length > 0 ? asPattern(identifiers) : null;\n\n    if (!storeNames) {\n      return {};\n    }\n\n    return {\n      [dispatchInEffects(storeNames)](\n        node: MemberExpressionWithinCallExpression\n      ) {\n        const nodeToReport = getNodeToReport(node);\n        context.report({\n          node: nodeToReport,\n          messageId: noDispatchInEffects,\n          suggest: [\n            {\n              messageId: noDispatchInEffectsSuggest,\n              fix: (fixer) => fixer.remove(nodeToReport),\n            },\n          ],\n        });\n      },\n    };\n  },\n});\n\nfunction getNodeToReport(node: MemberExpressionWithinCallExpression) {\n  const { parent } = node;\n  const { parent: grandParent } = parent;\n  return grandParent &&\n    (isArrowFunctionExpression(grandParent) || isReturnStatement(grandParent))\n    ? node\n    : parent;\n}\n"]}
+{"version":3,"file":"no-dispatch-in-effects.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/effects/no-dispatch-in-effects.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAChD,uCAMqB;AAER,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;AAC5C,QAAA,0BAA0B,GAAG,4BAA4B,CAAC;AAUvE,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,cAAc,EAAE,IAAI;QACpB,IAAI,EAAE;YACJ,WAAW,EAAE,4CAA4C;YACzD,UAAU,EAAE,SAAS;SACtB;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,2BAAmB,CAAC,EACnB,oDAAoD;YACtD,CAAC,kCAA0B,CAAC,EAAE,0BAA0B;SACzD;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,EAAE,WAAW,GAAG,EAAE,EAAE,GAAG,IAAA,qBAAa,EAAC,OAAO,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,iBAAS,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAE1E,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO;YACL,CAAC,IAAA,yBAAiB,EAAC,UAAU,CAAC,CAAC,CAC7B,IAA0C;gBAE1C,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;gBAC3C,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI,EAAE,YAAY;oBAClB,SAAS,EAAE,2BAAmB;oBAC9B,OAAO,EAAE;wBACP;4BACE,SAAS,EAAE,kCAA0B;4BACrC,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC;yBAC3C;qBACF;iBACF,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,eAAe,CAAC,IAA0C;IACjE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IACvC,OAAO,WAAW;QAChB,CAAC,IAAA,iCAAyB,EAAC,WAAW,CAAC,IAAI,IAAA,yBAAiB,EAAC,WAAW,CAAC,CAAC;QAC1E,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,MAAM,CAAC;AACb,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport {\n  asPattern,\n  dispatchInEffects,\n  getNgRxStores,\n  isArrowFunctionExpression,\n  isReturnStatement,\n} from '../../utils';\n\nexport const noDispatchInEffects = 'noDispatchInEffects';\nexport const noDispatchInEffectsSuggest = 'noDispatchInEffectsSuggest';\n\ntype MessageIds =\n  | typeof noDispatchInEffects\n  | typeof noDispatchInEffectsSuggest;\ntype Options = readonly [];\ntype MemberExpressionWithinCallExpression = TSESTree.MemberExpression & {\n  parent: TSESTree.CallExpression;\n};\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'suggestion',\n    hasSuggestions: true,\n    docs: {\n      description: '`Effect` should not call `store.dispatch`.',\n      ngrxModule: 'effects',\n    },\n    schema: [],\n    messages: {\n      [noDispatchInEffects]:\n        'Calling `store.dispatch` in `Effect` is forbidden.',\n      [noDispatchInEffectsSuggest]: 'Remove `store.dispatch`.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const { identifiers = [] } = getNgRxStores(context);\n    const storeNames = identifiers.length > 0 ? asPattern(identifiers) : null;\n\n    if (!storeNames) {\n      return {};\n    }\n\n    return {\n      [dispatchInEffects(storeNames)](\n        node: MemberExpressionWithinCallExpression\n      ) {\n        const nodeToReport = getNodeToReport(node);\n        context.report({\n          node: nodeToReport,\n          messageId: noDispatchInEffects,\n          suggest: [\n            {\n              messageId: noDispatchInEffectsSuggest,\n              fix: (fixer) => fixer.remove(nodeToReport),\n            },\n          ],\n        });\n      },\n    };\n  },\n});\n\nfunction getNodeToReport(node: MemberExpressionWithinCallExpression) {\n  const { parent } = node;\n  const { parent: grandParent } = parent;\n  return grandParent &&\n    (isArrowFunctionExpression(grandParent) || isReturnStatement(grandParent))\n    ? node\n    : parent;\n}\n"]}

package/src/rules/effects/no-effects-in-providers.d.ts

@@ -1,3 +1,3 @@
 export declare const messageId = "noEffectsInProviders";
-declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"noEffectsInProviders", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"noEffectsInProviders", readonly [], import("../../rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
 export default _default;

package/src/rules/effects/no-effects-in-providers.js

@@ -42,9 +42,9 @@ exports.default = (0, rule_creator_1.createRule)({
     name: path.parse(__filename).name,
     meta: {
         type: 'problem',
-        ngrxModule: 'effects',
         docs: {
             description: '`Effect` should not be listed as a provider if it is added to the `EffectsModule`.',
+            ngrxModule: 'effects',
         },
         fixable: 'code',
         schema: [],

package/src/rules/effects/no-effects-in-providers.js.map

@@ -1 +1 @@
-{"version":3,"file":"no-effects-in-providers.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/effects/no-effects-in-providers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAChD,uCAKqB;AAER,QAAA,SAAS,GAAG,sBAAsB,CAAC;AAKhD,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,SAAS;QACrB,IAAI,EAAE;YACJ,WAAW,EACT,oFAAoF;SACvF;QACD,OAAO,EAAE,MAAM;QACf,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EACT,oFAAoF;SACvF;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAuB,CAAC;QAC1D,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;QAE3C,OAAO;YACL,CAAC,kCAA0B,CAAC,CAAC,IAAyB;gBACpD,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YACD,CAAC,gCAAwB,CAAC,CAAC,EAAE,IAAI,EAAuB;gBACtD,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC;YACD,CAAC,GAAG,yBAAiB,OAAO,CAAC;gBAC3B,KAAK,MAAM,gBAAgB,IAAI,kBAAkB,EAAE,CAAC;oBAClD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;wBACjD,SAAS;oBACX,CAAC;oBAED,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,gBAAgB;wBACtB,SAAS,EAAT,iBAAS;wBACT,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,CACb,IAAA,+BAAuB,EACrB,OAAO,CAAC,UAAU,EAClB,KAAK,EACL,gBAAgB,CACjB;qBACJ,CAAC,CAAC;gBACL,CAAC;gBAED,gBAAgB,CAAC,KAAK,EAAE,CAAC;gBACzB,kBAAkB,CAAC,KAAK,EAAE,CAAC;YAC7B,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport {\n  effectsInNgModuleImports,\n  effectsInNgModuleProviders,\n  getNodeToCommaRemoveFix,\n  ngModuleDecorator,\n} from '../../utils';\n\nexport const messageId = 'noEffectsInProviders';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    ngrxModule: 'effects',\n    docs: {\n      description:\n        '`Effect` should not be listed as a provider if it is added to the `EffectsModule`.',\n    },\n    fixable: 'code',\n    schema: [],\n    messages: {\n      [messageId]:\n        '`Effect` should not be listed as a provider if it is added to the `EffectsModule`.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const effectsInProviders = new Set<TSESTree.Identifier>();\n    const effectsInImports = new Set<string>();\n\n    return {\n      [effectsInNgModuleProviders](node: TSESTree.Identifier) {\n        effectsInProviders.add(node);\n      },\n      [effectsInNgModuleImports]({ name }: TSESTree.Identifier) {\n        effectsInImports.add(name);\n      },\n      [`${ngModuleDecorator}:exit`]() {\n        for (const effectInProvider of effectsInProviders) {\n          if (!effectsInImports.has(effectInProvider.name)) {\n            continue;\n          }\n\n          context.report({\n            node: effectInProvider,\n            messageId,\n            fix: (fixer) =>\n              getNodeToCommaRemoveFix(\n                context.sourceCode,\n                fixer,\n                effectInProvider\n              ),\n          });\n        }\n\n        effectsInImports.clear();\n        effectsInProviders.clear();\n      },\n    };\n  },\n});\n"]}
+{"version":3,"file":"no-effects-in-providers.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/effects/no-effects-in-providers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAChD,uCAKqB;AAER,QAAA,SAAS,GAAG,sBAAsB,CAAC;AAKhD,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,oFAAoF;YACtF,UAAU,EAAE,SAAS;SACtB;QACD,OAAO,EAAE,MAAM;QACf,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EACT,oFAAoF;SACvF;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAuB,CAAC;QAC1D,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;QAE3C,OAAO;YACL,CAAC,kCAA0B,CAAC,CAAC,IAAyB;gBACpD,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YACD,CAAC,gCAAwB,CAAC,CAAC,EAAE,IAAI,EAAuB;gBACtD,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC;YACD,CAAC,GAAG,yBAAiB,OAAO,CAAC;gBAC3B,KAAK,MAAM,gBAAgB,IAAI,kBAAkB,EAAE,CAAC;oBAClD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;wBACjD,SAAS;oBACX,CAAC;oBAED,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,gBAAgB;wBACtB,SAAS,EAAT,iBAAS;wBACT,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,CACb,IAAA,+BAAuB,EACrB,OAAO,CAAC,UAAU,EAClB,KAAK,EACL,gBAAgB,CACjB;qBACJ,CAAC,CAAC;gBACL,CAAC;gBAED,gBAAgB,CAAC,KAAK,EAAE,CAAC;gBACzB,kBAAkB,CAAC,KAAK,EAAE,CAAC;YAC7B,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport {\n  effectsInNgModuleImports,\n  effectsInNgModuleProviders,\n  getNodeToCommaRemoveFix,\n  ngModuleDecorator,\n} from '../../utils';\n\nexport const messageId = 'noEffectsInProviders';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    docs: {\n      description:\n        '`Effect` should not be listed as a provider if it is added to the `EffectsModule`.',\n      ngrxModule: 'effects',\n    },\n    fixable: 'code',\n    schema: [],\n    messages: {\n      [messageId]:\n        '`Effect` should not be listed as a provider if it is added to the `EffectsModule`.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    const effectsInProviders = new Set<TSESTree.Identifier>();\n    const effectsInImports = new Set<string>();\n\n    return {\n      [effectsInNgModuleProviders](node: TSESTree.Identifier) {\n        effectsInProviders.add(node);\n      },\n      [effectsInNgModuleImports]({ name }: TSESTree.Identifier) {\n        effectsInImports.add(name);\n      },\n      [`${ngModuleDecorator}:exit`]() {\n        for (const effectInProvider of effectsInProviders) {\n          if (!effectsInImports.has(effectInProvider.name)) {\n            continue;\n          }\n\n          context.report({\n            node: effectInProvider,\n            messageId,\n            fix: (fixer) =>\n              getNodeToCommaRemoveFix(\n                context.sourceCode,\n                fixer,\n                effectInProvider\n              ),\n          });\n        }\n\n        effectsInImports.clear();\n        effectsInProviders.clear();\n      },\n    };\n  },\n});\n"]}

package/src/rules/effects/no-multiple-actions-in-effects.d.ts

@@ -1,5 +1,5 @@
 import { ESLintUtils } from '@typescript-eslint/utils';
 export declare const messageId = "noMultipleActionsInEffects";
 type Options = readonly unknown[];
-declare const _default: ESLintUtils.RuleModule<"noMultipleActionsInEffects", Options, unknown, ESLintUtils.RuleListener>;
+declare const _default: ESLintUtils.RuleModule<"noMultipleActionsInEffects", Options, import("../../rule-creator").NgRxRuleDocs, ESLintUtils.RuleListener>;
 export default _default;

package/src/rules/effects/no-multiple-actions-in-effects.js

@@ -43,9 +43,9 @@ exports.default = (0, rule_creator_1.createRule)({
     name: path.parse(__filename).name,
     meta: {
         type: 'problem',
-        ngrxModule: 'effects',
         docs: {
             description: '`Effect` should not return multiple actions.',
+            ngrxModule: 'effects',
             requiresTypeChecking: true,
         },
         schema: [],

package/src/rules/effects/no-multiple-actions-in-effects.js.map

@@ -1 +1 @@
-{"version":3,"file":"no-multiple-actions-in-effects.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/effects/no-multiple-actions-in-effects.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAIkC;AAClC,2CAA6B;AAC7B,qDAAgD;AAChD,uCAKqB;AAER,QAAA,SAAS,GAAG,4BAA4B,CAAC;AAUtD,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,SAAS;QACrB,IAAI,EAAE;YACJ,WAAW,EAAE,8CAA8C;YAC3D,oBAAoB,EAAE,IAAI;SAC3B;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EAAE,yCAAyC;SACvD;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,OAAO;YACL,CAAC,GAAG,8BAAsB,IAAI,sCAA8B,EAAE,CAAC,CAC7D,IAAmC;gBAEnC,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;gBAC3C,IAAI,CAAC,YAAY,EAAE,CAAC;oBAClB,OAAO;gBACT,CAAC;gBAED,MAAM,QAAQ,GAAG,mBAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;gBACxD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;gBACtD,MAAM,IAAI,GAAG,QAAQ,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;gBAEtD,IAAI,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;oBAClC,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,YAAY;wBAClB,SAAS,EAAT,iBAAS;qBACV,CAAC,CAAC;gBACL,CAAC;qBAAM,IACL,IAAI,CAAC,OAAO,EAAE;oBACd,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,EACpD,CAAC;oBACD,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,YAAY;wBAClB,SAAS,EAAT,iBAAS;qBACV,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,eAAe,CAAC,IAAmC;IAC1D,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,sBAAc,CAAC,uBAAuB,CAAC;QAC5C,KAAK,sBAAc,CAAC,kBAAkB;YACpC,OAAO,IAAA,wBAAgB,EAAC,IAAI,CAAC,IAAI,CAAC;gBAChC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBACrC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAChB,KAAK,sBAAc,CAAC,cAAc;YAChC,OAAO,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClE;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAsB;IACjD,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAiC,EAAE,CACjE,IAAA,yBAAiB,EAAC,CAAC,CAAC,CACrB,CAAC;IACF,OAAO,UAAU,EAAE,QAAQ,CAAC;AAC9B,CAAC","sourcesContent":["import {\n  AST_NODE_TYPES,\n  ESLintUtils,\n  type TSESTree,\n} from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport {\n  createEffectExpression,\n  isBlockStatement,\n  isReturnStatement,\n  mapLikeOperatorCallExpressions,\n} from '../../utils';\n\nexport const messageId = 'noMultipleActionsInEffects';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly unknown[];\ntype EffectsMapLikeOperatorsReturn =\n  | TSESTree.ArrowFunctionExpression\n  | TSESTree.CallExpression\n  | TSESTree.FunctionExpression\n  | TSESTree.ReturnStatement;\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    ngrxModule: 'effects',\n    docs: {\n      description: '`Effect` should not return multiple actions.',\n      requiresTypeChecking: true,\n    },\n    schema: [],\n    messages: {\n      [messageId]: '`Effect` should return a single action.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    return {\n      [`${createEffectExpression} ${mapLikeOperatorCallExpressions}`](\n        node: EffectsMapLikeOperatorsReturn\n      ) {\n        const nodeToReport = getNodeToReport(node);\n        if (!nodeToReport) {\n          return;\n        }\n\n        const services = ESLintUtils.getParserServices(context);\n        const typeChecker = services.program.getTypeChecker();\n        const type = services.getTypeAtLocation(nodeToReport);\n\n        if (typeChecker.isArrayType(type)) {\n          context.report({\n            node: nodeToReport,\n            messageId,\n          });\n        } else if (\n          type.isUnion() &&\n          type.types.some((ut) => typeChecker.isArrayType(ut))\n        ) {\n          context.report({\n            node: nodeToReport,\n            messageId,\n          });\n        }\n      },\n    };\n  },\n});\n\nfunction getNodeToReport(node: EffectsMapLikeOperatorsReturn) {\n  switch (node.type) {\n    case AST_NODE_TYPES.ArrowFunctionExpression:\n    case AST_NODE_TYPES.FunctionExpression:\n      return isBlockStatement(node.body)\n        ? findReturnStatement(node.body.body)\n        : node.body;\n    case AST_NODE_TYPES.CallExpression:\n      return findReturnStatement(node.arguments) ?? node.arguments[0];\n    default:\n      return node.argument;\n  }\n}\n\nfunction findReturnStatement(nodes: TSESTree.Node[]) {\n  const returnNode = nodes.find((n): n is TSESTree.ReturnStatement =>\n    isReturnStatement(n)\n  );\n  return returnNode?.argument;\n}\n"]}
+{"version":3,"file":"no-multiple-actions-in-effects.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/effects/no-multiple-actions-in-effects.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAIkC;AAClC,2CAA6B;AAC7B,qDAAgD;AAChD,uCAKqB;AAER,QAAA,SAAS,GAAG,4BAA4B,CAAC;AAUtD,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,8CAA8C;YAC3D,UAAU,EAAE,SAAS;YACrB,oBAAoB,EAAE,IAAI;SAC3B;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EAAE,yCAAyC;SACvD;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,OAAO;YACL,CAAC,GAAG,8BAAsB,IAAI,sCAA8B,EAAE,CAAC,CAC7D,IAAmC;gBAEnC,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;gBAC3C,IAAI,CAAC,YAAY,EAAE,CAAC;oBAClB,OAAO;gBACT,CAAC;gBAED,MAAM,QAAQ,GAAG,mBAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;gBACxD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;gBACtD,MAAM,IAAI,GAAG,QAAQ,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;gBAEtD,IAAI,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;oBAClC,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,YAAY;wBAClB,SAAS,EAAT,iBAAS;qBACV,CAAC,CAAC;gBACL,CAAC;qBAAM,IACL,IAAI,CAAC,OAAO,EAAE;oBACd,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,EACpD,CAAC;oBACD,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,YAAY;wBAClB,SAAS,EAAT,iBAAS;qBACV,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,eAAe,CAAC,IAAmC;IAC1D,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,sBAAc,CAAC,uBAAuB,CAAC;QAC5C,KAAK,sBAAc,CAAC,kBAAkB;YACpC,OAAO,IAAA,wBAAgB,EAAC,IAAI,CAAC,IAAI,CAAC;gBAChC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBACrC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAChB,KAAK,sBAAc,CAAC,cAAc;YAChC,OAAO,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClE;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAsB;IACjD,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAiC,EAAE,CACjE,IAAA,yBAAiB,EAAC,CAAC,CAAC,CACrB,CAAC;IACF,OAAO,UAAU,EAAE,QAAQ,CAAC;AAC9B,CAAC","sourcesContent":["import {\n  AST_NODE_TYPES,\n  ESLintUtils,\n  type TSESTree,\n} from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\nimport {\n  createEffectExpression,\n  isBlockStatement,\n  isReturnStatement,\n  mapLikeOperatorCallExpressions,\n} from '../../utils';\n\nexport const messageId = 'noMultipleActionsInEffects';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly unknown[];\ntype EffectsMapLikeOperatorsReturn =\n  | TSESTree.ArrowFunctionExpression\n  | TSESTree.CallExpression\n  | TSESTree.FunctionExpression\n  | TSESTree.ReturnStatement;\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'problem',\n    docs: {\n      description: '`Effect` should not return multiple actions.',\n      ngrxModule: 'effects',\n      requiresTypeChecking: true,\n    },\n    schema: [],\n    messages: {\n      [messageId]: '`Effect` should return a single action.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    return {\n      [`${createEffectExpression} ${mapLikeOperatorCallExpressions}`](\n        node: EffectsMapLikeOperatorsReturn\n      ) {\n        const nodeToReport = getNodeToReport(node);\n        if (!nodeToReport) {\n          return;\n        }\n\n        const services = ESLintUtils.getParserServices(context);\n        const typeChecker = services.program.getTypeChecker();\n        const type = services.getTypeAtLocation(nodeToReport);\n\n        if (typeChecker.isArrayType(type)) {\n          context.report({\n            node: nodeToReport,\n            messageId,\n          });\n        } else if (\n          type.isUnion() &&\n          type.types.some((ut) => typeChecker.isArrayType(ut))\n        ) {\n          context.report({\n            node: nodeToReport,\n            messageId,\n          });\n        }\n      },\n    };\n  },\n});\n\nfunction getNodeToReport(node: EffectsMapLikeOperatorsReturn) {\n  switch (node.type) {\n    case AST_NODE_TYPES.ArrowFunctionExpression:\n    case AST_NODE_TYPES.FunctionExpression:\n      return isBlockStatement(node.body)\n        ? findReturnStatement(node.body.body)\n        : node.body;\n    case AST_NODE_TYPES.CallExpression:\n      return findReturnStatement(node.arguments) ?? node.arguments[0];\n    default:\n      return node.argument;\n  }\n}\n\nfunction findReturnStatement(nodes: TSESTree.Node[]) {\n  const returnNode = nodes.find((n): n is TSESTree.ReturnStatement =>\n    isReturnStatement(n)\n  );\n  return returnNode?.argument;\n}\n"]}

package/src/rules/effects/prefer-action-creator-in-of-type.d.ts

@@ -1,3 +1,3 @@
 export declare const messageId = "preferActionCreatorInOfType";
-declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferActionCreatorInOfType", readonly [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferActionCreatorInOfType", readonly [], import("../../rule-creator").NgRxRuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
 export default _default;

package/src/rules/effects/prefer-action-creator-in-of-type.js

@@ -41,9 +41,9 @@ exports.default = (0, rule_creator_1.createRule)({
     name: path.parse(__filename).name,
     meta: {
         type: 'suggestion',
-        ngrxModule: 'effects',
         docs: {
             description: 'Using `action creator` in `ofType` is preferred over `string`.',
+            ngrxModule: 'effects',
         },
         schema: [],
         messages: {

package/src/rules/effects/prefer-action-creator-in-of-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"prefer-action-creator-in-of-type.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/effects/prefer-action-creator-in-of-type.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAEnC,QAAA,SAAS,GAAG,6BAA6B,CAAC;AAKvD,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,UAAU,EAAE,SAAS;QACrB,IAAI,EAAE;YACJ,WAAW,EACT,gEAAgE;SACnE;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EAAE,4DAA4D;SAC1E;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,OAAO;YACL,CAAC,8CAA8C,CAAC,CAAC,IAAsB;gBACrE,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,SAAS,EAAT,iBAAS;iBACV,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\n\nexport const messageId = 'preferActionCreatorInOfType';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'suggestion',\n    ngrxModule: 'effects',\n    docs: {\n      description:\n        'Using `action creator` in `ofType` is preferred over `string`.',\n    },\n    schema: [],\n    messages: {\n      [messageId]: 'Using `string` is forbidden. Use `action creator` instead.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    return {\n      [`CallExpression[callee.name='ofType'] Literal`](node: TSESTree.Literal) {\n        context.report({\n          node,\n          messageId,\n        });\n      },\n    };\n  },\n});\n"]}
+{"version":3,"file":"prefer-action-creator-in-of-type.js","sourceRoot":"","sources":["../../../../../../modules/eslint-plugin/src/rules/effects/prefer-action-creator-in-of-type.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,2CAA6B;AAC7B,qDAAgD;AAEnC,QAAA,SAAS,GAAG,6BAA6B,CAAC;AAKvD,kBAAe,IAAA,yBAAU,EAAsB;IAC7C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EACT,gEAAgE;YAClE,UAAU,EAAE,SAAS;SACtB;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,CAAC,iBAAS,CAAC,EAAE,4DAA4D;SAC1E;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,OAAO;YACL,CAAC,8CAA8C,CAAC,CAAC,IAAsB;gBACrE,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,SAAS,EAAT,iBAAS;iBACV,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC","sourcesContent":["import type { TSESTree } from '@typescript-eslint/utils';\nimport * as path from 'path';\nimport { createRule } from '../../rule-creator';\n\nexport const messageId = 'preferActionCreatorInOfType';\n\ntype MessageIds = typeof messageId;\ntype Options = readonly [];\n\nexport default createRule<Options, MessageIds>({\n  name: path.parse(__filename).name,\n  meta: {\n    type: 'suggestion',\n    docs: {\n      description:\n        'Using `action creator` in `ofType` is preferred over `string`.',\n      ngrxModule: 'effects',\n    },\n    schema: [],\n    messages: {\n      [messageId]: 'Using `string` is forbidden. Use `action creator` instead.',\n    },\n  },\n  defaultOptions: [],\n  create: (context) => {\n    return {\n      [`CallExpression[callee.name='ofType'] Literal`](node: TSESTree.Literal) {\n        context.report({\n          node,\n          messageId,\n        });\n      },\n    };\n  },\n});\n"]}