eslint-plugin-typefest 1.0.3 → 1.0.5

package/docs/rules/prefer-type-fest-optional.md

@@ -0,0 +1,104 @@
+# prefer-type-fest-optional
+
+Require TypeFest [`Optional<Value>`](https://github.com/sindresorhus/type-fest/blob/main/source/optional.d.ts) over `Exclude<T, null> | undefined` and `NonNullable<T> | undefined` patterns.
+
+## Targeted pattern scope
+
+This rule targets optional-value patterns that normalize `null` away and add `undefined`.
+
+## What this rule reports
+
+- `Exclude<T, null> | undefined`
+- `Exclude<T, null | undefined> | undefined`
+- `NonNullable<T> | undefined`
+
+## Why this rule exists
+
+`Optional<Value>` is the canonical TypeFest helper for “value or `undefined`, but never `null`”. Using it makes the intent obvious and standardizes on the new TypeFest utility.
+
+## ❌ Incorrect
+
+```ts
+type MaybeName = Exclude<string | null, null> | undefined;
+```
+
+## ✅ Correct
+
+```ts
+import type { Optional } from "type-fest";
+
+type MaybeName = Optional<string | null>;
+```
+
+## Behavior and migration notes
+
+- This rule only targets explicit null-stripping plus `undefined` patterns.
+- It does not report plain `T | undefined` unions.
+- It will not autofix when `Optional` is shadowed in the local type scope.
+
+## Additional examples
+
+### ❌ Incorrect — Additional example
+
+```ts
+type MaybeRegion = NonNullable<string | null> | undefined;
+```
+
+### ✅ Correct — Additional example
+
+```ts
+import type { Optional } from "type-fest";
+
+type MaybeRegion = Optional<string | null>;
+```
+
+### ✅ Correct — Non-targeted usage
+
+```ts
+type MaybeRegion = string | undefined;
+```
+
+## ESLint flat config example
+
+```ts
+import typefest from "eslint-plugin-typefest";
+
+export default [
+    {
+        plugins: { typefest },
+        rules: {
+            "typefest/prefer-type-fest-optional": "error",
+        },
+    },
+];
+```
+
+## When not to use it
+
+Disable this rule if your codebase intentionally prefers native utility combinations over the TypeFest helper name.
+
+## Package documentation
+
+TypeFest package documentation:
+
+Source file: [`source/optional.d.ts`](https://github.com/sindresorhus/type-fest/blob/main/source/optional.d.ts)
+
+```ts
+/**
+Create a type that represents either the value or `undefined`, while stripping `null` from the type.
+*/
+export type Optional<Value> = Exclude<Value, null> | undefined;
+```
+
+> **Rule catalog ID:** R079
+
+## Further reading
+
+- [`type-fest` README](https://github.com/sindresorhus/type-fest)
+- [`type-fest` npm documentation](https://www.npmjs.com/package/type-fest)
+- [TypeScript Handbook: Utility Types](https://www.typescriptlang.org/docs/handbook/utility-types.html)
+
+## Adoption resources
+
+- [Rule adoption checklist](./guides/adoption-checklist.md)
+- [Rollout and fix safety](./guides/rollout-and-fix-safety.md)

package/docs/rules/prefer-type-fest-or-all.md

@@ -0,0 +1,111 @@
+# prefer-type-fest-or-all
+
+Require TypeFest [`OrAll<TTuple>`](https://github.com/sindresorhus/type-fest/blob/main/source/or-all.d.ts) over `SomeExtend<TTuple, true>` boolean-tuple checks.
+
+## Targeted pattern scope
+
+This rule targets direct and namespace-qualified references to `SomeExtend<TTuple, true>` imported from `type-fest`.
+
+## What this rule reports
+
+- `SomeExtend<TTuple, true>` when it is being used as a boolean-tuple disjunction check.
+
+## Why this rule exists
+
+`OrAll` is the dedicated TypeFest helper for checking whether any boolean tuple member is `true`. It is shorter, clearer, and matches the new canonical TypeFest naming.
+
+## ❌ Incorrect
+
+```ts
+import type { SomeExtend } from "type-fest";
+
+type AnyFlagsTrue = SomeExtend<[false, false, true], true>;
+```
+
+## ✅ Correct
+
+```ts
+import type { OrAll } from "type-fest";
+
+type AnyFlagsTrue = OrAll<[false, false, true]>;
+```
+
+## Behavior and migration notes
+
+- This rule only targets `SomeExtend<TTuple, true>`.
+- It does not report `SomeExtend<TTuple, SomeOtherType>` usages.
+- Namespace-qualified `type-fest` references are reported too.
+
+## Additional examples
+
+### ❌ Incorrect — Additional example
+
+```ts
+import type * as TypeFest from "type-fest";
+
+type Ready = TypeFest.SomeExtend<[false, false, true], true>;
+```
+
+### ✅ Correct — Additional example
+
+```ts
+import type { OrAll } from "type-fest";
+
+type Ready = OrAll<[false, false, true]>;
+```
+
+### ✅ Correct — Non-targeted usage
+
+```ts
+import type { SomeExtend } from "type-fest";
+
+type AnyStrings = SomeExtend<[1, "x", true], string>;
+```
+
+## ESLint flat config example
+
+```ts
+import typefest from "eslint-plugin-typefest";
+
+export default [
+    {
+        plugins: { typefest },
+        rules: {
+            "typefest/prefer-type-fest-or-all": "error",
+        },
+    },
+];
+```
+
+## When not to use it
+
+Disable this rule if your codebase intentionally prefers the more general `SomeExtend<TTuple, true>` spelling for boolean tuple checks.
+
+## Package documentation
+
+TypeFest package documentation:
+
+Source file: [`source/or-all.d.ts`](https://github.com/sindresorhus/type-fest/blob/main/source/or-all.d.ts)
+
+```ts
+/**
+Returns a boolean for whether any of the given elements is `true`.
+
+Use-cases:
+- Check if at least one condition in a list of booleans is met.
+*/
+export type OrAll<T extends readonly boolean[]> = SomeExtend<T, true>;
+```
+
+> **Rule catalog ID:** R080
+
+## Further reading
+
+- [`type-fest` README](https://github.com/sindresorhus/type-fest)
+- [`type-fest` npm documentation](https://www.npmjs.com/package/type-fest)
+- [TypeScript Handbook: Conditional Types](https://www.typescriptlang.org/docs/handbook/2/conditional-types.html)
+
+## Adoption resources
+
+- [Rule adoption checklist](./guides/adoption-checklist.md)
+- [Rollout and fix safety](./guides/rollout-and-fix-safety.md)

package/docs/rules/prefer-type-fest-union-member.md

@@ -0,0 +1,119 @@
+# prefer-type-fest-union-member
+
+Require TypeFest [`UnionMember<T>`](https://github.com/sindresorhus/type-fest/blob/main/source/union-member.d.ts) over custom union-member extraction helpers based on `UnionToIntersection`.
+
+## Targeted pattern scope
+
+This rule targets exact custom helper definitions that reproduce TypeFest `UnionMember<T>` semantics with `UnionToIntersection`, distributive function wrappers, and the optional `IsNever<T>` guard.
+
+## What this rule reports
+
+- `UnionToIntersection<T extends any ? () => T : never> extends () => infer R ? R : never`
+- The guarded variant `IsNever<T> extends true ? never : ...`
+
+## Why this rule exists
+
+`UnionMember<T>` is the canonical TypeFest helper for extracting an arbitrary union member. Using it avoids re-declaring a brittle conditional-type helper and standardizes on the TypeFest utility name.
+
+## ❌ Incorrect
+
+```ts
+type LastOfUnion<Union> = IsNever<Union> extends true
+    ? never
+    : UnionToIntersection<Union extends any ? () => Union : never> extends () => infer Last
+      ? Last
+      : never;
+```
+
+## ✅ Correct
+
+```ts
+import type { UnionMember } from "type-fest";
+
+type LastOfUnion<Union> = UnionMember<Union>;
+```
+
+## Behavior and migration notes
+
+- This rule intentionally matches only exact, high-confidence helper shapes.
+- Similar custom helpers that differ structurally are ignored.
+- It will not autofix when `UnionMember` is shadowed in the local type scope.
+
+## Additional examples
+
+### ❌ Incorrect — Additional example
+
+```ts
+type MemberOfUnion<Union> = UnionToIntersection<Union extends any ? () => Union : never> extends () => infer Member
+    ? Member
+    : never;
+```
+
+### ✅ Correct — Additional example
+
+```ts
+import type { UnionMember } from "type-fest";
+
+type MemberOfUnion<Union> = UnionMember<Union>;
+```
+
+### ✅ Correct — Non-targeted usage
+
+```ts
+type LastOfUnion<Union> = UnionToIntersection<Union extends unknown ? () => Union : never> extends () => infer Last
+    ? Last
+    : never;
+```
+
+## ESLint flat config example
+
+```ts
+import typefest from "eslint-plugin-typefest";
+
+export default [
+    {
+        plugins: { typefest },
+        rules: {
+            "typefest/prefer-type-fest-union-member": "error",
+        },
+    },
+];
+```
+
+## When not to use it
+
+Disable this rule if your project intentionally keeps local helper names for compatibility or if your custom helper intentionally differs from TypeFest `UnionMember<T>` semantics.
+
+## Package documentation
+
+TypeFest package documentation:
+
+Source file: [`source/union-member.d.ts`](https://github.com/sindresorhus/type-fest/blob/main/source/union-member.d.ts)
+
+```ts
+/**
+Returns an arbitrary member of a union type.
+
+Use-cases:
+- Implementing recursive type functions that accept a union type.
+*/
+export type UnionMember<T> =
+    IsNever<T> extends true
+        ? never
+        : UnionToIntersection<T extends any ? () => T : never> extends () => (infer R)
+            ? R
+            : never;
+```
+
+> **Rule catalog ID:** R081
+
+## Further reading
+
+- [`type-fest` README](https://github.com/sindresorhus/type-fest)
+- [`type-fest` npm documentation](https://www.npmjs.com/package/type-fest)
+- [TypeScript Handbook: Conditional Types](https://www.typescriptlang.org/docs/handbook/2/conditional-types.html)
+
+## Adoption resources
+
+- [Rule adoption checklist](./guides/adoption-checklist.md)
+- [Rollout and fix safety](./guides/rollout-and-fix-safety.md)

package/docs/rules/prefer-type-fest-union-to-tuple.md

@@ -0,0 +1,108 @@
+# prefer-type-fest-union-to-tuple
+
+Require TypeFest [`UnionToTuple<T>`](https://github.com/sindresorhus/type-fest/blob/main/source/union-to-tuple.d.ts) over legacy union-to-tuple aliases.
+
+## Targeted pattern scope
+
+This rule targets imported alias names that represent union-to-tuple conversion semantics (for example, `TuplifyUnion` and `TupleFromUnion`).
+
+## What this rule reports
+
+- Type references that resolve to imported union-to-tuple aliases.
+
+## Why this rule exists
+
+`UnionToTuple` is TypeFest’s canonical helper for converting unions to tuple forms. Using one canonical helper improves readability and migration consistency.
+
+## ❌ Incorrect
+
+```ts
+import type { TuplifyUnion } from "type-aliases";
+
+type KeysTuple = TuplifyUnion<"a" | "b" | "c">;
+```
+
+## ✅ Correct
+
+```ts
+import type { UnionToTuple } from "type-fest";
+
+type KeysTuple = UnionToTuple<"a" | "b" | "c">;
+```
+
+## Behavior and migration notes
+
+- `UnionToTuple<T>` converts union members into an unordered tuple.
+- This rule only targets known alias names with equivalent intent.
+- Keep custom aliases only when they intentionally provide additional behavior.
+
+## Additional examples
+
+### ❌ Incorrect — Additional example
+
+```ts
+import type { TupleFromUnion } from "type-aliases";
+
+type NumericTuple = TupleFromUnion<1 | 2 | 3>;
+```
+
+### ✅ Correct — Additional example
+
+```ts
+import type { UnionToTuple } from "type-fest";
+
+type NumericTuple = UnionToTuple<1 | 2 | 3>;
+```
+
+### ✅ Correct — Repository-wide usage
+
+```ts
+type AllowedTuple = UnionToTuple<AllowedValue>;
+```
+
+## ESLint flat config example
+
+```ts
+import typefest from "eslint-plugin-typefest";
+
+export default [
+    {
+        plugins: { typefest },
+        rules: {
+            "typefest/prefer-type-fest-union-to-tuple": "error",
+        },
+    },
+];
+```
+
+## When not to use it
+
+Disable this rule if compatibility requirements mandate custom alias names.
+
+## Package documentation
+
+TypeFest package documentation:
+
+Source file: [`source/union-to-tuple.d.ts`](https://github.com/sindresorhus/type-fest/blob/main/source/union-to-tuple.d.ts)
+
+```ts
+/**
+Convert a union type into an unordered tuple type of its elements.
+
+@category Array
+*/
+export type UnionToTuple<T, L = UnionMember<T>> = ...
+```
+
+> **Rule catalog ID:** R083
+
+## Further reading
+
+- [`type-fest` README](https://github.com/sindresorhus/type-fest)
+- [`type-fest` npm documentation](https://www.npmjs.com/package/type-fest)
+- [TypeScript Handbook: Unions and Intersection Types](https://www.typescriptlang.org/docs/handbook/unions-and-intersections.html)
+
+## Adoption resources
+
+- [Rule adoption checklist](./guides/adoption-checklist.md)
+- [Rollout and fix safety](./guides/rollout-and-fix-safety.md)

package/docs/rules/presets/all.md

@@ -64,9 +64,12 @@ export default [typefest.configs.all];
 | [`prefer-ts-extras-set-has`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-ts-extras-set-has) | 🔧 💡 |
 | [`prefer-ts-extras-string-split`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-ts-extras-string-split) | 🔧 |
 | [`prefer-type-fest-abstract-constructor`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-abstract-constructor) | 🔧 |
+| [`prefer-type-fest-and-all`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-and-all) | 🔧 |
+| [`prefer-type-fest-array-length`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-array-length) | 🔧 |
 | [`prefer-type-fest-arrayable`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-arrayable) | 🔧 |
 | [`prefer-type-fest-async-return-type`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-async-return-type) | 🔧 |
 | [`prefer-type-fest-conditional-pick`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-conditional-pick) | 🔧 |
+| [`prefer-type-fest-conditional-pick-deep`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-conditional-pick-deep) | 🔧 |
 | [`prefer-type-fest-constructor`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-constructor) | 🔧 |
 | [`prefer-type-fest-except`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-except) | 🔧 |
 | [`prefer-type-fest-if`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-if) | 🔧 |
@@ -76,10 +79,14 @@ export default [typefest.configs.all];
 | [`prefer-type-fest-json-primitive`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-json-primitive) | 🔧 |
 | [`prefer-type-fest-json-value`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-json-value) | 💡 |
 | [`prefer-type-fest-keys-of-union`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-keys-of-union) | 🔧 |
+| [`prefer-type-fest-less-than`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-less-than) | 🔧 |
+| [`prefer-type-fest-less-than-or-equal`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-less-than-or-equal) | 🔧 |
 | [`prefer-type-fest-literal-union`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-literal-union) | 🔧 |
 | [`prefer-type-fest-merge-exclusive`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-merge-exclusive) | 🔧 |
 | [`prefer-type-fest-non-empty-tuple`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-non-empty-tuple) | 🔧 |
 | [`prefer-type-fest-omit-index-signature`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-omit-index-signature) | 🔧 |
+| [`prefer-type-fest-optional`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-optional) | 🔧 |
+| [`prefer-type-fest-or-all`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-or-all) | 🔧 |
 | [`prefer-type-fest-partial-deep`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-partial-deep) | 🔧 |
 | [`prefer-type-fest-primitive`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-primitive) | 🔧 |
 | [`prefer-type-fest-promisable`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-promisable) | 🔧 |
@@ -97,6 +104,8 @@ export default [typefest.configs.all];
 | [`prefer-type-fest-simplify`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-simplify) | 🔧 |
 | [`prefer-type-fest-tagged-brands`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-tagged-brands) | 🔧 |
 | [`prefer-type-fest-tuple-of`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-tuple-of) | 🔧 |
+| [`prefer-type-fest-union-member`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-union-member) | 🔧 |
+| [`prefer-type-fest-union-to-tuple`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-union-to-tuple) | 🔧 |
 | [`prefer-type-fest-unknown-array`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-unknown-array) | 🔧 |
 | [`prefer-type-fest-unknown-map`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-unknown-map) | 🔧 |
 | [`prefer-type-fest-unknown-record`](https://nick2bad4u.github.io/eslint-plugin-typefest/docs/rules/prefer-type-fest-unknown-record) | 🔧 |