feat: add requiresTypeChecking to meta.docs

JasonWeinzierl · JasonWeinzierl · commit 26b2ee345056 · 2024-11-01T13:11:01.000-05:00
- Also removed fixable and hasSuggestions when they're defaulted to false/undefined.
diff --git a/src/rules/ban-observables.ts b/src/rules/ban-observables.ts
@@ -9,10 +9,7 @@ export const banObservablesRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids the use of banned observables.',
-      recommended: false,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'RxJS observable is banned: {{name}}{{explanation}}.',
     },
diff --git a/src/rules/ban-operators.ts b/src/rules/ban-operators.ts
@@ -9,10 +9,7 @@ export const banOperatorsRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids the use of banned operators.',
-      recommended: false,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'RxJS operator is banned: {{name}}{{explanation}}.',
     },
diff --git a/src/rules/finnish.ts b/src/rules/finnish.ts
@@ -21,10 +21,8 @@ export const finnishRule = ruleCreator({
   meta: {
     docs: {
       description: 'Enforces the use of Finnish notation.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       shouldBeFinnish: 'Finnish notation should be used here.',
       shouldNotBeFinnish: 'Finnish notation should not be used here.',
diff --git a/src/rules/just.ts b/src/rules/just.ts
@@ -6,10 +6,8 @@ export const justRule = ruleCreator({
   meta: {
     docs: {
       description: 'Enforces the use of a `just` alias for `of`.',
-      recommended: false,
     },
     fixable: 'code',
-    hasSuggestions: false,
     messages: {
       forbidden: 'Use just alias.',
     },
diff --git a/src/rules/macro.ts b/src/rules/macro.ts
@@ -9,10 +9,8 @@ export const macroRule = ruleCreator({
   meta: {
     docs: {
       description: 'Enforces the use of the RxJS Tools Babel macro.',
-      recommended: false,
     },
     fixable: 'code',
-    hasSuggestions: false,
     messages: {
       macro: 'Use the RxJS Tools Babel macro.',
     },
diff --git a/src/rules/no-async-subscribe.ts b/src/rules/no-async-subscribe.ts
@@ -8,9 +8,8 @@ export const noAsyncSubscribeRule = ruleCreator({
     docs: {
       description: 'Forbids passing `async` functions to `subscribe`.',
       recommended: true,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Passing async functions to subscribe is forbidden.',
     },
diff --git a/src/rules/no-compat.ts b/src/rules/no-compat.ts
@@ -7,10 +7,7 @@ export const noCompatRule = ruleCreator({
     docs: {
       description:
         'Forbids importation from locations that depend upon `rxjs-compat`.',
-      recommended: false,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: '\'rxjs-compat\'-dependent import locations are forbidden.',
     },
diff --git a/src/rules/no-connectable.ts b/src/rules/no-connectable.ts
@@ -7,10 +7,8 @@ export const noConnectableRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids operators that return connectable observables.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Connectable observables are forbidden.',
     },
diff --git a/src/rules/no-create.ts b/src/rules/no-create.ts
@@ -8,9 +8,8 @@ export const noCreateRule = ruleCreator({
     docs: {
       description: 'Forbids the calling of `Observable.create`.',
       recommended: true,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Observable.create is forbidden; use new Observable.',
     },
diff --git a/src/rules/no-cyclic-action.ts b/src/rules/no-cyclic-action.ts
@@ -19,10 +19,8 @@ export const noCyclicActionRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids effects and epics that re-emit filtered actions.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden:
         'Effects and epics that re-emit filtered actions are forbidden.',
diff --git a/src/rules/no-explicit-generics.ts b/src/rules/no-explicit-generics.ts
@@ -7,10 +7,7 @@ export const noExplicitGenericsRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids explicit generic type arguments.',
-      recommended: false,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     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,10 +12,8 @@ export const noExposedSubjectsRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids exposed (i.e. non-private) subjects.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Subject \'{{subject}}\' must be private.',
       forbiddenAllowProtected:
diff --git a/src/rules/no-finnish.ts b/src/rules/no-finnish.ts
@@ -10,10 +10,8 @@ export const noFinnishRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids the use of Finnish notation.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Finnish notation is forbidden.',
     },
diff --git a/src/rules/no-ignored-error.ts b/src/rules/no-ignored-error.ts
@@ -8,10 +8,8 @@ export const noIgnoredErrorRule = ruleCreator({
     docs: {
       description:
         'Forbids the calling of `subscribe` without specifying an error handler.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Calling subscribe without an error handler is forbidden.',
     },
diff --git a/src/rules/no-ignored-notifier.ts b/src/rules/no-ignored-notifier.ts
@@ -13,9 +13,8 @@ export const noIgnoredNotifierRule = ruleCreator({
       description:
         'Forbids observables not composed from the `repeatWhen` or `retryWhen` notifier.',
       recommended: true,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Ignoring the notifier is forbidden.',
     },
diff --git a/src/rules/no-ignored-observable.ts b/src/rules/no-ignored-observable.ts
@@ -7,10 +7,8 @@ export const noIgnoredObservableRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids the ignoring of observables returned by functions.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Ignoring a returned Observable is forbidden.',
     },
diff --git a/src/rules/no-ignored-replay-buffer.ts b/src/rules/no-ignored-replay-buffer.ts
@@ -9,8 +9,6 @@ export const noIgnoredReplayBufferRule = ruleCreator({
         'Forbids using `ReplaySubject`, `publishReplay` or `shareReplay` without specifying the buffer size.',
       recommended: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Ignoring the buffer size is forbidden.',
     },
diff --git a/src/rules/no-ignored-subscribe.ts b/src/rules/no-ignored-subscribe.ts
@@ -8,10 +8,8 @@ export const noIgnoredSubscribeRule = ruleCreator({
     docs: {
       description:
         'Forbids the calling of `subscribe` without specifying arguments.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Calling subscribe without arguments is forbidden.',
     },
diff --git a/src/rules/no-ignored-subscription.ts b/src/rules/no-ignored-subscription.ts
@@ -7,10 +7,8 @@ export const noIgnoredSubscriptionRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids ignoring the subscription returned by `subscribe`.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Ignoring returned subscriptions is forbidden.',
     },
diff --git a/src/rules/no-ignored-takewhile-value.ts b/src/rules/no-ignored-takewhile-value.ts
@@ -14,8 +14,6 @@ export const noIgnoredTakewhileValueRule = ruleCreator({
       description: 'Forbids ignoring the value within `takeWhile`.',
       recommended: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     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
@@ -41,6 +41,7 @@ export const noImplicitAnyCatchRule = ruleCreator({
       description:
         'Forbids implicit `any` error parameters in `catchError` operators.',
       recommended: true,
+      requiresTypeChecking: true,
     },
     fixable: 'code',
     hasSuggestions: true,
diff --git a/src/rules/no-index.ts b/src/rules/no-index.ts
@@ -8,8 +8,6 @@ export const noIndexRule = ruleCreator({
       description: 'Forbids the importation from index modules.',
       recommended: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'RxJS imports from index modules are forbidden.',
     },
diff --git a/src/rules/no-nested-subscribe.ts b/src/rules/no-nested-subscribe.ts
@@ -9,9 +9,8 @@ export const noNestedSubscribeRule = ruleCreator({
       description:
         'Forbids the calling of `subscribe` within a `subscribe` callback.',
       recommended: true,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Nested subscribe calls are forbidden.',
     },
diff --git a/src/rules/no-redundant-notify.ts b/src/rules/no-redundant-notify.ts
@@ -19,9 +19,8 @@ export const noRedundantNotifyRule = ruleCreator({
       description:
         'Forbids redundant notifications from completed or errored observables.',
       recommended: true,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Redundant notifications are forbidden.',
     },
diff --git a/src/rules/no-sharereplay.ts b/src/rules/no-sharereplay.ts
@@ -12,8 +12,6 @@ export const noSharereplayRule = ruleCreator({
       description: 'Forbids using the `shareReplay` operator.',
       recommended: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'shareReplay is forbidden.',
       forbiddenWithoutConfig:
diff --git a/src/rules/no-subclass.ts b/src/rules/no-subclass.ts
@@ -7,10 +7,8 @@ export const noSubclassRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids subclassing RxJS classes.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Subclassing RxJS classes is forbidden.',
     },
diff --git a/src/rules/no-subject-unsubscribe.ts b/src/rules/no-subject-unsubscribe.ts
@@ -9,9 +9,8 @@ export const noSubjectUnsubscribeRule = ruleCreator({
       description:
         'Forbids calling the `unsubscribe` method of a subject instance.',
       recommended: true,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Calling unsubscribe on a subject is forbidden.',
     },
diff --git a/src/rules/no-subject-value.ts b/src/rules/no-subject-value.ts
@@ -8,10 +8,8 @@ export const noSubjectValueRule = ruleCreator({
     docs: {
       description:
         'Forbids accessing the `value` property of a `BehaviorSubject` instance.',
-      recommended: true,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden:
         'Accessing the value property of a BehaviorSubject is forbidden.',
diff --git a/src/rules/no-subscribe-handlers.ts b/src/rules/no-subscribe-handlers.ts
@@ -7,10 +7,8 @@ export const noSubscribeHandlersRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids the passing of handlers to `subscribe`.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Passing handlers to subscribe is forbidden.',
     },
diff --git a/src/rules/no-tap.ts b/src/rules/no-tap.ts
@@ -7,10 +7,7 @@ export const noTapRule = ruleCreator({
     deprecated: true,
     docs: {
       description: 'Forbids the use of the `tap` operator.',
-      recommended: false,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'The tap operator is forbidden.',
     },
diff --git a/src/rules/no-topromise.ts b/src/rules/no-topromise.ts
@@ -7,10 +7,8 @@ export const noTopromiseRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids the use of the `toPromise` method.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'The toPromise method is forbidden.',
     },
diff --git a/src/rules/no-unbound-methods.ts b/src/rules/no-unbound-methods.ts
@@ -11,9 +11,8 @@ export const noUnboundMethodsRule = ruleCreator({
     docs: {
       description: 'Forbids the passing of unbound methods.',
       recommended: true,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Unbound methods are forbidden.',
     },
diff --git a/src/rules/no-unsafe-catch.ts b/src/rules/no-unsafe-catch.ts
@@ -18,10 +18,8 @@ export const noUnsafeCatchRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids unsafe `catchError` usage in effects and epics.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Unsafe catchError usage in effects and epics are forbidden.',
     },
diff --git a/src/rules/no-unsafe-first.ts b/src/rules/no-unsafe-first.ts
@@ -13,10 +13,8 @@ export const noUnsafeFirstRule = ruleCreator({
   meta: {
     docs: {
       description: 'Forbids unsafe `first`/`take` usage in effects and epics.',
-      recommended: false,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden:
         'Unsafe first and take usage in effects and epics are forbidden.',
diff --git a/src/rules/no-unsafe-subject-next.ts b/src/rules/no-unsafe-subject-next.ts
@@ -13,9 +13,8 @@ export const noUnsafeSubjectNext = ruleCreator({
     docs: {
       description: 'Forbids unsafe optional `next` calls.',
       recommended: true,
+      requiresTypeChecking: true,
     },
-    fixable: undefined,
-    hasSuggestions: false,
     messages: {
       forbidden: 'Unsafe optional next calls are forbidden.',
     },
diff --git a/src/rules/no-unsafe-switchmap.ts b/src/rules/no-unsafe-switchmap.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/suffix-subjects.ts b/src/rules/suffix-subjects.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
