@eslint-react/shared 1.5.31-next.3 → 1.6.0-next.0

package/dist/index.d.mts

@@ -1,6 +1,7 @@
 import { ESLintUtils } from '@typescript-eslint/utils';
 import * as valibot from 'valibot';
 import { InferOutput } from 'valibot';
+import * as micro_memoize from 'micro-memoize';
 
 /**
  * -----------------------------------------------------------------------------
@@ -60,6 +61,12 @@ declare const CustomAttributeSchema: valibot.ObjectSchema<{
      * "href"
      */
     readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+    /**
+     * Whether the attribute is controlled or not in the user-defined component.
+     * @example
+     * `true`
+     */
+    readonly controlled: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
     /**
      * The default value of the attribute in the user-defined component.
      * @example
@@ -75,13 +82,63 @@ declare const CustomAttributeSchema: valibot.ObjectSchema<{
  * Which attribute is used as the `href` prop for the user-defined `Link` component that represents the built-in `a` element.
  * Which attributes are used as `children` props for a user-defined `Button` component to receive children of that component.
  */
-declare const CustomComponentSchema: valibot.ObjectSchema<{
+declare const CustomComponentSchema: valibot.UnionSchema<[valibot.ObjectSchema<{
     /**
      * The name of the user-defined component.
      * @example
      * "Link"
      */
     readonly name: valibot.StringSchema<undefined>;
+    /**
+     * The name of the built-in component that the user-defined component represents.
+     * @example
+     * "a"
+     */
+    readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+    /**
+     * Pre-defined attributes that are used in the user-defined component.
+     * @example
+     * `Link` component has a `to` attribute that represents the `href` attribute in the built-in `a` element with a default value of `"/"`.
+     */
+    readonly attributes: valibot.OptionalSchema<valibot.ArraySchema<valibot.ObjectSchema<{
+        /**
+         * The name of the attribute in the user-defined component.
+         * @example
+         * "to"
+         */
+        readonly name: valibot.StringSchema<undefined>;
+        /**
+         * The name of the attribute in the built-in component.
+         * @example
+         * "href"
+         */
+        readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+        /**
+         * Whether the attribute is controlled or not in the user-defined component.
+         * @example
+         * `true`
+         */
+        readonly controlled: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
+        /**
+         * The default value of the attribute in the user-defined component.
+         * @example
+         * `"/"`
+         */
+        readonly defaultValue: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+    }, undefined>, undefined>, never>;
+}, undefined>, valibot.ObjectSchema<{
+    /**
+     * The name of the user-defined component.
+     * @example
+     * "Link"
+     */
+    readonly name: valibot.StringSchema<undefined>;
+    /**
+     * The ESQuery selector to select the component precisely.
+     * @example
+     * `:has(JSXAttribute[name.name='component'][value.value='a'])`
+     */
+    readonly selector: valibot.StringSchema<undefined>;
     /**
      * The name of the built-in component that the user-defined component represents.
      * @example
@@ -106,6 +163,12 @@ declare const CustomComponentSchema: valibot.ObjectSchema<{
          * "href"
          */
         readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+        /**
+         * Whether the attribute is controlled or not in the user-defined component.
+         * @example
+         * `true`
+         */
+        readonly controlled: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
         /**
          * The default value of the attribute in the user-defined component.
          * @example
@@ -113,7 +176,7 @@ declare const CustomComponentSchema: valibot.ObjectSchema<{
          */
         readonly defaultValue: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
     }, undefined>, undefined>, never>;
-}, undefined>;
+}, undefined>], undefined>;
 /**
  * @internal
  */
@@ -123,13 +186,63 @@ declare const ESLintReactSettingsSchema: valibot.ObjectSchema<{
     readonly jsxPragmaFrag: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
     readonly strict: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
     readonly version: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
-    readonly additionalComponents: valibot.OptionalSchema<valibot.ArraySchema<valibot.ObjectSchema<{
+    readonly additionalComponents: valibot.OptionalSchema<valibot.ArraySchema<valibot.UnionSchema<[valibot.ObjectSchema<{
+        /**
+         * The name of the user-defined component.
+         * @example
+         * "Link"
+         */
+        readonly name: valibot.StringSchema<undefined>;
+        /**
+         * The name of the built-in component that the user-defined component represents.
+         * @example
+         * "a"
+         */
+        readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+        /**
+         * Pre-defined attributes that are used in the user-defined component.
+         * @example
+         * `Link` component has a `to` attribute that represents the `href` attribute in the built-in `a` element with a default value of `"/"`.
+         */
+        readonly attributes: valibot.OptionalSchema<valibot.ArraySchema<valibot.ObjectSchema<{
+            /**
+             * The name of the attribute in the user-defined component.
+             * @example
+             * "to"
+             */
+            readonly name: valibot.StringSchema<undefined>;
+            /**
+             * The name of the attribute in the built-in component.
+             * @example
+             * "href"
+             */
+            readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+            /**
+             * Whether the attribute is controlled or not in the user-defined component.
+             * @example
+             * `true`
+             */
+            readonly controlled: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
+            /**
+             * The default value of the attribute in the user-defined component.
+             * @example
+             * `"/"`
+             */
+            readonly defaultValue: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+        }, undefined>, undefined>, never>;
+    }, undefined>, valibot.ObjectSchema<{
         /**
          * The name of the user-defined component.
          * @example
          * "Link"
          */
         readonly name: valibot.StringSchema<undefined>;
+        /**
+         * The ESQuery selector to select the component precisely.
+         * @example
+         * `:has(JSXAttribute[name.name='component'][value.value='a'])`
+         */
+        readonly selector: valibot.StringSchema<undefined>;
         /**
          * The name of the built-in component that the user-defined component represents.
          * @example
@@ -154,6 +267,12 @@ declare const ESLintReactSettingsSchema: valibot.ObjectSchema<{
              * "href"
              */
             readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+            /**
+             * Whether the attribute is controlled or not in the user-defined component.
+             * @example
+             * `true`
+             */
+            readonly controlled: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
             /**
              * The default value of the attribute in the user-defined component.
              * @example
@@ -161,7 +280,7 @@ declare const ESLintReactSettingsSchema: valibot.ObjectSchema<{
              */
             readonly defaultValue: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
         }, undefined>, undefined>, never>;
-    }, undefined>, undefined>, never>;
+    }, undefined>], undefined>, undefined>, never>;
     readonly additionalHooks: valibot.OptionalSchema<valibot.ObjectSchema<{
         readonly use: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
         readonly useActionState: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
@@ -186,20 +305,70 @@ declare const ESLintReactSettingsSchema: valibot.ObjectSchema<{
 /**
  * @internal
  */
-declare const ESLintSettingsSchema: valibot.ObjectSchema<{
+declare const ESLintSettingsSchema: valibot.OptionalSchema<valibot.ObjectSchema<{
     readonly "react-x": valibot.OptionalSchema<valibot.ObjectSchema<{
         readonly importSource: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
         readonly jsxPragma: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
         readonly jsxPragmaFrag: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
         readonly strict: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
         readonly version: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
-        readonly additionalComponents: valibot.OptionalSchema<valibot.ArraySchema<valibot.ObjectSchema<{
+        readonly additionalComponents: valibot.OptionalSchema<valibot.ArraySchema<valibot.UnionSchema<[valibot.ObjectSchema<{
             /**
              * The name of the user-defined component.
              * @example
              * "Link"
              */
             readonly name: valibot.StringSchema<undefined>;
+            /**
+             * The name of the built-in component that the user-defined component represents.
+             * @example
+             * "a"
+             */
+            readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+            /**
+             * Pre-defined attributes that are used in the user-defined component.
+             * @example
+             * `Link` component has a `to` attribute that represents the `href` attribute in the built-in `a` element with a default value of `"/"`.
+             */
+            readonly attributes: valibot.OptionalSchema<valibot.ArraySchema<valibot.ObjectSchema<{
+                /**
+                 * The name of the attribute in the user-defined component.
+                 * @example
+                 * "to"
+                 */
+                readonly name: valibot.StringSchema<undefined>;
+                /**
+                 * The name of the attribute in the built-in component.
+                 * @example
+                 * "href"
+                 */
+                readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+                /**
+                 * Whether the attribute is controlled or not in the user-defined component.
+                 * @example
+                 * `true`
+                 */
+                readonly controlled: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
+                /**
+                 * The default value of the attribute in the user-defined component.
+                 * @example
+                 * `"/"`
+                 */
+                readonly defaultValue: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+            }, undefined>, undefined>, never>;
+        }, undefined>, valibot.ObjectSchema<{
+            /**
+             * The name of the user-defined component.
+             * @example
+             * "Link"
+             */
+            readonly name: valibot.StringSchema<undefined>;
+            /**
+             * The ESQuery selector to select the component precisely.
+             * @example
+             * `:has(JSXAttribute[name.name='component'][value.value='a'])`
+             */
+            readonly selector: valibot.StringSchema<undefined>;
             /**
              * The name of the built-in component that the user-defined component represents.
              * @example
@@ -224,6 +393,12 @@ declare const ESLintSettingsSchema: valibot.ObjectSchema<{
                  * "href"
                  */
                 readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+                /**
+                 * Whether the attribute is controlled or not in the user-defined component.
+                 * @example
+                 * `true`
+                 */
+                readonly controlled: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
                 /**
                  * The default value of the attribute in the user-defined component.
                  * @example
@@ -231,7 +406,7 @@ declare const ESLintSettingsSchema: valibot.ObjectSchema<{
                  */
                 readonly defaultValue: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
             }, undefined>, undefined>, never>;
-        }, undefined>, undefined>, never>;
+        }, undefined>], undefined>, undefined>, never>;
         readonly additionalHooks: valibot.OptionalSchema<valibot.ObjectSchema<{
             readonly use: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
             readonly useActionState: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
@@ -252,8 +427,9 @@ declare const ESLintSettingsSchema: valibot.ObjectSchema<{
             readonly useSyncExternalStore: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
             readonly useTransition: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
         }, undefined>, never>;
-    }, undefined>, never>;
+    }, undefined>, {}>;
     /**
+     * @internal
      * @deprecated
      */
     readonly reactOptions: valibot.OptionalSchema<valibot.ObjectSchema<{
@@ -262,13 +438,63 @@ declare const ESLintSettingsSchema: valibot.ObjectSchema<{
         readonly jsxPragmaFrag: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
         readonly strict: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
         readonly version: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
-        readonly additionalComponents: valibot.OptionalSchema<valibot.ArraySchema<valibot.ObjectSchema<{
+        readonly additionalComponents: valibot.OptionalSchema<valibot.ArraySchema<valibot.UnionSchema<[valibot.ObjectSchema<{
             /**
              * The name of the user-defined component.
              * @example
              * "Link"
              */
             readonly name: valibot.StringSchema<undefined>;
+            /**
+             * The name of the built-in component that the user-defined component represents.
+             * @example
+             * "a"
+             */
+            readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+            /**
+             * Pre-defined attributes that are used in the user-defined component.
+             * @example
+             * `Link` component has a `to` attribute that represents the `href` attribute in the built-in `a` element with a default value of `"/"`.
+             */
+            readonly attributes: valibot.OptionalSchema<valibot.ArraySchema<valibot.ObjectSchema<{
+                /**
+                 * The name of the attribute in the user-defined component.
+                 * @example
+                 * "to"
+                 */
+                readonly name: valibot.StringSchema<undefined>;
+                /**
+                 * The name of the attribute in the built-in component.
+                 * @example
+                 * "href"
+                 */
+                readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+                /**
+                 * Whether the attribute is controlled or not in the user-defined component.
+                 * @example
+                 * `true`
+                 */
+                readonly controlled: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
+                /**
+                 * The default value of the attribute in the user-defined component.
+                 * @example
+                 * `"/"`
+                 */
+                readonly defaultValue: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+            }, undefined>, undefined>, never>;
+        }, undefined>, valibot.ObjectSchema<{
+            /**
+             * The name of the user-defined component.
+             * @example
+             * "Link"
+             */
+            readonly name: valibot.StringSchema<undefined>;
+            /**
+             * The ESQuery selector to select the component precisely.
+             * @example
+             * `:has(JSXAttribute[name.name='component'][value.value='a'])`
+             */
+            readonly selector: valibot.StringSchema<undefined>;
             /**
              * The name of the built-in component that the user-defined component represents.
              * @example
@@ -293,6 +519,12 @@ declare const ESLintSettingsSchema: valibot.ObjectSchema<{
                  * "href"
                  */
                 readonly as: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
+                /**
+                 * Whether the attribute is controlled or not in the user-defined component.
+                 * @example
+                 * `true`
+                 */
+                readonly controlled: valibot.OptionalSchema<valibot.BooleanSchema<undefined>, never>;
                 /**
                  * The default value of the attribute in the user-defined component.
                  * @example
@@ -300,7 +532,7 @@ declare const ESLintSettingsSchema: valibot.ObjectSchema<{
                  */
                 readonly defaultValue: valibot.OptionalSchema<valibot.StringSchema<undefined>, never>;
             }, undefined>, undefined>, never>;
-        }, undefined>, undefined>, never>;
+        }, undefined>], undefined>, undefined>, never>;
         readonly additionalHooks: valibot.OptionalSchema<valibot.ObjectSchema<{
             readonly use: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
             readonly useActionState: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
@@ -321,15 +553,16 @@ declare const ESLintSettingsSchema: valibot.ObjectSchema<{
             readonly useSyncExternalStore: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
             readonly useTransition: valibot.OptionalSchema<valibot.ArraySchema<valibot.StringSchema<undefined>, undefined>, never>;
         }, undefined>, never>;
-    }, undefined>, never>;
-}, undefined>;
+    }, undefined>, {}>;
+}, undefined>, {}>;
 type CustomHook = InferOutput<typeof CustomHookSchema>;
 type CustomAttribute = InferOutput<typeof CustomAttributeSchema>;
 type CustomComponent = InferOutput<typeof CustomComponentSchema>;
 type ESLintReactSettings = InferOutput<typeof ESLintReactSettingsSchema>;
 type ESLintSettings = InferOutput<typeof ESLintSettingsSchema>;
 
-declare function parseESLintSettings(data: unknown): ESLintSettings;
+declare function decodeSettings(data: unknown): ESLintReactSettings;
+declare const expandSettings: micro_memoize.Memoized<(settings: ESLintReactSettings) => ESLintReactSettings>;
 declare const DEFAULT_ESLINT_REACT_SETTINGS: ESLintReactSettings;
 
-export { type CustomAttribute, CustomAttributeSchema, type CustomComponent, CustomComponentSchema, type CustomHook, CustomHookSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, HOST_HTML_COMPONENT_TYPES, HOST_SVG_COMPONENT_TYPES, NPM_SCOPE, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createRuleForPlugin, parseESLintSettings };
+export { type CustomAttribute, CustomAttributeSchema, type CustomComponent, CustomComponentSchema, type CustomHook, CustomHookSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, HOST_HTML_COMPONENT_TYPES, HOST_SVG_COMPONENT_TYPES, NPM_SCOPE, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createRuleForPlugin, decodeSettings, expandSettings };