@eslint-react/shared 1.24.0-next.1 → 1.24.0-next.11

package/dist/index.js

@@ -417,29 +417,6 @@ function boolean(message) {
   };
 }
 // @__NO_SIDE_EFFECTS__
-function instance(class_, message) {
-  return {
-    kind: "schema",
-    type: "instance",
-    reference: instance,
-    expects: class_.name,
-    async: false,
-    class: class_,
-    message,
-    get "~standard"() {
-      return /* @__PURE__ */ _getStandardProps(this);
-    },
-    "~run"(dataset, config2) {
-      if (dataset.value instanceof this.class) {
-        dataset.typed = true;
-      } else {
-        _addIssue(this, "type", dataset, config2);
-      }
-      return dataset;
-    }
-  };
-}
-// @__NO_SIDE_EFFECTS__
 function object(entries, message) {
   return {
     kind: "schema",
@@ -557,30 +534,27 @@ function parse(schema, input, config2) {
 }
 
 // src/schemas.ts
-var CustomHookSchema = object({
-  // TODO: Define the schema for custom Hooks
-});
-var CustomAttributeSchema = object({
+var CustomComponentPropSchema = object({
   /**
-   * The name of the attribute in the user-defined component.
+   * The name of the prop in the user-defined component.
    * @example
    * "to"
    */
   name: string(),
   /**
-   * The name of the attribute in the built-in component.
+   * The name of the prop in the built-in component.
    * @example
    * "href"
    */
   as: optional(string()),
   /**
-   * Whether the attribute is controlled or not in the user-defined component.
+   * Whether the prop is controlled or not in the user-defined component.
    * @example
    * `true`
    */
   controlled: optional(boolean()),
   /**
-   * The default value of the attribute in the user-defined component.
+   * The default value of the prop in the user-defined component.
    * @example
    * `"/"`
    */
@@ -595,6 +569,7 @@ var CustomComponentSchema = object({
   name: string(),
   /**
    * The ESQuery selector to select the component precisely.
+   * @internal
    * @example
    * `JSXElement:has(JSXAttribute[name.name='component'][value.value='a'])`
    */
@@ -606,18 +581,32 @@ var CustomComponentSchema = object({
    */
   as: optional(string()),
   /**
-   * Pre-defined attributes that are used in the user-defined component.
+   * Attributes mapping between the user-defined component and the built-in component.
    * @example
    * `Link` component has a `to` attribute that represents the `href` attribute in the built-in `a` element with a default value of `"/"`.
    */
-  attributes: optional(array(CustomAttributeSchema))
+  attributes: optional(array(CustomComponentPropSchema))
 });
-var CustomComponentNormalizedSchema = object({
-  name: string(),
-  as: string(),
-  attributes: optional(array(CustomAttributeSchema), []),
-  re: instance(RegExp),
-  selector: optional(string())
+var CustomHooksSchema = object({
+  use: optional(array(string())),
+  useActionState: optional(array(string())),
+  useCallback: optional(array(string())),
+  useContext: optional(array(string())),
+  useDebugValue: optional(array(string())),
+  useDeferredValue: optional(array(string())),
+  useEffect: optional(array(string())),
+  useFormStatus: optional(array(string())),
+  useId: optional(array(string())),
+  useImperativeHandle: optional(array(string())),
+  useInsertionEffect: optional(array(string())),
+  useLayoutEffect: optional(array(string())),
+  useMemo: optional(array(string())),
+  useOptimistic: optional(array(string())),
+  useReducer: optional(array(string())),
+  useRef: optional(array(string())),
+  useState: optional(array(string())),
+  useSyncExternalStore: optional(array(string())),
+  useTransition: optional(array(string()))
 });
 var ESLintReactSettingsSchema = object({
   /**
@@ -626,41 +615,41 @@ var ESLintReactSettingsSchema = object({
    * @default `"react"`
    * @example `"@pika/react"`
    */
-  importSource: optional(string()),
+  importSource: optional(string(), "react"),
   /**
    * The identifier that’s used for JSX Element creation.
    * @default `"createElement"`
    * @deprecated
    */
-  jsxPragma: optional(string()),
+  jsxPragma: optional(string(), "createElement"),
   /**
    * 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"`
    * @deprecated
    */
-  jsxPragmaFrag: optional(string()),
+  jsxPragmaFrag: optional(string(), "Fragment"),
   /**
    * 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()),
+  polymorphicPropName: optional(string(), "as"),
   /**
    * @internal
    */
-  strict: optional(boolean()),
+  strict: optional(boolean(), false),
   /**
    * @internal
    */
-  strictImportCheck: optional(boolean()),
+  strictImportCheck: optional(boolean(), false),
   /**
    * 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()),
+  version: optional(string(), "detect"),
   /**
    * An array of user-defined components
    * @description This is used to inform the ESLint React plugins how to treat these components during checks.
@@ -668,31 +657,11 @@ var ESLintReactSettingsSchema = object({
    */
   additionalComponents: optional(array(CustomComponentSchema)),
   /**
-   * A object of aliases for React built-in hooks.
+   * A object to define additional hooks that are equivalent to the built-in React 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())),
-    useCallback: optional(array(string())),
-    useContext: optional(array(string())),
-    useDebugValue: optional(array(string())),
-    useDeferredValue: optional(array(string())),
-    useEffect: optional(array(string())),
-    useFormStatus: optional(array(string())),
-    useId: optional(array(string())),
-    useImperativeHandle: optional(array(string())),
-    useInsertionEffect: optional(array(string())),
-    useLayoutEffect: optional(array(string())),
-    useMemo: optional(array(string())),
-    useOptimistic: optional(array(string())),
-    useReducer: optional(array(string())),
-    useRef: optional(array(string())),
-    useState: optional(array(string())),
-    useSyncExternalStore: optional(array(string())),
-    useTransition: optional(array(string()))
-  }))
+  additionalHooks: optional(CustomHooksSchema)
 });
 var ESLintSettingsSchema = optional(
   object({
@@ -702,6 +671,12 @@ var ESLintSettingsSchema = optional(
   }),
   {}
 );
+var DEFAULT_ESLINT_REACT_SETTINGS = {
+  ...parse(ESLintReactSettingsSchema, {}),
+  additionalHooks: {
+    useLayoutEffect: ["useIsomorphicLayoutEffect"]
+  }
+};
 
 // ../../node_modules/.pnpm/fast-equals@5.2.2/node_modules/fast-equals/dist/esm/index.mjs
 var getOwnPropertyNames = Object.getOwnPropertyNames;
@@ -1396,14 +1371,6 @@ function createMemoizedFunction(fn, options) {
   memoized.options = normalizedOptions;
   return memoized;
 }
-var DEFAULT_ESLINT_REACT_SETTINGS = {
-  additionalHooks: {
-    useLayoutEffect: ["useIsomorphicLayoutEffect"]
-  },
-  polymorphicPropName: "as",
-  strictImportCheck: false,
-  version: "detect"
-};
 function unsafeDecodeSettings(data) {
   return data?.["react-x"] ?? {};
 }
@@ -1413,31 +1380,45 @@ var decodeSettings = createMemoizedFunction((data) => {
     ...parse(ESLintSettingsSchema, data)["react-x"] ?? {}
   };
 }, { isEqual: (a, b) => a === b });
-var normalizeSettings = createMemoizedFunction((settings) => {
-  const additionalComponents = settings.additionalComponents ?? [];
-  return {
-    ...settings,
-    additionalComponents: additionalComponents.map((component) => ({
-      ...component,
-      as: component.as ?? component.name,
-      attributes: component.attributes?.map((attr) => ({
-        ...attr,
-        as: attr.as ?? attr.name
-      })) ?? [],
-      re: pm__default.default.makeRe(component.name, { fastpaths: true })
-    })),
-    version: tsPattern.match(settings.version).with(tsPattern.P.union(tsPattern.P.nullish, "", "detect"), () => getReactVersion("19.0.0")).otherwise(eff.identity)
-  };
-}, { isEqual: shallowEqual });
+var toNormalizedSettings = createMemoizedFunction(
+  ({
+    additionalComponents = [],
+    additionalHooks = {},
+    version,
+    ...rest
+  }) => {
+    return {
+      ...rest,
+      additionalComponents: additionalComponents.map(({
+        name,
+        as = name,
+        attributes = [],
+        ...rest2
+      }) => ({
+        ...rest2,
+        name,
+        as,
+        attributes: attributes.map(({ name: name2, as: as2 = name2, ...rest3 }) => ({
+          ...rest3,
+          name: name2,
+          as: as2
+        })),
+        re: pm__default.default.makeRe(name, { fastpaths: true })
+      })),
+      additionalHooks,
+      version: tsPattern.match(version).with(tsPattern.P.union(tsPattern.P.nullish, "", "detect"), () => getReactVersion("19.0.0")).otherwise(eff.identity)
+    };
+  },
+  { isEqual: shallowEqual }
+);
 function getSettingsFromContext(context) {
-  return normalizeSettings(decodeSettings(context.settings));
+  return toNormalizedSettings(decodeSettings(context.settings));
 }
 var defineSettings = eff.identity;
 
-exports.CustomAttributeSchema = CustomAttributeSchema;
-exports.CustomComponentNormalizedSchema = CustomComponentNormalizedSchema;
+exports.CustomComponentPropSchema = CustomComponentPropSchema;
 exports.CustomComponentSchema = CustomComponentSchema;
-exports.CustomHookSchema = CustomHookSchema;
+exports.CustomHooksSchema = CustomHooksSchema;
 exports.DEFAULT_ESLINT_REACT_SETTINGS = DEFAULT_ESLINT_REACT_SETTINGS;
 exports.DOM_HTML_COMPONENT_TYPES = DOM_HTML_COMPONENT_TYPES;
 exports.DOM_SVG_COMPONENT_TYPES = DOM_SVG_COMPONENT_TYPES;
@@ -1458,5 +1439,5 @@ exports.decodeSettings = decodeSettings;
 exports.defineSettings = defineSettings;
 exports.getReactVersion = getReactVersion;
 exports.getSettingsFromContext = getSettingsFromContext;
-exports.normalizeSettings = normalizeSettings;
+exports.toNormalizedSettings = toNormalizedSettings;
 exports.unsafeDecodeSettings = unsafeDecodeSettings;

package/dist/index.mjs

@@ -409,29 +409,6 @@ function boolean(message) {
   };
 }
 // @__NO_SIDE_EFFECTS__
-function instance(class_, message) {
-  return {
-    kind: "schema",
-    type: "instance",
-    reference: instance,
-    expects: class_.name,
-    async: false,
-    class: class_,
-    message,
-    get "~standard"() {
-      return /* @__PURE__ */ _getStandardProps(this);
-    },
-    "~run"(dataset, config2) {
-      if (dataset.value instanceof this.class) {
-        dataset.typed = true;
-      } else {
-        _addIssue(this, "type", dataset, config2);
-      }
-      return dataset;
-    }
-  };
-}
-// @__NO_SIDE_EFFECTS__
 function object(entries, message) {
   return {
     kind: "schema",
@@ -549,30 +526,27 @@ function parse(schema, input, config2) {
 }
 
 // src/schemas.ts
-var CustomHookSchema = object({
-  // TODO: Define the schema for custom Hooks
-});
-var CustomAttributeSchema = object({
+var CustomComponentPropSchema = object({
   /**
-   * The name of the attribute in the user-defined component.
+   * The name of the prop in the user-defined component.
    * @example
    * "to"
    */
   name: string(),
   /**
-   * The name of the attribute in the built-in component.
+   * The name of the prop in the built-in component.
    * @example
    * "href"
    */
   as: optional(string()),
   /**
-   * Whether the attribute is controlled or not in the user-defined component.
+   * Whether the prop is controlled or not in the user-defined component.
    * @example
    * `true`
    */
   controlled: optional(boolean()),
   /**
-   * The default value of the attribute in the user-defined component.
+   * The default value of the prop in the user-defined component.
    * @example
    * `"/"`
    */
@@ -587,6 +561,7 @@ var CustomComponentSchema = object({
   name: string(),
   /**
    * The ESQuery selector to select the component precisely.
+   * @internal
    * @example
    * `JSXElement:has(JSXAttribute[name.name='component'][value.value='a'])`
    */
@@ -598,18 +573,32 @@ var CustomComponentSchema = object({
    */
   as: optional(string()),
   /**
-   * Pre-defined attributes that are used in the user-defined component.
+   * Attributes mapping between the user-defined component and the built-in component.
    * @example
    * `Link` component has a `to` attribute that represents the `href` attribute in the built-in `a` element with a default value of `"/"`.
    */
-  attributes: optional(array(CustomAttributeSchema))
+  attributes: optional(array(CustomComponentPropSchema))
 });
-var CustomComponentNormalizedSchema = object({
-  name: string(),
-  as: string(),
-  attributes: optional(array(CustomAttributeSchema), []),
-  re: instance(RegExp),
-  selector: optional(string())
+var CustomHooksSchema = object({
+  use: optional(array(string())),
+  useActionState: optional(array(string())),
+  useCallback: optional(array(string())),
+  useContext: optional(array(string())),
+  useDebugValue: optional(array(string())),
+  useDeferredValue: optional(array(string())),
+  useEffect: optional(array(string())),
+  useFormStatus: optional(array(string())),
+  useId: optional(array(string())),
+  useImperativeHandle: optional(array(string())),
+  useInsertionEffect: optional(array(string())),
+  useLayoutEffect: optional(array(string())),
+  useMemo: optional(array(string())),
+  useOptimistic: optional(array(string())),
+  useReducer: optional(array(string())),
+  useRef: optional(array(string())),
+  useState: optional(array(string())),
+  useSyncExternalStore: optional(array(string())),
+  useTransition: optional(array(string()))
 });
 var ESLintReactSettingsSchema = object({
   /**
@@ -618,41 +607,41 @@ var ESLintReactSettingsSchema = object({
    * @default `"react"`
    * @example `"@pika/react"`
    */
-  importSource: optional(string()),
+  importSource: optional(string(), "react"),
   /**
    * The identifier that’s used for JSX Element creation.
    * @default `"createElement"`
    * @deprecated
    */
-  jsxPragma: optional(string()),
+  jsxPragma: optional(string(), "createElement"),
   /**
    * 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"`
    * @deprecated
    */
-  jsxPragmaFrag: optional(string()),
+  jsxPragmaFrag: optional(string(), "Fragment"),
   /**
    * 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()),
+  polymorphicPropName: optional(string(), "as"),
   /**
    * @internal
    */
-  strict: optional(boolean()),
+  strict: optional(boolean(), false),
   /**
    * @internal
    */
-  strictImportCheck: optional(boolean()),
+  strictImportCheck: optional(boolean(), false),
   /**
    * 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()),
+  version: optional(string(), "detect"),
   /**
    * An array of user-defined components
    * @description This is used to inform the ESLint React plugins how to treat these components during checks.
@@ -660,31 +649,11 @@ var ESLintReactSettingsSchema = object({
    */
   additionalComponents: optional(array(CustomComponentSchema)),
   /**
-   * A object of aliases for React built-in hooks.
+   * A object to define additional hooks that are equivalent to the built-in React 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())),
-    useCallback: optional(array(string())),
-    useContext: optional(array(string())),
-    useDebugValue: optional(array(string())),
-    useDeferredValue: optional(array(string())),
-    useEffect: optional(array(string())),
-    useFormStatus: optional(array(string())),
-    useId: optional(array(string())),
-    useImperativeHandle: optional(array(string())),
-    useInsertionEffect: optional(array(string())),
-    useLayoutEffect: optional(array(string())),
-    useMemo: optional(array(string())),
-    useOptimistic: optional(array(string())),
-    useReducer: optional(array(string())),
-    useRef: optional(array(string())),
-    useState: optional(array(string())),
-    useSyncExternalStore: optional(array(string())),
-    useTransition: optional(array(string()))
-  }))
+  additionalHooks: optional(CustomHooksSchema)
 });
 var ESLintSettingsSchema = optional(
   object({
@@ -694,6 +663,12 @@ var ESLintSettingsSchema = optional(
   }),
   {}
 );
+var DEFAULT_ESLINT_REACT_SETTINGS = {
+  ...parse(ESLintReactSettingsSchema, {}),
+  additionalHooks: {
+    useLayoutEffect: ["useIsomorphicLayoutEffect"]
+  }
+};
 
 // ../../node_modules/.pnpm/fast-equals@5.2.2/node_modules/fast-equals/dist/esm/index.mjs
 var getOwnPropertyNames = Object.getOwnPropertyNames;
@@ -1388,14 +1363,6 @@ function createMemoizedFunction(fn, options) {
   memoized.options = normalizedOptions;
   return memoized;
 }
-var DEFAULT_ESLINT_REACT_SETTINGS = {
-  additionalHooks: {
-    useLayoutEffect: ["useIsomorphicLayoutEffect"]
-  },
-  polymorphicPropName: "as",
-  strictImportCheck: false,
-  version: "detect"
-};
 function unsafeDecodeSettings(data) {
   return data?.["react-x"] ?? {};
 }
@@ -1405,25 +1372,40 @@ var decodeSettings = createMemoizedFunction((data) => {
     ...parse(ESLintSettingsSchema, data)["react-x"] ?? {}
   };
 }, { isEqual: (a, b) => a === b });
-var normalizeSettings = createMemoizedFunction((settings) => {
-  const additionalComponents = settings.additionalComponents ?? [];
-  return {
-    ...settings,
-    additionalComponents: additionalComponents.map((component) => ({
-      ...component,
-      as: component.as ?? component.name,
-      attributes: component.attributes?.map((attr) => ({
-        ...attr,
-        as: attr.as ?? attr.name
-      })) ?? [],
-      re: pm.makeRe(component.name, { fastpaths: true })
-    })),
-    version: match(settings.version).with(P.union(P.nullish, "", "detect"), () => getReactVersion("19.0.0")).otherwise(identity)
-  };
-}, { isEqual: shallowEqual });
+var toNormalizedSettings = createMemoizedFunction(
+  ({
+    additionalComponents = [],
+    additionalHooks = {},
+    version,
+    ...rest
+  }) => {
+    return {
+      ...rest,
+      additionalComponents: additionalComponents.map(({
+        name,
+        as = name,
+        attributes = [],
+        ...rest2
+      }) => ({
+        ...rest2,
+        name,
+        as,
+        attributes: attributes.map(({ name: name2, as: as2 = name2, ...rest3 }) => ({
+          ...rest3,
+          name: name2,
+          as: as2
+        })),
+        re: pm.makeRe(name, { fastpaths: true })
+      })),
+      additionalHooks,
+      version: match(version).with(P.union(P.nullish, "", "detect"), () => getReactVersion("19.0.0")).otherwise(identity)
+    };
+  },
+  { isEqual: shallowEqual }
+);
 function getSettingsFromContext(context) {
-  return normalizeSettings(decodeSettings(context.settings));
+  return toNormalizedSettings(decodeSettings(context.settings));
 }
 var defineSettings = identity;
 
-export { CustomAttributeSchema, CustomComponentNormalizedSchema, CustomComponentSchema, CustomHookSchema, DEFAULT_ESLINT_REACT_SETTINGS, DOM_HTML_COMPONENT_TYPES, DOM_SVG_COMPONENT_TYPES, ESLintReactSettingsSchema, ESLintSettingsSchema, GITHUB_URL, 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, getReactVersion, getSettingsFromContext, normalizeSettings, unsafeDecodeSettings };
+export { CustomComponentPropSchema, CustomComponentSchema, CustomHooksSchema, DEFAULT_ESLINT_REACT_SETTINGS, DOM_HTML_COMPONENT_TYPES, DOM_SVG_COMPONENT_TYPES, ESLintReactSettingsSchema, ESLintSettingsSchema, GITHUB_URL, 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, getReactVersion, getSettingsFromContext, toNormalizedSettings, unsafeDecodeSettings };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "1.24.0-next.1",
+  "version": "1.24.0-next.11",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
@@ -33,10 +33,10 @@
     "./package.json"
   ],
   "dependencies": {
-    "@typescript-eslint/utils": "^8.19.1",
+    "@typescript-eslint/utils": "^8.20.0",
     "picomatch": "^4.0.2",
     "ts-pattern": "^5.6.0",
-    "@eslint-react/eff": "1.24.0-next.1"
+    "@eslint-react/eff": "1.24.0-next.11"
   },
   "devDependencies": {
     "@types/picomatch": "^3.0.1",