feat(strict): add strict configuration (#41)

JasonWeinzierl · web-flow · commit f2bf3fadcbe7 · 2024-11-24T10:15:50.000-06:00
Introduces a new configuration `strict` for enforcing more difficult-yet-generally-useful RxJS rules/conventions. - Includes all rules from `recommended`. - Plus adds these rules: - `no-explicit-generics` - `no-exposed-subjects` - `no-ignored-default-value` - `no-ignored-error` - `no-ignored-observable` - `no-subclass` - `no-topromise`* - `prefer-observer`* - `prefer-root-operators`* - `throw-error`* - *these indicated rules will soon be added to `recommended`. See #35 . - Added unit tests for ensuring the `rule.meta.docs.recommended` metadata stays in sync with the configs. Resolves #36 .
diff --git a/README.md b/README.md
diff --git a/docs/rules/no-async-subscribe.md b/docs/rules/no-async-subscribe.md
@@ -1,6 +1,6 @@
 # Disallow passing `async` functions to `subscribe` (`rxjs-x/no-async-subscribe`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
diff --git a/docs/rules/no-create.md b/docs/rules/no-create.md
@@ -1,6 +1,6 @@
 # Disallow the static `Observable.create` function (`rxjs-x/no-create`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
diff --git a/docs/rules/no-explicit-generics.md b/docs/rules/no-explicit-generics.md
@@ -1,5 +1,7 @@
 # Disallow unnecessary explicit generic type arguments (`rxjs-x/no-explicit-generics`)
 
+💼 This rule is enabled in the 🔒 `strict` config.
+
 <!-- end auto-generated rule header -->
 
 This rule prevents the use of explicit type arguments when the type arguments can be inferred.
diff --git a/docs/rules/no-exposed-subjects.md b/docs/rules/no-exposed-subjects.md
@@ -1,5 +1,7 @@
 # Disallow public and protected subjects (`rxjs-x/no-exposed-subjects`)
 
+💼 This rule is enabled in the 🔒 `strict` config.
+
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-ignored-default-value.md b/docs/rules/no-ignored-default-value.md
@@ -1,5 +1,7 @@
 # Disallow using `firstValueFrom`, `lastValueFrom`, `first`, and `last` without specifying a default value (`rxjs-x/no-ignored-default-value`)
 
+💼 This rule is enabled in the 🔒 `strict` config.
+
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-ignored-error.md b/docs/rules/no-ignored-error.md
@@ -1,5 +1,7 @@
 # Disallow calling `subscribe` without specifying an error handler (`rxjs-x/no-ignored-error`)
 
+💼 This rule is enabled in the 🔒 `strict` config.
+
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-ignored-notifier.md b/docs/rules/no-ignored-notifier.md
@@ -1,6 +1,6 @@
 # Disallow observables not composed from the `repeatWhen` or `retryWhen` notifier (`rxjs-x/no-ignored-notifier`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
diff --git a/docs/rules/no-ignored-observable.md b/docs/rules/no-ignored-observable.md
@@ -1,5 +1,7 @@
 # Disallow ignoring observables returned by functions (`rxjs-x/no-ignored-observable`)
 
+💼 This rule is enabled in the 🔒 `strict` config.
+
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-ignored-replay-buffer.md b/docs/rules/no-ignored-replay-buffer.md
@@ -1,6 +1,6 @@
 # Disallow using `ReplaySubject`, `publishReplay` or `shareReplay` without specifying the buffer size (`rxjs-x/no-ignored-replay-buffer`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-ignored-takewhile-value.md b/docs/rules/no-ignored-takewhile-value.md
@@ -1,6 +1,6 @@
 # Disallow ignoring the value within `takeWhile` (`rxjs-x/no-ignored-takewhile-value`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-implicit-any-catch.md b/docs/rules/no-implicit-any-catch.md
@@ -1,6 +1,6 @@
 # Disallow implicit `any` error parameters in `catchError` operators (`rxjs-x/no-implicit-any-catch`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
diff --git a/docs/rules/no-index.md b/docs/rules/no-index.md
@@ -1,6 +1,6 @@
 # Disallow importing index modules (`rxjs-x/no-index`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-internal.md b/docs/rules/no-internal.md
@@ -1,6 +1,6 @@
 # Disallow importing internal modules (`rxjs-x/no-internal`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
diff --git a/docs/rules/no-nested-subscribe.md b/docs/rules/no-nested-subscribe.md
@@ -1,6 +1,6 @@
 # Disallow calling `subscribe` within a `subscribe` callback (`rxjs-x/no-nested-subscribe`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
diff --git a/docs/rules/no-redundant-notify.md b/docs/rules/no-redundant-notify.md
@@ -1,6 +1,6 @@
 # Disallow sending redundant notifications from completed or errored observables (`rxjs-x/no-redundant-notify`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
diff --git a/docs/rules/no-sharereplay.md b/docs/rules/no-sharereplay.md
@@ -1,6 +1,6 @@
 # Disallow unsafe `shareReplay` usage (`rxjs-x/no-sharereplay`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-subclass.md b/docs/rules/no-subclass.md
@@ -1,5 +1,7 @@
 # Disallow subclassing RxJS classes (`rxjs-x/no-subclass`)
 
+💼 This rule is enabled in the 🔒 `strict` config.
+
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-subject-unsubscribe.md b/docs/rules/no-subject-unsubscribe.md
@@ -1,6 +1,6 @@
 # Disallow calling the `unsubscribe` method of subjects (`rxjs-x/no-subject-unsubscribe`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
diff --git a/docs/rules/no-topromise.md b/docs/rules/no-topromise.md
@@ -1,5 +1,7 @@
 # Disallow use of the `toPromise` method (`rxjs-x/no-topromise`)
 
+💼 This rule is enabled in the 🔒 `strict` config.
+
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
diff --git a/docs/rules/no-unbound-methods.md b/docs/rules/no-unbound-methods.md
@@ -1,6 +1,6 @@
 # Disallow passing unbound methods (`rxjs-x/no-unbound-methods`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
diff --git a/docs/rules/no-unsafe-subject-next.md b/docs/rules/no-unsafe-subject-next.md
@@ -1,6 +1,6 @@
 # Disallow unsafe optional `next` calls (`rxjs-x/no-unsafe-subject-next`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
diff --git a/docs/rules/no-unsafe-takeuntil.md b/docs/rules/no-unsafe-takeuntil.md
@@ -1,6 +1,6 @@
 # Disallow applying operators after `takeUntil` (`rxjs-x/no-unsafe-takeuntil`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
diff --git a/docs/rules/prefer-observer.md b/docs/rules/prefer-observer.md
@@ -1,5 +1,7 @@
 # Disallow passing separate handlers to `subscribe` and `tap` (`rxjs-x/prefer-observer`)
 
+💼 This rule is enabled in the 🔒 `strict` config.
+
 🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
@@ -46,3 +48,7 @@ This rule accepts a single option which is an object with an `allowNext` propert
   ]
 }
 ```
+
+## Further reading
+
+- [Subscribe Arguments](https://rxjs.dev/deprecations/subscribe-arguments)
diff --git a/docs/rules/prefer-root-operators.md b/docs/rules/prefer-root-operators.md
@@ -1,5 +1,7 @@
 # Disallow importing operators from `rxjs/operators` (`rxjs-x/prefer-root-operators`)
 
+💼 This rule is enabled in the 🔒 `strict` config.
+
 🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/throw-error.md b/docs/rules/throw-error.md
@@ -1,5 +1,7 @@
 # Enforce passing only `Error` values to `throwError` (`rxjs-x/throw-error`)
 
+💼 This rule is enabled in the 🔒 `strict` config.
+
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 <!-- end auto-generated rule header -->
diff --git a/src/configs/recommended.ts b/src/configs/recommended.ts
@@ -1,6 +1,8 @@
 import { TSESLint } from '@typescript-eslint/utils';
 
-export const createRecommendedConfig = (plugin: TSESLint.FlatConfig.Plugin) => ({
+export const createRecommendedConfig = (
+  plugin: TSESLint.FlatConfig.Plugin,
+) => ({
   plugins: {
     'rxjs-x': plugin,
   },
@@ -15,7 +17,7 @@ export const createRecommendedConfig = (plugin: TSESLint.FlatConfig.Plugin) => (
     'rxjs-x/no-internal': 'error',
     'rxjs-x/no-nested-subscribe': 'error',
     'rxjs-x/no-redundant-notify': 'error',
-    'rxjs-x/no-sharereplay': ['error', { allowConfig: true }],
+    'rxjs-x/no-sharereplay': 'error',
     'rxjs-x/no-subject-unsubscribe': 'error',
     'rxjs-x/no-unbound-methods': 'error',
     'rxjs-x/no-unsafe-subject-next': 'error',
diff --git a/src/configs/strict.ts b/src/configs/strict.ts
@@ -0,0 +1,41 @@
+import { TSESLint } from '@typescript-eslint/utils';
+
+export const createStrictConfig = (
+  plugin: TSESLint.FlatConfig.Plugin,
+) => ({
+  plugins: {
+    'rxjs-x': plugin,
+  },
+  rules: {
+    'rxjs-x/no-async-subscribe': 'error',
+    'rxjs-x/no-create': 'error',
+    'rxjs-x/no-explicit-generics': 'error',
+    'rxjs-x/no-exposed-subjects': 'error',
+    'rxjs-x/no-ignored-default-value': 'error',
+    'rxjs-x/no-ignored-error': 'error',
+    'rxjs-x/no-ignored-notifier': 'error',
+    'rxjs-x/no-ignored-observable': 'error',
+    'rxjs-x/no-ignored-replay-buffer': 'error',
+    'rxjs-x/no-ignored-takewhile-value': 'error',
+    'rxjs-x/no-implicit-any-catch': ['error', {
+      allowExplicitAny: false as const,
+    }],
+    'rxjs-x/no-index': 'error',
+    'rxjs-x/no-internal': 'error',
+    'rxjs-x/no-nested-subscribe': 'error',
+    'rxjs-x/no-redundant-notify': 'error',
+    'rxjs-x/no-sharereplay': 'error',
+    'rxjs-x/no-subclass': 'error',
+    'rxjs-x/no-subject-unsubscribe': 'error',
+    'rxjs-x/no-topromise': 'error',
+    'rxjs-x/no-unbound-methods': 'error',
+    'rxjs-x/no-unsafe-subject-next': 'error',
+    'rxjs-x/no-unsafe-takeuntil': 'error',
+    'rxjs-x/prefer-observer': 'error',
+    'rxjs-x/prefer-root-operators': 'error',
+    'rxjs-x/throw-error': ['error', {
+      allowThrowingAny: false as const,
+      allowThrowingUnknown: false as const,
+    }],
+  },
+} satisfies TSESLint.FlatConfig.Config);
diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,7 @@
 import { TSESLint } from '@typescript-eslint/utils';
 import { name, version } from '../package.json';
 import { createRecommendedConfig } from './configs/recommended';
+import { createStrictConfig } from './configs/strict';
 
 import { banObservablesRule } from './rules/ban-observables';
 import { banOperatorsRule } from './rules/ban-operators';
@@ -99,6 +100,7 @@ const rxjsX = {
   ...plugin,
   configs: {
     recommended: createRecommendedConfig(plugin),
+    strict: createStrictConfig(plugin),
   },
 } satisfies TSESLint.FlatConfig.Plugin;
 
diff --git a/src/rules/no-async-subscribe.ts b/src/rules/no-async-subscribe.ts
@@ -7,7 +7,7 @@ export const noAsyncSubscribeRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow passing `async` functions to `subscribe`.',
-      recommended: true,
+      recommended: 'recommended',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-create.ts b/src/rules/no-create.ts
@@ -7,7 +7,7 @@ export const noCreateRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow the static `Observable.create` function.',
-      recommended: true,
+      recommended: 'recommended',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-explicit-generics.ts b/src/rules/no-explicit-generics.ts
@@ -7,6 +7,7 @@ export const noExplicitGenericsRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow unnecessary explicit generic type arguments.',
+      recommended: 'strict',
     },
     messages: {
       forbidden: 'Explicit generic type arguments are forbidden.',
diff --git a/src/rules/no-exposed-subjects.ts b/src/rules/no-exposed-subjects.ts
@@ -12,6 +12,7 @@ export const noExposedSubjectsRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow public and protected subjects.',
+      recommended: 'strict',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-ignored-default-value.ts b/src/rules/no-ignored-default-value.ts
@@ -7,6 +7,7 @@ export const noIgnoredDefaultValueRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow using `firstValueFrom`, `lastValueFrom`, `first`, and `last` without specifying a default value.',
+      recommended: 'strict',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-ignored-error.ts b/src/rules/no-ignored-error.ts
@@ -8,6 +8,7 @@ export const noIgnoredErrorRule = ruleCreator({
     docs: {
       description:
         'Disallow calling `subscribe` without specifying an error handler.',
+      recommended: 'strict',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-ignored-notifier.ts b/src/rules/no-ignored-notifier.ts
@@ -12,7 +12,7 @@ export const noIgnoredNotifierRule = ruleCreator({
     docs: {
       description:
         'Disallow observables not composed from the `repeatWhen` or `retryWhen` notifier.',
-      recommended: true,
+      recommended: 'recommended',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-ignored-observable.ts b/src/rules/no-ignored-observable.ts
@@ -7,6 +7,7 @@ export const noIgnoredObservableRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow ignoring observables returned by functions.',
+      recommended: 'strict',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-ignored-replay-buffer.ts b/src/rules/no-ignored-replay-buffer.ts
@@ -8,7 +8,7 @@ export const noIgnoredReplayBufferRule = ruleCreator({
     docs: {
       description:
         'Disallow using `ReplaySubject`, `publishReplay` or `shareReplay` without specifying the buffer size.',
-      recommended: true,
+      recommended: 'recommended',
     },
     messages: {
       forbidden: 'Ignoring the buffer size is forbidden.',
diff --git a/src/rules/no-ignored-takewhile-value.ts b/src/rules/no-ignored-takewhile-value.ts
@@ -12,7 +12,7 @@ export const noIgnoredTakewhileValueRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow ignoring the value within `takeWhile`.',
-      recommended: true,
+      recommended: 'recommended',
     },
     messages: {
       forbidden: 'Ignoring the value within takeWhile is forbidden.',
diff --git a/src/rules/no-implicit-any-catch.ts b/src/rules/no-implicit-any-catch.ts
@@ -40,7 +40,12 @@ export const noImplicitAnyCatchRule = ruleCreator({
     docs: {
       description:
         'Disallow implicit `any` error parameters in `catchError` operators.',
-      recommended: true,
+      recommended: {
+        recommended: true,
+        strict: [{
+          allowExplicitAny: false,
+        }],
+      },
       requiresTypeChecking: true,
     },
     fixable: 'code',
diff --git a/src/rules/no-index.ts b/src/rules/no-index.ts
@@ -6,7 +6,7 @@ export const noIndexRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow importing index modules.',
-      recommended: true,
+      recommended: 'recommended',
     },
     messages: {
       forbidden: 'RxJS imports from index modules are forbidden.',
diff --git a/src/rules/no-internal.ts b/src/rules/no-internal.ts
diff --git a/src/rules/no-nested-subscribe.ts b/src/rules/no-nested-subscribe.ts
diff --git a/src/rules/no-redundant-notify.ts b/src/rules/no-redundant-notify.ts
diff --git a/src/rules/no-sharereplay.ts b/src/rules/no-sharereplay.ts
diff --git a/src/rules/no-subclass.ts b/src/rules/no-subclass.ts
diff --git a/src/rules/no-subject-unsubscribe.ts b/src/rules/no-subject-unsubscribe.ts
diff --git a/src/rules/no-topromise.ts b/src/rules/no-topromise.ts
diff --git a/src/rules/no-unbound-methods.ts b/src/rules/no-unbound-methods.ts
diff --git a/src/rules/no-unsafe-subject-next.ts b/src/rules/no-unsafe-subject-next.ts
diff --git a/src/rules/no-unsafe-takeuntil.ts b/src/rules/no-unsafe-takeuntil.ts
diff --git a/src/rules/prefer-observer.ts b/src/rules/prefer-observer.ts
diff --git a/src/rules/prefer-root-operators.ts b/src/rules/prefer-root-operators.ts
diff --git a/src/rules/throw-error.ts b/src/rules/throw-error.ts
diff --git a/src/utils.ts b/src/utils.ts
diff --git a/tests/configs/recommended.test.ts b/tests/configs/recommended.test.ts
diff --git a/tests/configs/strict.test.ts b/tests/configs/strict.test.ts
diff --git a/tests/package.test.ts b/tests/package.test.ts
