refactor(strict): indicate strict or recommended in rules

JasonWeinzierl · JasonWeinzierl · commit 0114479049cc · 2024-11-22T11:03:56.000-06:00
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-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-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
@@ -9,7 +9,7 @@ export const noInternalRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow importing internal modules.',
-      recommended: true,
+      recommended: 'recommended',
     },
     fixable: 'code',
     hasSuggestions: true,
diff --git a/src/rules/no-nested-subscribe.ts b/src/rules/no-nested-subscribe.ts
@@ -8,7 +8,7 @@ export const noNestedSubscribeRule = ruleCreator({
     docs: {
       description:
         'Disallow calling `subscribe` within a `subscribe` callback.',
-      recommended: true,
+      recommended: 'recommended',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-redundant-notify.ts b/src/rules/no-redundant-notify.ts
@@ -18,7 +18,7 @@ export const noRedundantNotifyRule = ruleCreator({
     docs: {
       description:
         'Disallow sending redundant notifications from completed or errored observables.',
-      recommended: true,
+      recommended: 'recommended',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-sharereplay.ts b/src/rules/no-sharereplay.ts
@@ -10,7 +10,7 @@ export const noSharereplayRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow unsafe `shareReplay` usage.',
-      recommended: true,
+      recommended: 'recommended',
     },
     messages: {
       forbidden: 'shareReplay is forbidden.',
diff --git a/src/rules/no-subject-unsubscribe.ts b/src/rules/no-subject-unsubscribe.ts
@@ -8,7 +8,7 @@ export const noSubjectUnsubscribeRule = ruleCreator({
     docs: {
       description:
         'Disallow calling the `unsubscribe` method of subjects.',
-      recommended: true,
+      recommended: 'recommended',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-topromise.ts b/src/rules/no-topromise.ts
@@ -7,6 +7,7 @@ export const noTopromiseRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow use of the `toPromise` method.',
+      recommended: 'strict',
       requiresTypeChecking: true,
     },
     hasSuggestions: true,
diff --git a/src/rules/no-unbound-methods.ts b/src/rules/no-unbound-methods.ts
@@ -10,7 +10,7 @@ export const noUnboundMethodsRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow passing unbound methods.',
-      recommended: true,
+      recommended: 'recommended',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-unsafe-subject-next.ts b/src/rules/no-unsafe-subject-next.ts
@@ -12,7 +12,7 @@ export const noUnsafeSubjectNext = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow unsafe optional `next` calls.',
-      recommended: true,
+      recommended: 'recommended',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/no-unsafe-takeuntil.ts b/src/rules/no-unsafe-takeuntil.ts
@@ -42,7 +42,7 @@ export const noUnsafeTakeuntilRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow applying operators after `takeUntil`.',
-      recommended: true,
+      recommended: 'recommended',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/rules/prefer-observer.ts b/src/rules/prefer-observer.ts
@@ -20,6 +20,7 @@ export const preferObserverRule = ruleCreator({
     docs: {
       description:
         'Disallow passing separate handlers to `subscribe` and `tap`.',
+      recommended: 'strict',
       requiresTypeChecking: true,
     },
     fixable: 'code',
diff --git a/src/rules/prefer-root-operators.ts b/src/rules/prefer-root-operators.ts
@@ -22,6 +22,7 @@ export const preferRootOperatorsRule = ruleCreator({
   meta: {
     docs: {
       description: 'Disallow importing operators from `rxjs/operators`.',
+      recommended: 'strict',
     },
     fixable: 'code',
     hasSuggestions: true,
diff --git a/src/rules/throw-error.ts b/src/rules/throw-error.ts
@@ -15,6 +15,7 @@ export const throwErrorRule = ruleCreator({
     docs: {
       description:
         'Enforce passing only `Error` values to `throwError`.',
+      recommended: 'strict',
       requiresTypeChecking: true,
     },
     messages: {
diff --git a/src/utils.ts b/src/utils.ts
@@ -1,4 +1,4 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
+import { ESLintUtils, TSESLint } from '@typescript-eslint/utils';
 
 export function createRegExpForWords(
   config: string | string[],
@@ -22,7 +22,7 @@ export function escapeRegExp(text: string): string {
 
 export interface RxjsXRuleDocs {
   description: string;
-  recommended?: boolean;
+  recommended?: TSESLint.RuleRecommendation | TSESLint.RuleRecommendationAcrossConfigs<unknown[]>;
   requiresTypeChecking?: boolean;
 }
 
