eslint-plugin-rxjs-x 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/README.md +57 -43
  2. package/dist/index.d.ts +1 -1
  3. package/dist/{index.cjs → index.js} +427 -342
  4. package/dist/index.mjs +422 -319
  5. package/docs/rules/ban-observables.md +3 -1
  6. package/docs/rules/ban-operators.md +3 -1
  7. package/docs/rules/finnish.md +21 -2
  8. package/docs/rules/just.md +5 -5
  9. package/docs/rules/macro.md +4 -4
  10. package/docs/rules/no-async-subscribe.md +7 -5
  11. package/docs/rules/no-compat.md +3 -5
  12. package/docs/rules/no-connectable.md +4 -4
  13. package/docs/rules/no-create.md +7 -5
  14. package/docs/rules/no-cyclic-action.md +14 -2
  15. package/docs/rules/no-explicit-generics.md +3 -5
  16. package/docs/rules/no-exposed-subjects.md +14 -2
  17. package/docs/rules/no-finnish.md +6 -6
  18. package/docs/rules/no-ignored-error.md +5 -5
  19. package/docs/rules/no-ignored-notifier.md +7 -5
  20. package/docs/rules/no-ignored-observable.md +5 -5
  21. package/docs/rules/no-ignored-replay-buffer.md +5 -5
  22. package/docs/rules/no-ignored-subscribe.md +5 -5
  23. package/docs/rules/no-ignored-subscription.md +5 -5
  24. package/docs/rules/no-ignored-takewhile-value.md +5 -5
  25. package/docs/rules/no-implicit-any-catch.md +18 -2
  26. package/docs/rules/no-index.md +5 -5
  27. package/docs/rules/no-internal.md +7 -5
  28. package/docs/rules/no-nested-subscribe.md +7 -5
  29. package/docs/rules/no-redundant-notify.md +7 -5
  30. package/docs/rules/no-sharereplay.md +14 -2
  31. package/docs/rules/no-subclass.md +4 -4
  32. package/docs/rules/no-subject-unsubscribe.md +7 -5
  33. package/docs/rules/no-subject-value.md +4 -4
  34. package/docs/rules/no-subscribe-handlers.md +5 -7
  35. package/docs/rules/no-tap.md +4 -4
  36. package/docs/rules/no-topromise.md +4 -4
  37. package/docs/rules/no-unbound-methods.md +7 -8
  38. package/docs/rules/no-unsafe-catch.md +13 -1
  39. package/docs/rules/no-unsafe-first.md +13 -1
  40. package/docs/rules/no-unsafe-subject-next.md +7 -5
  41. package/docs/rules/no-unsafe-switchmap.md +15 -1
  42. package/docs/rules/no-unsafe-takeuntil.md +16 -1
  43. package/docs/rules/prefer-observer.md +15 -1
  44. package/docs/rules/suffix-subjects.md +17 -1
  45. package/docs/rules/throw-error.md +5 -5
  46. package/package.json +16 -9
  47. package/dist/index.d.cts +0 -121
package/README.md CHANGED
@@ -36,10 +36,22 @@ export default tseslint.config({
36
36
  });
37
37
  ```
38
38
 
39
+ ## Configs
40
+
41
+ <!-- begin auto-generated configs list -->
42
+
43
+ | | Name |
44
+ | :- | :------------ |
45
+ | ✅ | `recommended` |
46
+
47
+ <!-- end auto-generated configs list -->
48
+
39
49
  ## Rules
40
50
 
41
51
  The package includes the following rules.
42
52
 
53
+ <!-- begin auto-generated rules list -->
54
+
43
55
  💼 Configurations enabled in.\
44
56
  ✅ Set in the `recommended` configuration.\
45
57
  🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
@@ -47,46 +59,48 @@ The package includes the following rules.
47
59
  💭 Requires [type information](https://typescript-eslint.io/linting/typed-linting).\
48
60
  ❌ Deprecated.
49
61
 
50
- | Name                       | Description | 💼 | 🔧 | 💡 | 💭 | ❌ |
51
- | :--------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------- | :- | :- | :- | :- | :- |
52
- | [ban-observables](docs/rules/ban-observables.md) | Forbids the use of banned observables. | | | | | |
53
- | [ban-operators](docs/rules/ban-operators.md) | Forbids the use of banned operators. | | | | | |
54
- | [finnish](docs/rules/finnish.md) | Enforces the use of Finnish notation. | | | | 💭 | |
55
- | [just](docs/rules/just.md) | Enforces the use of a `just` alias for `of`. | | 🔧 | | | |
56
- | [macro](docs/rules/macro.md) | Enforces the use of the RxJS Tools Babel macro. | | 🔧 | | | |
57
- | [no-async-subscribe](docs/rules/no-async-subscribe.md) | Forbids passing `async` functions to `subscribe`. | ✅ | | | 💭 | |
58
- | [no-compat](docs/rules/no-compat.md) | Forbids importation from locations that depend upon `rxjs-compat`. | | | | | |
59
- | [no-connectable](docs/rules/no-connectable.md) | Forbids operators that return connectable observables. | | | | 💭 | |
60
- | [no-create](docs/rules/no-create.md) | Forbids the calling of `Observable.create`. | ✅ | | | 💭 | |
61
- | [no-cyclic-action](docs/rules/no-cyclic-action.md) | Forbids effects and epics that re-emit filtered actions. | | | | 💭 | |
62
- | [no-explicit-generics](docs/rules/no-explicit-generics.md) | Forbids explicit generic type arguments. | | | | | |
63
- | [no-exposed-subjects](docs/rules/no-exposed-subjects.md) | Forbids exposed (i.e. non-private) subjects. | | | | 💭 | |
64
- | [no-finnish](docs/rules/no-finnish.md) | Forbids the use of Finnish notation. | | | | 💭 | |
65
- | [no-ignored-error](docs/rules/no-ignored-error.md) | Forbids the calling of `subscribe` without specifying an error handler. | | | | 💭 | |
66
- | [no-ignored-notifier](docs/rules/no-ignored-notifier.md) | Forbids observables not composed from the `repeatWhen` or `retryWhen` notifier. | ✅ | | | 💭 | |
67
- | [no-ignored-observable](docs/rules/no-ignored-observable.md) | Forbids the ignoring of observables returned by functions. | | | | 💭 | |
68
- | [no-ignored-replay-buffer](docs/rules/no-ignored-replay-buffer.md) | Forbids using `ReplaySubject`, `publishReplay` or `shareReplay` without specifying the buffer size. | ✅ | | | | |
69
- | [no-ignored-subscribe](docs/rules/no-ignored-subscribe.md) | Forbids the calling of `subscribe` without specifying arguments. | | | | 💭 | |
70
- | [no-ignored-subscription](docs/rules/no-ignored-subscription.md) | Forbids ignoring the subscription returned by `subscribe`. | | | | 💭 | |
71
- | [no-ignored-takewhile-value](docs/rules/no-ignored-takewhile-value.md) | Forbids ignoring the value within `takeWhile`. | ✅ | | | | |
72
- | [no-implicit-any-catch](docs/rules/no-implicit-any-catch.md) | Forbids implicit `any` error parameters in `catchError` operators. | ✅ | 🔧 | 💡 | 💭 | |
73
- | [no-index](docs/rules/no-index.md) | Forbids the importation from index modules. | ✅ | | | | |
74
- | [no-internal](docs/rules/no-internal.md) | Forbids the importation of internals. | ✅ | 🔧 | 💡 | | |
75
- | [no-nested-subscribe](docs/rules/no-nested-subscribe.md) | Forbids the calling of `subscribe` within a `subscribe` callback. | ✅ | | | 💭 | |
76
- | [no-redundant-notify](docs/rules/no-redundant-notify.md) | Forbids redundant notifications from completed or errored observables. | ✅ | | | 💭 | |
77
- | [no-sharereplay](docs/rules/no-sharereplay.md) | Forbids using the `shareReplay` operator. | ✅ | | | | |
78
- | [no-subclass](docs/rules/no-subclass.md) | Forbids subclassing RxJS classes. | | | | 💭 | |
79
- | [no-subject-unsubscribe](docs/rules/no-subject-unsubscribe.md) | Forbids calling the `unsubscribe` method of a subject instance. | ✅ | | | 💭 | |
80
- | [no-subject-value](docs/rules/no-subject-value.md) | Forbids accessing the `value` property of a `BehaviorSubject` instance. | | | | 💭 | |
81
- | [no-subscribe-handlers](docs/rules/no-subscribe-handlers.md) | Forbids the passing of handlers to `subscribe`. | | | | 💭 | |
82
- | [no-tap](docs/rules/no-tap.md) | Forbids the use of the `tap` operator. | | | | | ❌ |
83
- | [no-topromise](docs/rules/no-topromise.md) | Forbids the use of the `toPromise` method. | | | | 💭 | |
84
- | [no-unbound-methods](docs/rules/no-unbound-methods.md) | Forbids the passing of unbound methods. | ✅ | | | 💭 | |
85
- | [no-unsafe-catch](docs/rules/no-unsafe-catch.md) | Forbids unsafe `catchError` usage in effects and epics. | | | | 💭 | |
86
- | [no-unsafe-first](docs/rules/no-unsafe-first.md) | Forbids unsafe `first`/`take` usage in effects and epics. | | | | 💭 | |
87
- | [no-unsafe-subject-next](docs/rules/no-unsafe-subject-next.md) | Forbids unsafe optional `next` calls. | ✅ | | | 💭 | |
88
- | [no-unsafe-switchmap](docs/rules/no-unsafe-switchmap.md) | Forbids unsafe `switchMap` usage in effects and epics. | | | | 💭 | |
89
- | [no-unsafe-takeuntil](docs/rules/no-unsafe-takeuntil.md) | Forbids the application of operators after `takeUntil`. | ✅ | | | 💭 | |
90
- | [prefer-observer](docs/rules/prefer-observer.md) | Forbids the passing separate handlers to `subscribe` and `tap`. | | 🔧 | 💡 | 💭 | |
91
- | [suffix-subjects](docs/rules/suffix-subjects.md) | Enforces the use of a suffix in subject identifiers. | | | | 💭 | |
92
- | [throw-error](docs/rules/throw-error.md) | Enforces the passing of `Error` values to error notifications. | | | | 💭 | |
62
+ | Name                       | Description | 💼 | 🔧 | 💡 | 💭 | ❌ |
63
+ | :--------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | :- | :- | :- | :- | :- |
64
+ | [ban-observables](docs/rules/ban-observables.md) | Disallow banned observable creators. | | | | | |
65
+ | [ban-operators](docs/rules/ban-operators.md) | Disallow banned operators. | | | | | |
66
+ | [finnish](docs/rules/finnish.md) | Enforce Finnish notation. | | | | 💭 | |
67
+ | [just](docs/rules/just.md) | Require the use of `just` instead of `of`. | | 🔧 | | | |
68
+ | [macro](docs/rules/macro.md) | Require the use of the RxJS Tools Babel macro. | | 🔧 | | | |
69
+ | [no-async-subscribe](docs/rules/no-async-subscribe.md) | Disallow passing `async` functions to `subscribe`. | ✅ | | | 💭 | |
70
+ | [no-compat](docs/rules/no-compat.md) | Disallow the `rxjs-compat` package. | | | | | |
71
+ | [no-connectable](docs/rules/no-connectable.md) | Disallow operators that return connectable observables. | | | | 💭 | |
72
+ | [no-create](docs/rules/no-create.md) | Disallow the static `Observable.create` function. | ✅ | | | 💭 | |
73
+ | [no-cyclic-action](docs/rules/no-cyclic-action.md) | Disallow cyclic actions in effects and epics. | | | | 💭 | |
74
+ | [no-explicit-generics](docs/rules/no-explicit-generics.md) | Disallow unnecessary explicit generic type arguments. | | | | | |
75
+ | [no-exposed-subjects](docs/rules/no-exposed-subjects.md) | Disallow public and protected subjects. | | | | 💭 | |
76
+ | [no-finnish](docs/rules/no-finnish.md) | Disallow Finnish notation. | | | | 💭 | |
77
+ | [no-ignored-error](docs/rules/no-ignored-error.md) | Disallow calling `subscribe` without specifying an error handler. | | | | 💭 | |
78
+ | [no-ignored-notifier](docs/rules/no-ignored-notifier.md) | Disallow observables not composed from the `repeatWhen` or `retryWhen` notifier. | ✅ | | | 💭 | |
79
+ | [no-ignored-observable](docs/rules/no-ignored-observable.md) | Disallow ignoring observables returned by functions. | | | | 💭 | |
80
+ | [no-ignored-replay-buffer](docs/rules/no-ignored-replay-buffer.md) | Disallow using `ReplaySubject`, `publishReplay` or `shareReplay` without specifying the buffer size. | ✅ | | | | |
81
+ | [no-ignored-subscribe](docs/rules/no-ignored-subscribe.md) | Disallow calling `subscribe` without specifying arguments. | | | | 💭 | |
82
+ | [no-ignored-subscription](docs/rules/no-ignored-subscription.md) | Disallow ignoring the subscription returned by `subscribe`. | | | | 💭 | |
83
+ | [no-ignored-takewhile-value](docs/rules/no-ignored-takewhile-value.md) | Disallow ignoring the value within `takeWhile`. | ✅ | | | | |
84
+ | [no-implicit-any-catch](docs/rules/no-implicit-any-catch.md) | Disallow implicit `any` error parameters in `catchError` operators. | ✅ | 🔧 | 💡 | 💭 | |
85
+ | [no-index](docs/rules/no-index.md) | Disallow importing index modules. | ✅ | | | | |
86
+ | [no-internal](docs/rules/no-internal.md) | Disallow importing internal modules. | ✅ | 🔧 | 💡 | | |
87
+ | [no-nested-subscribe](docs/rules/no-nested-subscribe.md) | Disallow calling `subscribe` within a `subscribe` callback. | ✅ | | | 💭 | |
88
+ | [no-redundant-notify](docs/rules/no-redundant-notify.md) | Disallow sending redundant notifications from completed or errored observables. | ✅ | | | 💭 | |
89
+ | [no-sharereplay](docs/rules/no-sharereplay.md) | Disallow unsafe `shareReplay` usage. | ✅ | | | | |
90
+ | [no-subclass](docs/rules/no-subclass.md) | Disallow subclassing RxJS classes. | | | | 💭 | |
91
+ | [no-subject-unsubscribe](docs/rules/no-subject-unsubscribe.md) | Disallow calling the `unsubscribe` method of subjects. | ✅ | | | 💭 | |
92
+ | [no-subject-value](docs/rules/no-subject-value.md) | Disallow accessing the `value` property of a `BehaviorSubject` instance. | | | | 💭 | |
93
+ | [no-subscribe-handlers](docs/rules/no-subscribe-handlers.md) | Disallow passing handlers to `subscribe`. | | | | 💭 | |
94
+ | [no-tap](docs/rules/no-tap.md) | Disallow the `tap` operator. | | | | | ❌ |
95
+ | [no-topromise](docs/rules/no-topromise.md) | Disallow use of the `toPromise` method. | | | | 💭 | |
96
+ | [no-unbound-methods](docs/rules/no-unbound-methods.md) | Disallow passing unbound methods. | ✅ | | | 💭 | |
97
+ | [no-unsafe-catch](docs/rules/no-unsafe-catch.md) | Disallow unsafe `catchError` usage in effects and epics. | | | | 💭 | |
98
+ | [no-unsafe-first](docs/rules/no-unsafe-first.md) | Disallow unsafe `first`/`take` usage in effects and epics. | | | | 💭 | |
99
+ | [no-unsafe-subject-next](docs/rules/no-unsafe-subject-next.md) | Disallow unsafe optional `next` calls. | ✅ | | | 💭 | |
100
+ | [no-unsafe-switchmap](docs/rules/no-unsafe-switchmap.md) | Disallow unsafe `switchMap` usage in effects and epics. | | | | 💭 | |
101
+ | [no-unsafe-takeuntil](docs/rules/no-unsafe-takeuntil.md) | Disallow applying operators after `takeUntil`. | ✅ | | | 💭 | |
102
+ | [prefer-observer](docs/rules/prefer-observer.md) | Disallow passing separate handlers to `subscribe` and `tap`. | | 🔧 | 💡 | 💭 | |
103
+ | [suffix-subjects](docs/rules/suffix-subjects.md) | Enforce the use of a suffix in subject identifiers. | | | | 💭 | |
104
+ | [throw-error](docs/rules/throw-error.md) | Enforce passing only `Error` values to error notifications. | | | | 💭 | |
105
+
106
+ <!-- end auto-generated rules list -->
package/dist/index.d.ts CHANGED
@@ -118,4 +118,4 @@ declare const rxjsX: {
118
118
  };
119
119
  };
120
120
 
121
- export { rxjsX as default };
121
+ export = rxjsX;