eslint-plugin-rxjs-x 0.7.0 → 0.7.2

package/docs/rules/no-unsafe-first.md

@@ -1,40 +0,0 @@
-# Disallow unsafe `first`/`take` usage in effects and epics (`rxjs-x/no-unsafe-first`)
-
-💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
-
-<!-- end auto-generated rule header -->
-
-This rule effects failures if `first` is used in an effect or epic in a manner that will complete the outermost observable.
-
-## Options
-
-<!-- begin auto-generated rule options list -->
-
-| Name         | Description                                                   | Type   | Default                  |
-| :----------- | :------------------------------------------------------------ | :----- | :----------------------- |
-| `observable` | A RegExp that matches an effect or epic's actions observable. | String | `[Aa]ction(s\|s\$\|\$)$` |
-
-<!-- end auto-generated rule options list -->
-
-This rule accepts a single option which is an object with an `observable` property that is a regular expression used to match an effect or epic's actions observable. The default `observable` regular expression should match most effect and epic action sources.
-
-```json
-{
-  "rxjs-x/no-unsafe-first": [
-    "error",
-    { "observable": "[Aa]ction(s|s\\$|\\$)$" }
-  ]
-}
-```
-
-## When Not To Use It
-
-If you don't use a library with effects and epics (e.g. NgRx or redux-observable),
-then you don't need this rule.
-
-Type checked lint rules are more powerful than traditional lint rules, but also require configuring type checked linting.
-
-## Resources
-
-- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/no-unsafe-first.ts)
-- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/no-unsafe-first.test.ts)

package/docs/rules/no-unsafe-subject-next.md

@@ -1,46 +0,0 @@
-# Disallow unsafe optional `next` calls (`rxjs-x/no-unsafe-subject-next`)
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
-
-💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
-
-<!-- end auto-generated rule header -->
-
-This rule effects failures if `next` is called without an argument and the subject's value type is not `void`.
-
-In RxJS version 6, the `next` method's `value` parameter was optional, but a value should always be specified for subjects with non-`void` element types.
-RxJS version 7 changed the `value` parameter to mandatory.
-
-## Rule details
-
-Examples of **incorrect** code for this rule:
-
-```ts
-const subject = new Subject<number>();
-subject.next();
-```
-
-Examples of **correct** code for this rule:
-
-```ts
-const subject = new Subject<void>();
-subject.next();
-```
-
-```ts
-const subject = new Subject<number>();
-subject.next(0);
-```
-
-## When Not To Use It
-
-If you don't care about sending `undefined` to subjects, then you don't need this rule.
-Alternatively, you may rely on TypeScript to enforce the `value` parameter,
-which was made mandatory in RxJS version 7.
-
-Type checked lint rules are more powerful than traditional lint rules, but also require configuring type checked linting.
-
-## Resources
-
-- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/no-unsafe-subject-next.ts)
-- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/no-unsafe-subject-next.test.ts)

package/docs/rules/no-unsafe-switchmap.md

@@ -1,64 +0,0 @@
-# Disallow unsafe `switchMap` usage in effects and epics (`rxjs-x/no-unsafe-switchmap`)
-
-💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
-
-<!-- end auto-generated rule header -->
-
-This rule effects failures if `switchMap` is used in effects or epics that perform actions other than reads. For a detailed explanation, see the blog post linked below.
-
-## Options
-
-<!-- begin auto-generated rule options list -->
-
-| Name         | Description                                                                                  | Type   | Default                  |
-| :----------- | :------------------------------------------------------------------------------------------- | :----- | :----------------------- |
-| `allow`      | Action types that are allowed to be used with switchMap. Mutually exclusive with `disallow`. |        |                          |
-| `disallow`   | Action types that are disallowed to be used with switchMap. Mutually exclusive with `allow`. |        |                          |
-| `observable` | A RegExp that matches an effect or epic's actions observable.                                | String | `[Aa]ction(s\|s\$\|\$)$` |
-
-<!-- end auto-generated rule options list -->
-
-This rule accepts a single option which is an object with `allow`, `disallow` and `observable` properties.
-
-The `observable` property is a regular expression used to match an effect or epic's actions observable. The default `observable` regular expression should match most effect and epic action sources.
-
-The `allow` or `disallow` properties are mutually exclusive. Whether or not `switchMap` is allowed will depend upon the matching of action types with `allow` or `disallow`. The properties can be specified as regular expression strings or as arrays of words.
-
-```json
-{
-  "rxjs-x/no-unsafe-switchmap": [
-    "error",
-    {
-      "disallow": [
-        "add",
-        "create",
-        "delete",
-        "post",
-        "put",
-        "remove",
-        "set",
-        "update"
-      ],
-      "observable": "[Aa]ction(s|s\\$|\\$)$"
-    }
-  ]
-}
-```
-
-The properties in the options object are themselves optional; they do not all have to be specified.
-
-## When Not To Use It
-
-If you don't use a library with effects and epics (e.g. NgRx or redux-observable),
-then you don't need this rule.
-
-Type checked lint rules are more powerful than traditional lint rules, but also require configuring type checked linting.
-
-## Further reading
-
-- [Avoiding switchMap-related bugs](https://ncjamieson.com/avoiding-switchmap-related-bugs/)
-
-## Resources
-
-- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/no-unsafe-switchmap.ts)
-- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/no-unsafe-switchmap.test.ts)

package/docs/rules/no-unsafe-takeuntil.md

@@ -1,72 +0,0 @@
-# Disallow applying operators after `takeUntil` (`rxjs-x/no-unsafe-takeuntil`)
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
-
-💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
-
-<!-- end auto-generated rule header -->
-
-This rule effects failures whenever `takeUntil` is used in observable compositions that can leak subscriptions.
-
-Although it's recommended that `takeUntil` be placed last - to ensure unsubscription from any inner observables - there are a number of operators that might _need_ to be placed after it - like `toArray` or any other operator that depends upon a `complete` notification. The rule is aware of these operators (see the rule's options, below) and will not effect failures if they are placed after `takeUntil`.
-
-## Rule details
-
-Examples of **incorrect** code for this rule:
-
-```ts
-const combined = source
-    .pipe(takeUntil(notifier), combineLatest(b))
-    .subscribe((value) => console.log(value));
-```
-
-Examples of **correct** code for this rule:
-
-```ts
-const combined = source
-    .pipe(combineLatest(b), takeUntil(notifier))
-    .subscribe((value) => console.log(value));
-```
-
-## Options
-
-<!-- begin auto-generated rule options list -->
-
-| Name    | Description                                                                 | Type     | Default                                                                                                                                                                                                                                                    |
-| :------ | :-------------------------------------------------------------------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `alias` | An array of operator names that should be treated similarly to `takeUntil`. | String[] |                                                                                                                                                                                                                                                            |
-| `allow` | An array of operator names that are allowed to follow `takeUntil`.          | String[] | [`count`, `defaultIfEmpty`, `endWith`, `every`, `finalize`, `finally`, `isEmpty`, `last`, `max`, `min`, `publish`, `publishBehavior`, `publishLast`, `publishReplay`, `reduce`, `share`, `shareReplay`, `skipLast`, `takeLast`, `throwIfEmpty`, `toArray`] |
-
-<!-- end auto-generated rule options list -->
-
-This rule accepts a single option which is an object with `alias` and `allow` properties. The `alias` property is an array of names of operators that should be treated similarly to `takeUntil` and the `allow` property is an array of names of operators that are safe to use after `takeUntil`.
-
-By default, the `allow` property contains all of the built-in operators that are safe to use after `takeUntil`.
-
-```json
-{
-    "rxjs-x/no-unsafe-takeuntil": [
-        "error",
-        {
-            "alias": ["untilDestroyed"]
-        }
-    ]
-}
-```
-
-The properties in the options object are themselves optional; they do not all have to be specified.
-
-## When Not To Use It
-
-If you are confident your project uses `takeUntil` correctly, then you may not need this rule.
-
-Type checked lint rules are more powerful than traditional lint rules, but also require configuring type checked linting.
-
-## Further reading
-
-- [Avoiding takeUntil leaks](https://ncjamieson.com/avoiding-takeuntil-leaks/)
-
-## Resources
-
-- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/no-unsafe-takeuntil.ts)
-- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/no-unsafe-takeuntil.test.ts)

package/docs/rules/prefer-observer.md

@@ -1,66 +0,0 @@
-# Disallow passing separate handlers to `subscribe` and `tap` (`rxjs-x/prefer-observer`)
-
-💼 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).
-
-💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
-
-<!-- end auto-generated rule header -->
-
-This rule effects failures if `subscribe` - or `tap` - is called with separate handlers instead of an observer.
-
-## Rule details
-
-Examples of **incorrect** code for this rule:
-
-```ts
-import { of } from "rxjs";
-of(42, 54).subscribe((value) => console.log(value));
-```
-
-Examples of **correct** code for this rule:
-
-```ts
-import { of } from "rxjs";
-of(42, 54).subscribe({
-  next: (value) => console.log(value)
-});
-```
-
-## Options
-
-<!-- begin auto-generated rule options list -->
-
-| Name        | Description                      | Type    | Default |
-| :---------- | :------------------------------- | :------ | :------ |
-| `allowNext` | Allows a single `next` callback. | Boolean | `true`  |
-
-<!-- end auto-generated rule options list -->
-
-This rule accepts a single option which is an object with an `allowNext` property that determines whether a single `next` callback is allowed. By default, `allowNext` is `true`.
-
-```json
-{
-  "rxjs-x/prefer-observer": [
-    "error",
-    { "allowNext": false }
-  ]
-}
-```
-
-## When Not To Use It
-
-If you rely on RxJS's deprecation of separate handlers and don't need to double-flag usage,
-then you don't need this rule.
-
-Type checked lint rules are more powerful than traditional lint rules, but also require configuring type checked linting.
-
-## Further reading
-
-- [Subscribe Arguments](https://rxjs.dev/deprecations/subscribe-arguments)
-
-## Resources
-
-- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/prefer-observer.ts)
-- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/prefer-observer.test.ts)

package/docs/rules/prefer-root-operators.md

@@ -1,45 +0,0 @@
-# Disallow importing operators from `rxjs/operators` (`rxjs-x/prefer-root-operators`)
-
-💼 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).
-
-<!-- end auto-generated rule header -->
-
-This rule prevents importing from the `rxjs/operators` export site.
-Most operators were moved to the `rxjs` export site in RxJS v7.2.0
-(excepting a few old and deprecated operators).
-The `rxjs/operators` export site has since been deprecated and will be removed in a future major version.
-
-Note that because a few operators were renamed or not migrated to the `rxjs` export site,
-this rule may not provide an automatic fixer if renaming the import path is not guaranteed to be safe.
-See the documentation linked below.
-
-## Rule details
-
-Examples of **incorrect** code for this rule:
-
-```ts
-import { map } from 'rxjs/operators';
-```
-
-Examples of **correct** code for this rule:
-
-```ts
-import { map } from 'rxjs';
-```
-
-## When Not To Use It
-
-If you don't care about importing from the deprecated site, then you don't need this rule.
-
-Type checked lint rules are more powerful than traditional lint rules, but also require configuring type checked linting.
-
-## Further reading
-
-- [Importing instructions](https://rxjs.dev/guide/importing)
-
-## Resources
-
-- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/prefer-root-operators.ts)
-- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/prefer-root-operators.test.ts)

package/docs/rules/suffix-subjects.md

@@ -1,81 +0,0 @@
-# Enforce the use of a suffix in subject identifiers (`rxjs-x/suffix-subjects`)
-
-💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
-
-<!-- end auto-generated rule header -->
-
-This rule effects failures if subject variables, properties and parameters don't conform to a naming scheme that identifies them as subjects.
-
-> [!NOTE]
-> This rule is designed to be optionally compatible with [`finnish`](./finnish.md).
-> Using Finnish notation (adding a `$` suffix) your subject names will _not_ cause a failure of this rule.
-
-## Rule details
-
-Examples of **incorrect** code for this rule:
-
-```ts
-const answers = new Subject<number>();
-```
-
-Examples of **correct** code for this rule:
-
-```ts
-const answersSubject = new Subject<number>();
-const answersSubject$ = new Subject<number>();
-```
-
-## Options
-
-<!-- begin auto-generated rule options list -->
-
-| Name         | Description                                                          | Type    |
-| :----------- | :------------------------------------------------------------------- | :------ |
-| `parameters` | Require for parameters.                                              | Boolean |
-| `properties` | Require for properties.                                              | Boolean |
-| `suffix`     | The suffix to enforce.                                               | String  |
-| `types`      | Enforce for specific types. Keys are a RegExp, values are a boolean. | Object  |
-| `variables`  | Require for variables.                                               | Boolean |
-
-<!-- end auto-generated rule options list -->
-
-This rule accepts a single option which is an object with properties that determine whether subject suffixes are enforced for `parameters`, `properties` and `variables`.
-It also contains a `types` property that determine whether or not the naming convention is to be enforced for specific types
-and a `suffix` property.
-
-The default (Angular-friendly) configuration looks like this:
-
-```json
-{
-  "rxjs-x/suffix-subjects": [
-    "error",
-    {
-      "parameters": true,
-      "properties": true,
-      "suffix": "Subject",
-      "types": {
-        "^EventEmitter$": false
-      },
-      "variables": true,
-    }
-  ]
-}
-```
-
-The properties in the options object are themselves optional; they do not all have to be specified.
-
-## When Not To Use It
-
-If you don't use suffixes on your project's subjects, then you don't need this rule.
-However, keep in mind that inconsistent style can harm readability in a project.
-
-Type checked lint rules are more powerful than traditional lint rules, but also require configuring type checked linting.
-
-## Related To
-
-- [`finnish`](./finnish.md)
-
-## Resources
-
-- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/suffix-subjects.ts)
-- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/suffix-subjects.test.ts)

package/docs/rules/throw-error.md

@@ -1,53 +0,0 @@
-# Enforce passing only `Error` values to `throwError` (`rxjs-x/throw-error`)
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
-
-💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
-
-<!-- end auto-generated rule header -->
-
-This rule forbids passing values that are not `Error` objects to `throwError`.
-It's similar to the typescript-eslint [`only-throw-error`](https://typescript-eslint.io/rules/only-throw-error/) rule,
-but is for the `throwError` Observable creation function - not `throw` statements.
-
-## Rule details
-
-Examples of **incorrect** code for this rule:
-
-```ts
-import { throwError } from "rxjs";
-
-throwError(() => "Kaboom!");
-```
-
-Examples of **correct** code for this rule:
-
-```ts
-import { throwError } from "rxjs";
-
-throwError(() => new Error("Kaboom!"));
-```
-
-## Options
-
-<!-- begin auto-generated rule options list -->
-
-| Name                   | Description                                                 | Type    | Default |
-| :--------------------- | :---------------------------------------------------------- | :------ | :------ |
-| `allowThrowingAny`     | Whether to always allow throwing values typed as `any`.     | Boolean | `true`  |
-| `allowThrowingUnknown` | Whether to always allow throwing values typed as `unknown`. | Boolean | `true`  |
-
-<!-- end auto-generated rule options list -->
-
-## When Not To Use It
-
-If you don't care about throwing values that are not `Error` objects, then you don't need this rule.
-However, keep in mind that, while JavaScript _allows_ throwing any value,
-most developer may find this behavior surprising or inconvenient to handle.
-
-Type checked lint rules are more powerful than traditional lint rules, but also require configuring type checked linting.
-
-## Resources
-
-- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/throw-error.ts)
-- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/throw-error.test.ts)