@eslint-react/shared 1.8.3-beta.1 → 1.8.3-beta.3

package/dist/index.d.mts

@@ -60,6 +60,7 @@ declare const REACT_BUILD_IN_HOOKS: readonly ["useActionState", "useCallback", "
 
 /**
  * Get the ESLint rule creator for a plugin.
+ * @internal
  * @param pluginName The name of the plugin.
  * @returns The ESLint rule creator.
  */
@@ -1583,12 +1584,46 @@ declare const CustomComponentSchema: ObjectSchema<{
  * @internal
  */
 declare const ESLintReactSettingsSchema: ObjectSchema<{
+    /**
+     * The source where React is imported from.
+     * @description This allows to specify a custom import location for React when not using the official distribution.
+     * @default `"react"`
+     * @example `"@pika/react"`
+     */
     readonly importSource: OptionalSchema<StringSchema<undefined>, never>;
+    /**
+     * The identifier that’s used for JSX Element creation.
+     * @default `"createElement"`
+     */
     readonly jsxPragma: OptionalSchema<StringSchema<undefined>, never>;
+    /**
+     * The identifier that’s used for JSX fragment elements.
+     * @description This should not be a member expression (i.e. use "Fragment" instead of "React.Fragment").
+     * @default `"Fragment"`
+     */
     readonly jsxPragmaFrag: OptionalSchema<StringSchema<undefined>, never>;
+    /**
+     * The name of the prop that is used for polymorphic components.
+     * @description This is used to determine the type of the component.
+     * @example `"as"`
+     */
     readonly polymorphicPropName: OptionalSchema<StringSchema<undefined>, never>;
+    /**
+     * @internal
+     */
     readonly strict: OptionalSchema<BooleanSchema<undefined>, never>;
+    /**
+     * React version to use, "detect" means auto detect React version from the project’s dependencies.
+     * If `importSource` is specified, an equivalent version of React should be provided here.
+     * @example `"18.3.1"`
+     * @default `"detect"`
+     */
     readonly version: OptionalSchema<StringSchema<undefined>, never>;
+    /**
+     * An array of user-defined components
+     * @description This is used to inform the ESLint React plugins how to treat these components during checks.
+     * @example `[{ name: "Link", as: "a", attributes: [{ name: "to", as: "href" }, { name: "rel", defaultValue: "noopener noreferrer" }] }]`
+     */
     readonly additionalComponents: OptionalSchema<ArraySchema<ObjectSchema<{
         /**
          * The name of the user-defined component.
@@ -1640,6 +1675,11 @@ declare const ESLintReactSettingsSchema: ObjectSchema<{
             readonly defaultValue: OptionalSchema<StringSchema<undefined>, never>;
         }, undefined>, undefined>, readonly []>;
     }, undefined>, undefined>, never>;
+    /**
+     * A object of aliases for React built-in hooks.
+     * @description ESLint React will recognize these aliases as equivalent to the built-in hooks in all its rules.
+     * @example `{ useLayoutEffect: ["useIsomorphicLayoutEffect"] }`
+     */
     readonly additionalHooks: OptionalSchema<ObjectSchema<{
         readonly use: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
         readonly useActionState: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
@@ -1666,12 +1706,46 @@ declare const ESLintReactSettingsSchema: ObjectSchema<{
  */
 declare const ESLintSettingsSchema: OptionalSchema<ObjectSchema<{
     readonly "react-x": OptionalSchema<ObjectSchema<{
+        /**
+         * The source where React is imported from.
+         * @description This allows to specify a custom import location for React when not using the official distribution.
+         * @default `"react"`
+         * @example `"@pika/react"`
+         */
         readonly importSource: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The identifier that’s used for JSX Element creation.
+         * @default `"createElement"`
+         */
         readonly jsxPragma: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The identifier that’s used for JSX fragment elements.
+         * @description This should not be a member expression (i.e. use "Fragment" instead of "React.Fragment").
+         * @default `"Fragment"`
+         */
         readonly jsxPragmaFrag: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The name of the prop that is used for polymorphic components.
+         * @description This is used to determine the type of the component.
+         * @example `"as"`
+         */
         readonly polymorphicPropName: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * @internal
+         */
         readonly strict: OptionalSchema<BooleanSchema<undefined>, never>;
+        /**
+         * React version to use, "detect" means auto detect React version from the project’s dependencies.
+         * If `importSource` is specified, an equivalent version of React should be provided here.
+         * @example `"18.3.1"`
+         * @default `"detect"`
+         */
         readonly version: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * An array of user-defined components
+         * @description This is used to inform the ESLint React plugins how to treat these components during checks.
+         * @example `[{ name: "Link", as: "a", attributes: [{ name: "to", as: "href" }, { name: "rel", defaultValue: "noopener noreferrer" }] }]`
+         */
         readonly additionalComponents: OptionalSchema<ArraySchema<ObjectSchema<{
             /**
              * The name of the user-defined component.
@@ -1723,6 +1797,11 @@ declare const ESLintSettingsSchema: OptionalSchema<ObjectSchema<{
                 readonly defaultValue: OptionalSchema<StringSchema<undefined>, never>;
             }, undefined>, undefined>, readonly []>;
         }, undefined>, undefined>, never>;
+        /**
+         * A object of aliases for React built-in hooks.
+         * @description ESLint React will recognize these aliases as equivalent to the built-in hooks in all its rules.
+         * @example `{ useLayoutEffect: ["useIsomorphicLayoutEffect"] }`
+         */
         readonly additionalHooks: OptionalSchema<ObjectSchema<{
             readonly use: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
             readonly useActionState: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
@@ -1749,12 +1828,46 @@ declare const ESLintSettingsSchema: OptionalSchema<ObjectSchema<{
      * @deprecated
      */
     readonly reactOptions: OptionalSchema<ObjectSchema<{
+        /**
+         * The source where React is imported from.
+         * @description This allows to specify a custom import location for React when not using the official distribution.
+         * @default `"react"`
+         * @example `"@pika/react"`
+         */
         readonly importSource: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The identifier that’s used for JSX Element creation.
+         * @default `"createElement"`
+         */
         readonly jsxPragma: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The identifier that’s used for JSX fragment elements.
+         * @description This should not be a member expression (i.e. use "Fragment" instead of "React.Fragment").
+         * @default `"Fragment"`
+         */
         readonly jsxPragmaFrag: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The name of the prop that is used for polymorphic components.
+         * @description This is used to determine the type of the component.
+         * @example `"as"`
+         */
         readonly polymorphicPropName: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * @internal
+         */
         readonly strict: OptionalSchema<BooleanSchema<undefined>, never>;
+        /**
+         * React version to use, "detect" means auto detect React version from the project’s dependencies.
+         * If `importSource` is specified, an equivalent version of React should be provided here.
+         * @example `"18.3.1"`
+         * @default `"detect"`
+         */
         readonly version: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * An array of user-defined components
+         * @description This is used to inform the ESLint React plugins how to treat these components during checks.
+         * @example `[{ name: "Link", as: "a", attributes: [{ name: "to", as: "href" }, { name: "rel", defaultValue: "noopener noreferrer" }] }]`
+         */
         readonly additionalComponents: OptionalSchema<ArraySchema<ObjectSchema<{
             /**
              * The name of the user-defined component.
@@ -1806,6 +1919,11 @@ declare const ESLintSettingsSchema: OptionalSchema<ObjectSchema<{
                 readonly defaultValue: OptionalSchema<StringSchema<undefined>, never>;
             }, undefined>, undefined>, readonly []>;
         }, undefined>, undefined>, never>;
+        /**
+         * A object of aliases for React built-in hooks.
+         * @description ESLint React will recognize these aliases as equivalent to the built-in hooks in all its rules.
+         * @example `{ useLayoutEffect: ["useIsomorphicLayoutEffect"] }`
+         */
         readonly additionalHooks: OptionalSchema<ObjectSchema<{
             readonly use: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
             readonly useActionState: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
@@ -1957,11 +2075,55 @@ interface ESLintReactSettingsExpanded extends ESLintReactSettings {
     additionalComponents: CustomComponentExpanded[];
     components: Map<string, string>;
 }
+/**
+ * Defines the "react-x" settings in a type-safe way.
+ * @param settings The settings.
+ * @returns The ESLint settings containing the "react-x" object.
+ */
+declare function defineSettings(settings: ESLintReactSettings): {
+    importSource?: string | undefined;
+    jsxPragma?: string | undefined;
+    jsxPragmaFrag?: string | undefined;
+    polymorphicPropName?: string | undefined;
+    strict?: boolean | undefined;
+    version?: string | undefined;
+    additionalComponents?: {
+        name: string;
+        attributes: {
+            name: string;
+            as?: string | undefined;
+            controlled?: boolean | undefined;
+            defaultValue?: string | undefined;
+        }[];
+        as?: string | undefined;
+        selector?: string | undefined;
+    }[] | undefined;
+    additionalHooks?: {
+        use?: string[] | undefined;
+        useActionState?: string[] | undefined;
+        useCallback?: string[] | undefined;
+        useContext?: string[] | undefined;
+        useDebugValue?: string[] | undefined;
+        useDeferredValue?: string[] | undefined;
+        useEffect?: string[] | undefined;
+        useId?: string[] | undefined;
+        useImperativeHandle?: string[] | undefined;
+        useInsertionEffect?: string[] | undefined;
+        useLayoutEffect?: string[] | undefined;
+        useMemo?: string[] | undefined;
+        useOptimistic?: string[] | undefined;
+        useReducer?: string[] | undefined;
+        useRef?: string[] | undefined;
+        useState?: string[] | undefined;
+        useSyncExternalStore?: string[] | undefined;
+        useTransition?: string[] | undefined;
+    } | undefined;
+};
 /**
  * Decodes settings from a data object from `context.settings`.
+ * @internal
  * @param data The data object.
  * @returns settings The settings.
- * @internal
  */
 declare function decodeSettings(data: unknown): ESLintReactSettings;
 /**
@@ -1976,4 +2138,4 @@ declare const expandSettings: Memoized<(settings: ESLintReactSettings) => ESLint
  */
 declare const DEFAULT_ESLINT_REACT_SETTINGS: ESLintReactSettings;
 
-export { type CustomAttribute, CustomAttributeSchema, type CustomComponent, type CustomComponentExpanded, CustomComponentSchema, type CustomHook, CustomHookSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, type ESLintReactSettingsExpanded, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, HOST_HTML_COMPONENT_TYPES, HOST_SVG_COMPONENT_TYPES, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createRuleForPlugin, decodeSettings, expandSettings };
+export { type CustomAttribute, CustomAttributeSchema, type CustomComponent, type CustomComponentExpanded, CustomComponentSchema, type CustomHook, CustomHookSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, type ESLintReactSettingsExpanded, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, HOST_HTML_COMPONENT_TYPES, HOST_SVG_COMPONENT_TYPES, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createRuleForPlugin, decodeSettings, defineSettings, expandSettings };

package/dist/index.d.ts

@@ -60,6 +60,7 @@ declare const REACT_BUILD_IN_HOOKS: readonly ["useActionState", "useCallback", "
 
 /**
  * Get the ESLint rule creator for a plugin.
+ * @internal
  * @param pluginName The name of the plugin.
  * @returns The ESLint rule creator.
  */
@@ -1583,12 +1584,46 @@ declare const CustomComponentSchema: ObjectSchema<{
  * @internal
  */
 declare const ESLintReactSettingsSchema: ObjectSchema<{
+    /**
+     * The source where React is imported from.
+     * @description This allows to specify a custom import location for React when not using the official distribution.
+     * @default `"react"`
+     * @example `"@pika/react"`
+     */
     readonly importSource: OptionalSchema<StringSchema<undefined>, never>;
+    /**
+     * The identifier that’s used for JSX Element creation.
+     * @default `"createElement"`
+     */
     readonly jsxPragma: OptionalSchema<StringSchema<undefined>, never>;
+    /**
+     * The identifier that’s used for JSX fragment elements.
+     * @description This should not be a member expression (i.e. use "Fragment" instead of "React.Fragment").
+     * @default `"Fragment"`
+     */
     readonly jsxPragmaFrag: OptionalSchema<StringSchema<undefined>, never>;
+    /**
+     * The name of the prop that is used for polymorphic components.
+     * @description This is used to determine the type of the component.
+     * @example `"as"`
+     */
     readonly polymorphicPropName: OptionalSchema<StringSchema<undefined>, never>;
+    /**
+     * @internal
+     */
     readonly strict: OptionalSchema<BooleanSchema<undefined>, never>;
+    /**
+     * React version to use, "detect" means auto detect React version from the project’s dependencies.
+     * If `importSource` is specified, an equivalent version of React should be provided here.
+     * @example `"18.3.1"`
+     * @default `"detect"`
+     */
     readonly version: OptionalSchema<StringSchema<undefined>, never>;
+    /**
+     * An array of user-defined components
+     * @description This is used to inform the ESLint React plugins how to treat these components during checks.
+     * @example `[{ name: "Link", as: "a", attributes: [{ name: "to", as: "href" }, { name: "rel", defaultValue: "noopener noreferrer" }] }]`
+     */
     readonly additionalComponents: OptionalSchema<ArraySchema<ObjectSchema<{
         /**
          * The name of the user-defined component.
@@ -1640,6 +1675,11 @@ declare const ESLintReactSettingsSchema: ObjectSchema<{
             readonly defaultValue: OptionalSchema<StringSchema<undefined>, never>;
         }, undefined>, undefined>, readonly []>;
     }, undefined>, undefined>, never>;
+    /**
+     * A object of aliases for React built-in hooks.
+     * @description ESLint React will recognize these aliases as equivalent to the built-in hooks in all its rules.
+     * @example `{ useLayoutEffect: ["useIsomorphicLayoutEffect"] }`
+     */
     readonly additionalHooks: OptionalSchema<ObjectSchema<{
         readonly use: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
         readonly useActionState: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
@@ -1666,12 +1706,46 @@ declare const ESLintReactSettingsSchema: ObjectSchema<{
  */
 declare const ESLintSettingsSchema: OptionalSchema<ObjectSchema<{
     readonly "react-x": OptionalSchema<ObjectSchema<{
+        /**
+         * The source where React is imported from.
+         * @description This allows to specify a custom import location for React when not using the official distribution.
+         * @default `"react"`
+         * @example `"@pika/react"`
+         */
         readonly importSource: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The identifier that’s used for JSX Element creation.
+         * @default `"createElement"`
+         */
         readonly jsxPragma: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The identifier that’s used for JSX fragment elements.
+         * @description This should not be a member expression (i.e. use "Fragment" instead of "React.Fragment").
+         * @default `"Fragment"`
+         */
         readonly jsxPragmaFrag: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The name of the prop that is used for polymorphic components.
+         * @description This is used to determine the type of the component.
+         * @example `"as"`
+         */
         readonly polymorphicPropName: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * @internal
+         */
         readonly strict: OptionalSchema<BooleanSchema<undefined>, never>;
+        /**
+         * React version to use, "detect" means auto detect React version from the project’s dependencies.
+         * If `importSource` is specified, an equivalent version of React should be provided here.
+         * @example `"18.3.1"`
+         * @default `"detect"`
+         */
         readonly version: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * An array of user-defined components
+         * @description This is used to inform the ESLint React plugins how to treat these components during checks.
+         * @example `[{ name: "Link", as: "a", attributes: [{ name: "to", as: "href" }, { name: "rel", defaultValue: "noopener noreferrer" }] }]`
+         */
         readonly additionalComponents: OptionalSchema<ArraySchema<ObjectSchema<{
             /**
              * The name of the user-defined component.
@@ -1723,6 +1797,11 @@ declare const ESLintSettingsSchema: OptionalSchema<ObjectSchema<{
                 readonly defaultValue: OptionalSchema<StringSchema<undefined>, never>;
             }, undefined>, undefined>, readonly []>;
         }, undefined>, undefined>, never>;
+        /**
+         * A object of aliases for React built-in hooks.
+         * @description ESLint React will recognize these aliases as equivalent to the built-in hooks in all its rules.
+         * @example `{ useLayoutEffect: ["useIsomorphicLayoutEffect"] }`
+         */
         readonly additionalHooks: OptionalSchema<ObjectSchema<{
             readonly use: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
             readonly useActionState: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
@@ -1749,12 +1828,46 @@ declare const ESLintSettingsSchema: OptionalSchema<ObjectSchema<{
      * @deprecated
      */
     readonly reactOptions: OptionalSchema<ObjectSchema<{
+        /**
+         * The source where React is imported from.
+         * @description This allows to specify a custom import location for React when not using the official distribution.
+         * @default `"react"`
+         * @example `"@pika/react"`
+         */
         readonly importSource: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The identifier that’s used for JSX Element creation.
+         * @default `"createElement"`
+         */
         readonly jsxPragma: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The identifier that’s used for JSX fragment elements.
+         * @description This should not be a member expression (i.e. use "Fragment" instead of "React.Fragment").
+         * @default `"Fragment"`
+         */
         readonly jsxPragmaFrag: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * The name of the prop that is used for polymorphic components.
+         * @description This is used to determine the type of the component.
+         * @example `"as"`
+         */
         readonly polymorphicPropName: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * @internal
+         */
         readonly strict: OptionalSchema<BooleanSchema<undefined>, never>;
+        /**
+         * React version to use, "detect" means auto detect React version from the project’s dependencies.
+         * If `importSource` is specified, an equivalent version of React should be provided here.
+         * @example `"18.3.1"`
+         * @default `"detect"`
+         */
         readonly version: OptionalSchema<StringSchema<undefined>, never>;
+        /**
+         * An array of user-defined components
+         * @description This is used to inform the ESLint React plugins how to treat these components during checks.
+         * @example `[{ name: "Link", as: "a", attributes: [{ name: "to", as: "href" }, { name: "rel", defaultValue: "noopener noreferrer" }] }]`
+         */
         readonly additionalComponents: OptionalSchema<ArraySchema<ObjectSchema<{
             /**
              * The name of the user-defined component.
@@ -1806,6 +1919,11 @@ declare const ESLintSettingsSchema: OptionalSchema<ObjectSchema<{
                 readonly defaultValue: OptionalSchema<StringSchema<undefined>, never>;
             }, undefined>, undefined>, readonly []>;
         }, undefined>, undefined>, never>;
+        /**
+         * A object of aliases for React built-in hooks.
+         * @description ESLint React will recognize these aliases as equivalent to the built-in hooks in all its rules.
+         * @example `{ useLayoutEffect: ["useIsomorphicLayoutEffect"] }`
+         */
         readonly additionalHooks: OptionalSchema<ObjectSchema<{
             readonly use: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
             readonly useActionState: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, never>;
@@ -1957,11 +2075,55 @@ interface ESLintReactSettingsExpanded extends ESLintReactSettings {
     additionalComponents: CustomComponentExpanded[];
     components: Map<string, string>;
 }
+/**
+ * Defines the "react-x" settings in a type-safe way.
+ * @param settings The settings.
+ * @returns The ESLint settings containing the "react-x" object.
+ */
+declare function defineSettings(settings: ESLintReactSettings): {
+    importSource?: string | undefined;
+    jsxPragma?: string | undefined;
+    jsxPragmaFrag?: string | undefined;
+    polymorphicPropName?: string | undefined;
+    strict?: boolean | undefined;
+    version?: string | undefined;
+    additionalComponents?: {
+        name: string;
+        attributes: {
+            name: string;
+            as?: string | undefined;
+            controlled?: boolean | undefined;
+            defaultValue?: string | undefined;
+        }[];
+        as?: string | undefined;
+        selector?: string | undefined;
+    }[] | undefined;
+    additionalHooks?: {
+        use?: string[] | undefined;
+        useActionState?: string[] | undefined;
+        useCallback?: string[] | undefined;
+        useContext?: string[] | undefined;
+        useDebugValue?: string[] | undefined;
+        useDeferredValue?: string[] | undefined;
+        useEffect?: string[] | undefined;
+        useId?: string[] | undefined;
+        useImperativeHandle?: string[] | undefined;
+        useInsertionEffect?: string[] | undefined;
+        useLayoutEffect?: string[] | undefined;
+        useMemo?: string[] | undefined;
+        useOptimistic?: string[] | undefined;
+        useReducer?: string[] | undefined;
+        useRef?: string[] | undefined;
+        useState?: string[] | undefined;
+        useSyncExternalStore?: string[] | undefined;
+        useTransition?: string[] | undefined;
+    } | undefined;
+};
 /**
  * Decodes settings from a data object from `context.settings`.
+ * @internal
  * @param data The data object.
  * @returns settings The settings.
- * @internal
  */
 declare function decodeSettings(data: unknown): ESLintReactSettings;
 /**
@@ -1976,4 +2138,4 @@ declare const expandSettings: Memoized<(settings: ESLintReactSettings) => ESLint
  */
 declare const DEFAULT_ESLINT_REACT_SETTINGS: ESLintReactSettings;
 
-export { type CustomAttribute, CustomAttributeSchema, type CustomComponent, type CustomComponentExpanded, CustomComponentSchema, type CustomHook, CustomHookSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, type ESLintReactSettingsExpanded, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, HOST_HTML_COMPONENT_TYPES, HOST_SVG_COMPONENT_TYPES, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createRuleForPlugin, decodeSettings, expandSettings };
+export { type CustomAttribute, CustomAttributeSchema, type CustomComponent, type CustomComponentExpanded, CustomComponentSchema, type CustomHook, CustomHookSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, type ESLintReactSettingsExpanded, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, HOST_HTML_COMPONENT_TYPES, HOST_SVG_COMPONENT_TYPES, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createRuleForPlugin, decodeSettings, defineSettings, expandSettings };

package/dist/index.js

@@ -550,13 +550,52 @@ var CustomComponentSchema = object({
   attributes: optional(array(CustomAttributeSchema), [])
 });
 var ESLintReactSettingsSchema = object({
+  /**
+   * The source where React is imported from.
+   * @description This allows to specify a custom import location for React when not using the official distribution.
+   * @default `"react"`
+   * @example `"@pika/react"`
+   */
   importSource: optional(string()),
+  /**
+   * The identifier that’s used for JSX Element creation.
+   * @default `"createElement"`
+   */
   jsxPragma: optional(string()),
+  /**
+   * The identifier that’s used for JSX fragment elements.
+   * @description This should not be a member expression (i.e. use "Fragment" instead of "React.Fragment").
+   * @default `"Fragment"`
+   */
   jsxPragmaFrag: optional(string()),
+  /**
+   * The name of the prop that is used for polymorphic components.
+   * @description This is used to determine the type of the component.
+   * @example `"as"`
+   */
   polymorphicPropName: optional(string()),
+  /**
+   * @internal
+   */
   strict: optional(boolean()),
+  /**
+   * React version to use, "detect" means auto detect React version from the project’s dependencies.
+   * If `importSource` is specified, an equivalent version of React should be provided here.
+   * @example `"18.3.1"`
+   * @default `"detect"`
+   */
   version: optional(string()),
+  /**
+   * An array of user-defined components
+   * @description This is used to inform the ESLint React plugins how to treat these components during checks.
+   * @example `[{ name: "Link", as: "a", attributes: [{ name: "to", as: "href" }, { name: "rel", defaultValue: "noopener noreferrer" }] }]`
+   */
   additionalComponents: optional(array(CustomComponentSchema)),
+  /**
+   * A object of aliases for React built-in hooks.
+   * @description ESLint React will recognize these aliases as equivalent to the built-in hooks in all its rules.
+   * @example `{ useLayoutEffect: ["useIsomorphicLayoutEffect"] }`
+   */
   additionalHooks: optional(object({
     use: optional(array(string())),
     useActionState: optional(array(string())),
@@ -873,6 +912,9 @@ function createMemoizedFunction(fn, options) {
   memoized.options = normalizedOptions;
   return memoized;
 }
+function defineSettings(settings) {
+  return parse(ESLintSettingsSchema, settings)["react-x"] ?? {};
+}
 function decodeSettings(data) {
   return parse(ESLintSettingsSchema, data)["react-x"] ?? {};
 }
@@ -927,4 +969,5 @@ exports.RE_SNAKE_CASE = RE_SNAKE_CASE;
 exports.WEBSITE_URL = WEBSITE_URL;
 exports.createRuleForPlugin = createRuleForPlugin;
 exports.decodeSettings = decodeSettings;
+exports.defineSettings = defineSettings;
 exports.expandSettings = expandSettings;

package/dist/index.mjs

@@ -544,13 +544,52 @@ var CustomComponentSchema = object({
   attributes: optional(array(CustomAttributeSchema), [])
 });
 var ESLintReactSettingsSchema = object({
+  /**
+   * The source where React is imported from.
+   * @description This allows to specify a custom import location for React when not using the official distribution.
+   * @default `"react"`
+   * @example `"@pika/react"`
+   */
   importSource: optional(string()),
+  /**
+   * The identifier that’s used for JSX Element creation.
+   * @default `"createElement"`
+   */
   jsxPragma: optional(string()),
+  /**
+   * The identifier that’s used for JSX fragment elements.
+   * @description This should not be a member expression (i.e. use "Fragment" instead of "React.Fragment").
+   * @default `"Fragment"`
+   */
   jsxPragmaFrag: optional(string()),
+  /**
+   * The name of the prop that is used for polymorphic components.
+   * @description This is used to determine the type of the component.
+   * @example `"as"`
+   */
   polymorphicPropName: optional(string()),
+  /**
+   * @internal
+   */
   strict: optional(boolean()),
+  /**
+   * React version to use, "detect" means auto detect React version from the project’s dependencies.
+   * If `importSource` is specified, an equivalent version of React should be provided here.
+   * @example `"18.3.1"`
+   * @default `"detect"`
+   */
   version: optional(string()),
+  /**
+   * An array of user-defined components
+   * @description This is used to inform the ESLint React plugins how to treat these components during checks.
+   * @example `[{ name: "Link", as: "a", attributes: [{ name: "to", as: "href" }, { name: "rel", defaultValue: "noopener noreferrer" }] }]`
+   */
   additionalComponents: optional(array(CustomComponentSchema)),
+  /**
+   * A object of aliases for React built-in hooks.
+   * @description ESLint React will recognize these aliases as equivalent to the built-in hooks in all its rules.
+   * @example `{ useLayoutEffect: ["useIsomorphicLayoutEffect"] }`
+   */
   additionalHooks: optional(object({
     use: optional(array(string())),
     useActionState: optional(array(string())),
@@ -867,6 +906,9 @@ function createMemoizedFunction(fn, options) {
   memoized.options = normalizedOptions;
   return memoized;
 }
+function defineSettings(settings) {
+  return parse(ESLintSettingsSchema, settings)["react-x"] ?? {};
+}
 function decodeSettings(data) {
   return parse(ESLintSettingsSchema, data)["react-x"] ?? {};
 }
@@ -901,4 +943,4 @@ var DEFAULT_ESLINT_REACT_SETTINGS = {
   version: "detect"
 };
 
-export { CustomAttributeSchema, CustomComponentSchema, CustomHookSchema, DEFAULT_ESLINT_REACT_SETTINGS, ESLintReactSettingsSchema, ESLintSettingsSchema, GITHUB_URL, HOST_HTML_COMPONENT_TYPES, HOST_SVG_COMPONENT_TYPES, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createRuleForPlugin, decodeSettings, expandSettings };
+export { CustomAttributeSchema, CustomComponentSchema, CustomHookSchema, DEFAULT_ESLINT_REACT_SETTINGS, ESLintReactSettingsSchema, ESLintSettingsSchema, GITHUB_URL, HOST_HTML_COMPONENT_TYPES, HOST_SVG_COMPONENT_TYPES, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createRuleForPlugin, decodeSettings, defineSettings, expandSettings };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "1.8.3-beta.1",
+  "version": "1.8.3-beta.3",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {