@eslint-react/shared 5.24.1 → 5.24.2

package/dist/index.js

@@ -4,44 +4,6 @@ import { P, match } from "ts-pattern";
 import { z } from "zod/v4";
 
 //#region ../../.pkgs/eff/dist/index.js
-/**
-* Applies a `pipe` method's variadic arguments to an initial value from left
-* to right.
-*
-* **When to use**
-*
-* Use to implement a custom `.pipe(...)` method from JavaScript's `arguments`
-* object.
-*
-* **Details**
-*
-* This helper is intended for implementing `Pipeable.pipe` methods that
-* receive JavaScript's `arguments` object. With no functions it returns the
-* original value; otherwise it feeds each result into the next function.
-*
-* **Example** (Implementing a pipe method)
-*
-* ```ts
-* import { Pipeable } from "effect"
-*
-* class NumberBox {
-*   constructor(readonly value: number) {}
-*
-*   pipe(..._fns: ReadonlyArray<(value: number) => number>): number {
-*     return Pipeable.pipeArguments(this.value, arguments) as number
-*   }
-* }
-*
-* const result = new NumberBox(5).pipe(
-*   (n) => n + 2,
-*   (n) => n * 3
-* )
-* result // => 21
-* ```
-*
-* @category combinators
-* @since 2.0.0
-*/
 const pipeArguments = (self, args) => {
 	switch (args.length) {
 		case 0: return self;
@@ -61,100 +23,14 @@ const pipeArguments = (self, args) => {
 		}
 	}
 };
-/**
-* Reusable prototype that implements `Pipeable.pipe`.
-*
-* **When to use**
-*
-* Use when classes or object prototypes can reuse this value when they need the
-* standard pipe implementation backed by `pipeArguments`.
-*
-* @category prototypes
-* @since 3.15.0
-*/
 const Prototype = { pipe() {
 	return pipeArguments(this, arguments);
 } };
-/**
-* Provides a base constructor whose instances implement the standard `Pipeable.pipe`
-* method.
-*
-* **When to use**
-*
-* Use when you need to define a class that supports Effect-style method
-* chaining through `.pipe(...)`.
-*
-* @category constructors
-* @since 3.15.0
-*/
 const Class = (function() {
 	function PipeableBase() {}
 	PipeableBase.prototype = Prototype;
 	return PipeableBase;
 })();
-/**
-* Creates a function that can be called in data-first style or data-last
-* (`pipe`-friendly) style.
-*
-* **When to use**
-*
-* Use to expose one implementation through both direct and `pipe`-friendly
-* call styles.
-*
-* **Details**
-*
-* Pass either the arity of the uncurried function or a predicate that decides
-* whether the current call is data-first. Arity is the common case. Use a
-* predicate when optional arguments make arity ambiguous.
-*
-* **Example** (Selecting data-first or data-last style by arity)
-*
-* ```ts
-* import { Function, pipe } from "effect"
-*
-* const sum = Function.dual<
-*   (that: number) => (self: number) => number,
-*   (self: number, that: number) => number
-* >(2, (self, that) => self + that)
-*
-* sum(2, 3) // => 5
-* pipe(2, sum(3)) // => 5
-* ```
-*
-* **Example** (Defining overloads with call signatures)
-*
-* ```ts
-* import { Function, pipe } from "effect"
-*
-* const sum: {
-*   (that: number): (self: number) => number
-*   (self: number, that: number): number
-* } = Function.dual(2, (self: number, that: number): number => self + that)
-*
-* sum(2, 3) // => 5
-* pipe(2, sum(3)) // => 5
-* ```
-*
-* **Example** (Selecting data-first or data-last style with a predicate)
-*
-* ```ts
-* import { Function, pipe } from "effect"
-*
-* const sum = Function.dual<
-*   (that: number) => (self: number) => number,
-*   (self: number, that: number) => number
-* >(
-*   (args) => args.length === 2,
-*   (self, that) => self + that
-* )
-*
-* sum(2, 3) // => 5
-* pipe(2, sum(3)) // => 5
-* ```
-*
-* @category combinators
-* @since 2.0.0
-*/
 const dual = function(arity, body) {
 	if (typeof arity === "function") return function() {
 		return arity(arguments) ? body.apply(this, arguments) : ((self) => body(self, ...arguments));
@@ -183,253 +59,18 @@ const dual = function(arity, body) {
 		};
 	}
 };
-/**
-* Returns its input argument unchanged.
-*
-* **When to use**
-*
-* Use to return a value unchanged where a function is required.
-*
-* **Example** (Returning the same value)
-*
-* ```ts
-* import { identity } from "effect"
-*
-* identity(5) // => 5
-* ```
-*
-* @category combinators
-* @since 2.0.0
-*/
 const identity = (a) => a;
-/**
-* Returns the input value with a different static type.
-*
-* **When to use**
-*
-* Use when you need an explicit type-level cast and accept that the value is
-* returned unchanged at runtime.
-*
-* **Gotchas**
-*
-* This is a type-level cast only; it performs no runtime validation or
-* conversion.
-*
-* @see {@link satisfies} for checking assignability without changing the resulting type
-*
-* @category utility types
-* @since 4.0.0
-*/
 const cast = identity;
-/**
-* Creates a zero-argument function that always returns the provided value.
-*
-* **When to use**
-*
-* Use when you need a thunk or callback that returns the same value on every
-* invocation.
-*
-* **Example** (Creating a constant thunk)
-*
-* ```ts
-* import { Function } from "effect"
-*
-* const constNull = Function.constant(null)
-*
-* constNull() // => null
-* constNull() // => null
-* ```
-*
-* @category constructors
-* @since 2.0.0
-*/
 const constant = (value) => () => value;
-/**
-* Returns `true` when called.
-*
-* **When to use**
-*
-* Use when you need a thunk that returns `true` on every invocation.
-*
-* **Example** (Returning true from a thunk)
-*
-* ```ts
-* import { Function } from "effect"
-*
-* Function.constTrue() // => true
-* ```
-*
-* @category constants
-* @since 2.0.0
-*/
 const constTrue = constant(true);
-/**
-* Returns `false` when called.
-*
-* **When to use**
-*
-* Use when you need a thunk that returns `false` on every invocation.
-*
-* **Example** (Returning false from a thunk)
-*
-* ```ts
-* import { Function } from "effect"
-*
-* Function.constFalse() // => false
-* ```
-*
-* @category constants
-* @since 2.0.0
-*/
 const constFalse = constant(false);
-/**
-* Returns `null` when called.
-*
-* **When to use**
-*
-* Use when you need a thunk that returns `null` on every invocation.
-*
-* **Example** (Returning null from a thunk)
-*
-* ```ts
-* import { Function } from "effect"
-*
-* Function.constNull() // => null
-* ```
-*
-* @category constants
-* @since 2.0.0
-*/
 const constNull = constant(null);
-/**
-* Returns `undefined` when called.
-*
-* **When to use**
-*
-* Use when you need a thunk that returns `undefined` on every invocation.
-*
-* **Example** (Returning undefined from a thunk)
-*
-* ```ts
-* import { Function } from "effect"
-*
-* Function.constUndefined() // => undefined
-* ```
-*
-* @category constants
-* @since 2.0.0
-*/
 const constUndefined = constant(void 0);
-/**
-* Composes two functions, `ab` and `bc` into a single function that takes in an argument `a` of type `A` and returns a result of type `C`.
-* The result is obtained by first applying the `ab` function to `a` and then applying the `bc` function to the result of `ab`.
-*
-* **When to use**
-*
-* Use to compose exactly two unary functions into a reusable unary function.
-*
-* **Example** (Composing two functions)
-*
-* ```ts
-* import { Function } from "effect"
-*
-* const increment = (n: number) => n + 1
-* const square = (n: number) => n * n
-*
-* Function.compose(increment, square)(2) // => 9
-* ```
-*
-* @see {@link flow} for composing a left-to-right sequence of functions
-* @see {@link pipe} for applying a value through a left-to-right sequence immediately
-*
-* @category combinators
-* @since 2.0.0
-*/
 const compose = dual(2, (ab, bc) => (a) => bc(ab(a)));
-/**
-* Marks an impossible branch by accepting a `never` value and returning any
-* type.
-*
-* **When to use**
-*
-* Use when you need a return value in a branch that exhaustive checks prove
-* cannot be reached.
-*
-* **Gotchas**
-*
-* Calling `absurd` throws, because a value of type `never` should be
-* impossible at runtime.
-*
-* **Example** (Handling impossible values)
-*
-* ```ts
-* import { absurd } from "effect"
-*
-* const handleNever = (value: never) => {
-*   return absurd(value) // This will throw an error if called
-* }
-* ```
-*
-* @category utility types
-* @since 2.0.0
-*/
 const absurd = (_) => {
 	throw new Error("Called `absurd` function which should be uncallable");
 };
-/**
-* Creates a compile-time placeholder for a value of any type.
-*
-* **When to use**
-*
-* Use as a temporary typed placeholder while developing incomplete code.
-*
-* **Gotchas**
-*
-* `hole` is intended for temporary development use. If the placeholder is
-* evaluated at runtime, it throws.
-*
-* **Example** (Creating a development placeholder)
-*
-* ```ts
-* import { hole } from "effect"
-*
-* // Intentionally not called: `hole` throws if the placeholder is evaluated.
-* const buildUser = (id: number): { readonly id: number; readonly name: string } => ({
-*   id,
-*   name: hole<string>()
-* })
-*
-* ```
-*
-* @category utility types
-* @since 2.0.0
-*/
 const hole = cast(absurd);
-/**
-* Creates a memoized function whose input is an object, caching results by
-* object identity.
-*
-* **When to use**
-*
-* Use to reuse the result of a synchronous computation whose output is stable
-* for a given object reference.
-*
-* **Details**
-*
-* Each memoized wrapper owns a private `WeakMap` keyed by object identity.
-*
-* **Gotchas**
-*
-* `undefined` is reserved to represent a cache miss and is therefore not
-* supported as a return value.
-*
-* Structurally equal objects do not share cache entries. If the same object is
-* mutated after its first call, later calls still return the cached result for
-* that reference.
-*
-* @category caching
-* @since 4.0.0
-*/
 function memoize(f) {
 	const cache = /* @__PURE__ */ new WeakMap();
 	return (a) => {
@@ -440,333 +81,20 @@ function memoize(f) {
 		return result;
 	};
 }
-/**
-* Creates a predicate that returns `true` only if both predicates are `true`.
-*
-* **When to use**
-*
-* Use when you want to combine `Predicate`s with AND, accepting values that
-* satisfy multiple conditions, including refinements that narrow to an
-* intersection.
-*
-* **Details**
-*
-* Evaluation short-circuits on the first `false`. For refinements, the output
-* type is an intersection.
-*
-* **Example** (Checking both conditions)
-*
-* ```ts
-* import { Predicate } from "effect"
-*
-* const hasAAndB = Predicate.and(
-*   Predicate.hasProperty("a"),
-*   Predicate.hasProperty("b")
-* )
-*
-* const input: unknown = JSON.parse(`{"a":1,"b":"ok"}`)
-* if (hasAAndB(input)) {
-*   // input has both properties at this point
-*   const a = input.a
-*   const b = input.b
-*
-*   const values = [a, b] // => [1, "ok"]
-* }
-* ```
-*
-* @see {@link or}
-* @see {@link not}
-* @category combinators
-* @since 2.0.0
-*/
 const and = dual(2, (a, b) => (data) => a(data) && b(data));
-/**
-* Creates a predicate that returns `true` if either predicate is `true`.
-*
-* **When to use**
-*
-* Use when you want to combine `Predicate`s with OR, accepting values that
-* satisfy at least one condition, including refinements that narrow to a union.
-*
-* **Details**
-*
-* Evaluation short-circuits on the first `true`. For refinements, the output
-* type is a union.
-*
-* **Example** (Checking either condition)
-*
-* ```ts
-* import { Predicate } from "effect"
-*
-* const isStringOrNumber = Predicate.or(Predicate.isString, Predicate.isNumber)
-*
-* isStringOrNumber("a") // => true
-* ```
-*
-* @see {@link and}
-* @see {@link xor}
-* @category combinators
-* @since 2.0.0
-*/
 const or = dual(2, (a, b) => (data) => a(data) || b(data));
-/**
-* Creates a predicate that returns `true` if exactly one predicate is `true`.
-*
-* **When to use**
-*
-* Use when you want to combine two `Predicate`s with exclusive-or semantics.
-*
-* **Details**
-*
-* Returns `true` when results differ.
-*
-* **Example** (Checking exclusive-or conditions)
-*
-* ```ts
-* import { Predicate } from "effect"
-*
-* const isEven = (n: number) => n % 2 === 0
-* const isPositive = (n: number) => n > 0
-* const either = Predicate.xor(isEven, isPositive)
-*
-* either(-2) // => true
-* ```
-*
-* @see {@link or}
-* @see {@link and}
-* @category combinators
-* @since 2.0.0
-*/
 const xor = dual(2, (a, b) => (data) => a(data) !== b(data));
-/**
-* Creates a predicate that returns `true` when both predicates agree.
-*
-* **When to use**
-*
-* Use when you want to check equivalence of two `Predicate`s.
-*
-* **Details**
-*
-* Returns `true` when both results are equal.
-*
-* **Example** (Defining equivalence)
-*
-* ```ts
-* import { Predicate } from "effect"
-*
-* const isEven = (n: number) => n % 2 === 0
-* const same = Predicate.eqv(isEven, isEven)
-*
-* same(3) // => true
-* ```
-*
-* @see {@link xor}
-* @category combinators
-* @since 2.0.0
-*/
 const eqv = dual(2, (a, b) => (data) => a(data) === b(data));
-/**
-* Creates a predicate representing logical implication: if `antecedent`, then `consequent`.
-*
-* **When to use**
-*
-* Use when you need to encode logical implication between `Predicate` rules,
-* where one rule only applies when a precondition holds.
-*
-* **Details**
-*
-* Models constraints like "if A then B" and returns `true` when the antecedent
-* is `false`.
-*
-* **Example** (Checking implication)
-*
-* ```ts
-* import { Predicate } from "effect"
-*
-* const isAdult = (age: number) => age >= 18
-* const canVote = (age: number) => age >= 18
-* const implies = Predicate.implies(isAdult, canVote)
-*
-* implies(16) // => true
-* ```
-*
-* @see {@link and}
-* @see {@link or}
-* @category combinators
-* @since 2.0.0
-*/
 const implies = dual(2, (antecedent, consequent) => (data) => !antecedent(data) || consequent(data));
-/**
-* Creates a predicate that returns `true` when neither predicate is `true`.
-*
-* **When to use**
-*
-* Use when you want to combine two `Predicate`s with logical NOR semantics.
-*
-* **Details**
-*
-* Returns the negation of `or`.
-*
-* **Example** (Checking NOR conditions)
-*
-* ```ts
-* import { Predicate } from "effect"
-*
-* const neither = Predicate.nor(Predicate.isString, Predicate.isNumber)
-*
-* neither(true) // => true
-* ```
-*
-* @see {@link or}
-* @see {@link not}
-* @category combinators
-* @since 2.0.0
-*/
 const nor = dual(2, (a, b) => (data) => !a(data) && !b(data));
-/**
-* Creates a predicate that returns `true` unless both predicates are `true`.
-*
-* **When to use**
-*
-* Use when you want to combine two `Predicate`s with logical NAND semantics.
-*
-* **Details**
-*
-* Returns the negation of `and`.
-*
-* **Example** (Checking NAND conditions)
-*
-* ```ts
-* import { Predicate } from "effect"
-*
-* const notBoth = Predicate.nand(Predicate.isString, Predicate.isNumber)
-*
-* notBoth("a") // => true
-* ```
-*
-* @see {@link and}
-* @see {@link not}
-* @category combinators
-* @since 2.0.0
-*/
 const nand = dual(2, (a, b) => (data) => !a(data) || !b(data));
-/**
-* Checks whether a value is a `function`.
-*
-* **When to use**
-*
-* Use when you need a `Predicate` guard to narrow an `unknown` value to a
-* callable function.
-*
-* **Details**
-*
-* Uses `typeof input === "function"`.
-*
-* **Example** (Guarding functions)
-*
-* ```ts
-* import { Predicate } from "effect"
-*
-* const data: unknown = () => 1
-*
-* if (Predicate.isFunction(data)) {
-*   data() // => 1
-* }
-* ```
-*
-* @see {@link isObjectKeyword}
-* @category guards
-* @since 2.0.0
-*/
 function isFunction(input) {
 	return typeof input === "function";
 }
-/**
-* Checks whether a value is an `object` in the JavaScript sense (objects, arrays, functions).
-*
-* **When to use**
-*
-* Use when you need a `Predicate` guard that accepts arrays and functions as
-* well as objects.
-*
-* **Details**
-*
-* Returns `true` for arrays and functions, and `false` for `null`.
-*
-* **Example** (Checking object keywords)
-*
-* ```ts
-* import { Predicate } from "effect"
-*
-* Predicate.isObjectKeyword(() => 1) // => true
-* Predicate.isObjectKeyword(null) // => false
-* ```
-*
-* @see {@link isObject}
-* @see {@link isObjectOrArray}
-* @category guards
-* @since 4.0.0
-*/
 function isObjectKeyword(input) {
 	return typeof input === "object" && input !== null || isFunction(input);
 }
-/**
-* Checks whether a value has a given property key.
-*
-* **When to use**
-*
-* Use when you need a `Predicate` guard for property access on `unknown`
-* values with a simple structural object check.
-*
-* **Details**
-*
-* Uses the `in` operator and `isObjectKeyword`. This does not check property
-* value types.
-*
-* **Example** (Guarding object properties)
-*
-* ```ts
-* import { Predicate } from "effect"
-*
-* const hasName = Predicate.hasProperty("name")
-* const data: unknown = { name: "Ada" }
-*
-* if (hasName(data)) {
-*   data.name // => "Ada"
-* }
-* ```
-*
-* @see {@link isTagged}
-* @see {@link isObjectKeyword}
-* @category guards
-* @since 2.0.0
-*/
 const hasProperty = dual(2, (data, property) => isObjectKeyword(data) && property in data);
-/**
-* Drops elements from the start while the predicate holds, returning the rest.
-*
-* **When to use**
-*
-* Use to remove a leading prefix of elements that satisfy a predicate.
-*
-* **Details**
-*
-* The predicate receives `(element, index)`.
-*
-* **Example** (Dropping while condition holds)
-*
-* ```ts
-* import { Array } from "effect"
-*
-* Array.dropWhile([1, 2, 3, 4, 5], (x) => x < 4) // => [4, 5]
-* ```
-*
-* @see {@link takeWhile} — keep the matching prefix instead
-* @see {@link drop} — drop a fixed count
-*
-* @category getters
-* @since 2.0.0
-*/
 const dropWhile = dual(2, (self, predicate) => {
 	const input = Array.isArray(self) ? self : Array.from(self);
 	const len = input.length;
@@ -774,35 +102,6 @@ const dropWhile = dual(2, (self, predicate) => {
 	while (idx < len && predicate(input[idx], idx)) idx++;
 	return input.slice(idx);
 });
-/**
-* Takes elements from the start while the predicate holds, stopping at the
-* first element that fails.
-*
-* **When to use**
-*
-* Use to keep the leading elements of an iterable while each element satisfies
-* a predicate, returning the retained prefix as an array.
-*
-* **Details**
-*
-* Supports refinements for type narrowing. The predicate receives
-* `(element, index)`.
-*
-* **Example** (Taking while condition holds)
-*
-* ```ts
-* import { Array } from "effect"
-*
-* Array.takeWhile([1, 3, 2, 4, 1, 2], (x) => x < 4) // => [1, 3, 2]
-* ```
-*
-* @see {@link take} for keeping a fixed number of leading elements
-* @see {@link dropWhile} for removing the matching prefix and keeping the rest
-* @see {@link span} for splitting the matching prefix from the remaining elements
-*
-* @category getters
-* @since 2.0.0
-*/
 const takeWhile = dual(2, (self, predicate) => {
 	const input = Array.isArray(self) ? self : Array.from(self);
 	const len = input.length;
@@ -813,175 +112,71 @@ const takeWhile = dual(2, (self, predicate) => {
 
 //#endregion
 //#region src/regexp.ts
-/** Regular expression for matching an HTML tag name. */
 const RE_HTML_TAG = /^[a-z][^-]*$/u;
-/** Regular expression for matching a TypeScript file extension. */
 const RE_TS_EXT = /^[cm]?tsx?$/u;
-/** Regular expression for matching a JavaScript file extension. */
 const RE_JS_EXT = /^[cm]?jsx?$/u;
-/** Regular expression for matching a PascalCase string. */
 const RE_PASCAL_CASE = /^[A-Z][\dA-Za-z]*$/u;
-/** Regular expression for matching a camelCase string. */
 const RE_CAMEL_CASE = /^[a-z][\dA-Za-z]*$/u;
-/** Regular expression for matching a kebab-case string. */
 const RE_KEBAB_CASE = /^[a-z][\d\-a-z]*$/u;
-/** Regular expression for matching a snake_case string. */
 const RE_SNAKE_CASE = /^[a-z][\d_a-z]*$/u;
-/** Regular expression for matching a CONSTANT_CASE string. */
 const RE_CONSTANT_CASE = /^[A-Z][\d_A-Z]*$/u;
-/**
-* Regular expression for matching the `javascript:` protocol.
-* @see https://github.com/facebook/react/blob/6db7f4209e6f32ebde298a0b7451710dd6aa3e19/packages/react-dom-bindings/src/shared/sanitizeURL.js#L22
-*/
 const RE_JAVASCRIPT_PROTOCOL = /^[\u0000-\u001F ]*j[\t\n\r]*a[\t\n\r]*v[\t\n\r]*a[\t\n\r]*s[\t\n\r]*c[\t\n\r]*r[\t\n\r]*i[\t\n\r]*p[\t\n\r]*t[\t\n\r]*:/iu;
-/** Regular expression for matching a valid JavaScript identifier. */
 const RE_JS_IDENTIFIER = /^[_$a-z][\w$]*$/i;
-/** Regular expression for matching a RegExp string. */
 const RE_REGEXP_STR = /^\/(.+)\/([A-Za-z]*)$/u;
-/** Regular expression for matching a `@jsx` annotation comment. */
 const RE_ANNOTATION_JSX = /@jsx\s+(\S+)/u;
-/** Regular expression for matching a `@jsxFrag` annotation comment. */
 const RE_ANNOTATION_JSX_FRAG = /@jsxFrag\s+(\S+)/u;
-/** Regular expression for matching a `@jsxRuntime` annotation comment. */
 const RE_ANNOTATION_JSX_RUNTIME = /@jsxRuntime\s+(\S+)/u;
-/** Regular expression for matching a `@jsxImportSource` annotation comment. */
 const RE_ANNOTATION_JSX_IMPORT_SOURCE = /@jsxImportSource\s+(\S+)/u;
-/** Regular expression for matching a React component name. */
 const RE_COMPONENT_NAME = /^[A-Z]/u;
-/** Regular expression for matching a React component name (loose). */
 const RE_COMPONENT_NAME_LOOSE = /^_?[A-Z]/u;
-/** Regular expression for matching a React Hook name. */
 const RE_HOOK_NAME = /^use/u;
-/**
-* Convert a string to a `RegExpLike` object.
-*
-* Normal strings (ex: `"foo"`) are converted to `/^foo$/`.
-* RegExp strings (ex: `"/^foo/i"`) are converted to `/^foo/i`.
-* @param string The string to convert.
-* @returns The converted `RegExpLike` object.
-* @see https://github.com/sveltejs/eslint-plugin-svelte/blob/main/packages/eslint-plugin-svelte/src/utils/regexp.ts
-*/
 function toRegExp(string) {
 	if (string == null) return { test: constFalse };
 	const [, pattern, flags = "u"] = RE_REGEXP_STR.exec(string) ?? [];
 	if (pattern != null) return new RegExp(pattern, flags);
 	return { test: (s) => s === string };
 }
-/**
-* Check if the string is a RegExp string.
-* @param string The string to check.
-* @returns `true` if the string is a RegExp string.
-*/
 function isRegExp(string) {
 	return RE_REGEXP_STR.test(string);
 }
 
 //#endregion
 //#region src/settings.ts
-/**
-* The zod schema for the ESLint React settings.
-* @internal
-*/
 const ESLintReactSettingsSchema = z.object({
-	/**
-	* The source where React is imported from.
-	* Allows specifying a custom import location for React.
-	* @default "react"
-	* @example "@pika/react"
-	*/
 	importSource: z.optional(z.string()),
-	/**
-	* The React Compiler compilationMode that the project is using.
-	* Used to inform the rule about how components and hooks will be picked up by the compiler.
-	* @example "infer"
-	*/
 	compilationMode: z.optional(z.enum([
 		"infer",
 		"annotation",
 		"syntax",
 		"all"
 	])),
-	/**
-	* The prop name used for polymorphic components.
-	* Used to determine the component's type.
-	* @example "as"
-	*/
 	polymorphicPropName: z.optional(z.string()),
-	/**
-	* React version to use.
-	* "detect" means auto-detect React version from project dependencies.
-	* @example "18.3.1"
-	* @default "detect"
-	*/
 	version: z.optional(z.string()),
-	/**
-	* Regex pattern matching custom hooks that should be treated as ref hooks.
-	* @example "useMyRef|useCustomRef"
-	*/
 	additionalRefHooks: z.optional(z.string()),
-	/**
-	* Regex pattern matching custom hooks that should be treated as state hooks.
-	* @example "useMyState|useCustomState"
-	*/
 	additionalStateHooks: z.optional(z.string()),
-	/**
-	* Regex pattern matching custom hooks that should be treated as effect hooks.
-	* @example "useMyEffect|useCustomEffect"
-	*/
 	additionalEffectHooks: z.optional(z.string())
 });
-/**
-* The zod schema for the ESLint settings.
-* @internal
-*/
 const ESLintSettingsSchema = z.optional(z.object({ "react-x": z.optional(z.unknown()) }));
-/** The default ESLint React settings. */
 const DEFAULT_ESLINT_REACT_SETTINGS = {
 	version: "detect",
 	importSource: "react",
 	polymorphicPropName: "as"
 };
-/** The default ESLint settings. */
 const DEFAULT_ESLINT_SETTINGS = { "react-x": DEFAULT_ESLINT_REACT_SETTINGS };
-/**
-* Check if the value is valid ESLint settings.
-* @param settings The value to check.
-* @returns `true` if the value is valid ESLint settings.
-*/
 function isESLintSettings(settings) {
 	return ESLintSettingsSchema.safeParse(settings).success;
 }
-/**
-* Check if the value is valid ESLint React settings.
-* @param settings The value to check.
-* @returns `true` if the value is valid ESLint React settings.
-*/
 function isESLintReactSettings(settings) {
 	return ESLintReactSettingsSchema.safeParse(settings).success;
 }
-/**
-* Decode the ESLint settings, falling back to the defaults when invalid.
-* @param settings The value to decode.
-* @returns The decoded ESLint settings.
-*/
 const decodeESLintSettings = (settings) => {
 	if (isESLintSettings(settings)) return settings;
 	return DEFAULT_ESLINT_SETTINGS;
 };
-/**
-* Decode the ESLint React settings, falling back to the defaults when invalid.
-* @param settings The value to decode.
-* @returns The decoded ESLint React settings.
-*/
 const decodeSettings = (settings) => {
 	if (isESLintReactSettings(settings)) return settings;
 	return DEFAULT_ESLINT_REACT_SETTINGS;
 };
-/**
-* Normalize the ESLint React settings to the form used by rules.
-* @param settings The ESLint React settings to normalize.
-* @returns The normalized ESLint React settings.
-*/
 const normalizeSettings = ({ importSource = "react", compilationMode, polymorphicPropName = "as", version, additionalRefHooks, additionalStateHooks, additionalEffectHooks, ...rest }) => {
 	return {
 		...rest,
@@ -994,11 +189,6 @@ const normalizeSettings = ({ importSource = "react", compilationMode, polymorphi
 		additionalEffectHooks: toRegExp(additionalEffectHooks)
 	};
 };
-/**
-* Get the React version from the project's dependencies.
-* @param fallback The fallback version to return if React is not found.
-* @returns The detected React version or the fallback version.
-*/
 function getReactVersion(fallback) {
 	try {
 		return match(module.createRequire(process.cwd() + path.sep)("react")).with({ version: P.select(P.string) }, identity).otherwise(() => fallback);
@@ -1006,17 +196,7 @@ function getReactVersion(fallback) {
 		return fallback;
 	}
 }
-/**
-* Get the normalized ESLint React settings, memoized by the input settings object.
-* @param settings The ESLint React settings to decode and normalize.
-* @returns The normalized ESLint React settings.
-*/
 const getNormalizedSettings = memoize((settings) => normalizeSettings(decodeSettings(settings)));
-/**
-* Get the normalized ESLint React settings from the rule context.
-* @param context The rule context.
-* @returns The normalized ESLint React settings.
-*/
 function getSettingsFromContext(context) {
 	const settings = context.settings["react-x"];
 	return getNormalizedSettings(isObjectKeyword(settings) ? settings : DEFAULT_ESLINT_REACT_SETTINGS);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "5.24.1",
+  "version": "5.24.2",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
@@ -29,7 +29,7 @@
     "dist"
   ],
   "dependencies": {
-    "@eslint-react/eslint": "5.24.1",
+    "@eslint-react/eslint": "5.24.2",
     "@typescript-eslint/utils": "^8.71.0",
     "ts-pattern": "^5.9.0",
     "zod": "^3.25.0 || ^4.0.0"