feat(strict): add strict config

JasonWeinzierl · JasonWeinzierl · commit 22924d0fd01e · 2024-11-22T10:23:35.000-06:00
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-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-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-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).
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/strict.ts b/src/configs/strict.ts
@@ -0,0 +1,33 @@
+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-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-replay-buffer': 'error',
+    'rxjs-x/no-ignored-takewhile-value': 'error',
+    'rxjs-x/no-implicit-any-catch': ['error', { allowExplicitAny: false }],
+    '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', { allowConfig: true }],
+    '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', { allowNext: false }],
+    'rxjs-x/prefer-root-operators': 'error',
+    'rxjs-x/throw-error': ['error', { allowThrowingAny: false, allowThrowingUnknown: false }],
+  },
+} 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/tests/configs/strict.test.ts b/tests/configs/strict.test.ts
@@ -0,0 +1,19 @@
+import { createRecommendedConfig } from '../../src/configs/recommended';
+import { createStrictConfig } from '../../src/configs/strict';
+
+describe('strict', () => {
+  const mockPlugin = {};
+  const config = createStrictConfig(mockPlugin);
+
+  it('should add the rxjs-x plugin', () => {
+    expect(config.plugins).toEqual({ 'rxjs-x': mockPlugin });
+  });
+
+  it('should include the recommended rules', () => {
+    const recommendedConfig = createRecommendedConfig(mockPlugin);
+
+    for (const rule of Object.keys(recommendedConfig.rules)) {
+      expect(config.rules).toHaveProperty(rule);
+    }
+  });
+});
