@eslint-react/shared 2.0.0-beta.55 → 2.0.0-beta.58

package/dist/index.d.ts

@@ -15,19 +15,6 @@ declare const getId: () => string;
  */
 declare const _require: NodeJS.Require;
 //#endregion
-//#region src/compatibility-types.d.ts
-interface CompatiblePlugin {
-  meta: {
-    name: string;
-    version: string;
-  };
-  rules: Record<string, any>;
-}
-interface CompatibleConfig {
-  name?: string;
-  rules?: Record<string, any>;
-}
-//#endregion
 //#region src/constants.d.ts
 /**
  * The NPM scope for this project.
@@ -55,6 +42,9 @@ declare const getDocsUrl: (pluginName: string) => (ruleName: string) => string;
 declare function getReactVersion(fallback: string): string;
 //#endregion
 //#region src/settings.d.ts
+/**
+ * Schema for component prop mapping between user-defined components and host components
+ */
 declare const CustomComponentPropSchema: z.ZodObject<{
   name: z.ZodString;
   as: z.ZodOptional<z.ZodString>;
@@ -62,10 +52,9 @@ declare const CustomComponentPropSchema: z.ZodObject<{
   defaultValue: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**
- * @description
- * This will provide some key information to the rule before checking for user-defined components.
- * For example:
- * Which prop is used as the `href` prop for the user-defined `Link` component that represents the built-in `a` element.
+ * Schema for custom components configuration
+ * Provides key information about user-defined components before validation
+ * Example: Which prop is used as the `href` prop in a custom `Link` component
  */
 declare const CustomComponentSchema: z.ZodObject<{
   name: z.ZodString;
@@ -78,6 +67,9 @@ declare const CustomComponentSchema: z.ZodObject<{
   }, z.core.$strip>>>;
   selector: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * Schema for custom hooks aliases that should be treated as React Hooks
+ */
 declare const CustomHooksSchema: z.ZodObject<{
   use: z.ZodOptional<z.ZodArray<z.ZodString>>;
   useActionState: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -100,6 +92,7 @@ declare const CustomHooksSchema: z.ZodObject<{
   useTransition: z.ZodOptional<z.ZodArray<z.ZodString>>;
 }, z.core.$strip>;
 /**
+ * Schema for ESLint React settings configuration
  * @internal
  */
 declare const ESLintReactSettingsSchema: z.ZodObject<{
@@ -142,6 +135,7 @@ declare const ESLintReactSettingsSchema: z.ZodObject<{
   }, z.core.$strip>>>;
 }, z.core.$strip>;
 /**
+ * Schema for ESLint settings
  * @internal
  */
 declare const ESLintSettingsSchema: z.ZodOptional<z.ZodObject<{
@@ -152,10 +146,39 @@ type CustomComponentProp = z.infer<typeof CustomComponentPropSchema>;
 type CustomHooks = z.infer<typeof CustomHooksSchema>;
 type ESLintSettings = z.infer<typeof ESLintSettingsSchema>;
 type ESLintReactSettings = z.infer<typeof ESLintReactSettingsSchema>;
-declare function isESLintSettings(settings: unknown): settings is ESLintSettings;
-declare function isESLintReactSettings(settings: unknown): settings is ESLintReactSettings;
 /**
- * The default ESLint settings for "react-x".
+ * Normalized representation of a custom component prop
+ */
+interface CustomComponentPropNormalized {
+  name: string;
+  as: string;
+  defaultValue?: string | unit;
+}
+/**
+ * Normalized representation of a custom component with RegExp for matching
+ */
+interface CustomComponentNormalized {
+  name: string;
+  as: string;
+  attributes: CustomComponentPropNormalized[];
+  re: {
+    test(s: string): boolean;
+  };
+}
+/**
+ * Normalized ESLint React settings with processed values
+ */
+interface ESLintReactSettingsNormalized {
+  additionalHooks: CustomHooks;
+  components: CustomComponentNormalized[];
+  importSource: string;
+  polymorphicPropName: string | unit;
+  skipImportCheck: boolean;
+  strict: boolean;
+  version: string;
+}
+/**
+ * Default ESLint React settings
  */
 declare const DEFAULT_ESLINT_REACT_SETTINGS: {
   readonly version: "detect";
@@ -169,6 +192,9 @@ declare const DEFAULT_ESLINT_REACT_SETTINGS: {
     readonly useLayoutEffect: ["useIsomorphicLayoutEffect"];
   };
 };
+/**
+ * Default ESLint settings with React settings included
+ */
 declare const DEFAULT_ESLINT_SETTINGS: {
   readonly "react-x": {
     readonly version: "detect";
@@ -183,32 +209,40 @@ declare const DEFAULT_ESLINT_SETTINGS: {
     };
   };
 };
-interface CustomComponentPropNormalized {
-  name: string;
-  as: string;
-  defaultValue?: string | unit;
-}
-interface CustomComponentNormalized {
-  name: string;
-  as: string;
-  attributes: CustomComponentPropNormalized[];
-  re: {
-    test(s: string): boolean;
-  };
-}
-interface ESLintReactSettingsNormalized {
-  additionalHooks: CustomHooks;
-  components: CustomComponentNormalized[];
-  importSource: string;
-  polymorphicPropName: string | unit;
-  skipImportCheck: boolean;
-  strict: boolean;
-  version: string;
-}
+/**
+ * Checks if the provided settings conform to ESLintSettings schema
+ * @param settings The settings object to validate
+ */
+declare function isESLintSettings(settings: unknown): settings is ESLintSettings;
+/**
+ * Checks if the provided settings conform to ESLintReactSettings schema
+ * @param settings The settings object to validate
+ */
+declare function isESLintReactSettings(settings: unknown): settings is ESLintReactSettings;
+/**
+ * Coerces unknown input to ESLintSettings type
+ * @param settings The settings object to coerce
+ */
 declare const coerceESLintSettings: (settings: unknown) => PartialDeep<ESLintSettings>;
+/**
+ * Decodes and validates ESLint settings, using defaults if invalid
+ * @param settings The settings object to decode
+ */
 declare const decodeESLintSettings: (settings: unknown) => ESLintSettings;
+/**
+ * Coerces unknown input to ESLintReactSettings type
+ * @param settings The settings object to coerce
+ */
 declare const coerceSettings: (settings: unknown) => PartialDeep<ESLintReactSettings>;
+/**
+ * Decodes and validates ESLint React settings, using defaults if invalid
+ * @param settings The settings object to decode
+ */
 declare const decodeSettings: (settings: unknown) => ESLintReactSettings;
+/**
+ * Normalizes ESLint React settings to a consistent internal format
+ * Transforms component definitions and resolves version information
+ */
 declare const normalizeSettings: ({
   additionalComponents,
   additionalHooks,
@@ -260,11 +294,15 @@ declare const normalizeSettings: ({
   readonly strict: boolean;
   readonly version: string;
 };
+/**
+ * Retrieves normalized ESLint React settings from the rule context
+ * Uses caching for performance optimization
+ * @param context The ESLint rule context
+ */
 declare function getSettingsFromContext(context: RuleContext): ESLintReactSettingsNormalized;
 /**
- * A helper function to define settings for "react-x" with type checking in JavaScript files.
- * @param settings The settings.
- * @returns The settings.
+ * Helper function for defining typed settings for "react-x" in JavaScript files
+ * Provides type checking without runtime transformation
  */
 declare const defineSettings: (settings: ESLintReactSettings) => ESLintReactSettings;
 declare module "@typescript-eslint/utils/ts-eslint" {
@@ -273,4 +311,4 @@ declare module "@typescript-eslint/utils/ts-eslint" {
   }
 }
 //#endregion
-export { CompatibleConfig, CompatiblePlugin, CustomComponent, CustomComponentNormalized, CustomComponentProp, CustomComponentPropNormalized, CustomComponentPropSchema, CustomComponentSchema, CustomHooks, CustomHooksSchema, DEFAULT_ESLINT_REACT_SETTINGS, DEFAULT_ESLINT_SETTINGS, ESLintReactSettings, ESLintReactSettingsNormalized, ESLintReactSettingsSchema, ESLintSettings, ESLintSettingsSchema, GITHUB_URL, NPM_SCOPE, WEBSITE_URL, _require, coerceESLintSettings, coerceSettings, decodeESLintSettings, decodeSettings, defineSettings, getDocsUrl, getId, getReactVersion, getSettingsFromContext, isESLintReactSettings, isESLintSettings, normalizeSettings };
+export { CustomComponent, CustomComponentNormalized, CustomComponentProp, CustomComponentPropNormalized, CustomComponentPropSchema, CustomComponentSchema, CustomHooks, CustomHooksSchema, DEFAULT_ESLINT_REACT_SETTINGS, DEFAULT_ESLINT_SETTINGS, ESLintReactSettings, ESLintReactSettingsNormalized, ESLintReactSettingsSchema, ESLintSettings, ESLintSettingsSchema, GITHUB_URL, NPM_SCOPE, WEBSITE_URL, _require, coerceESLintSettings, coerceSettings, decodeESLintSettings, decodeSettings, defineSettings, getDocsUrl, getId, getReactVersion, getSettingsFromContext, isESLintReactSettings, isESLintSettings, normalizeSettings };

package/dist/index.js

@@ -59,6 +59,9 @@ function getReactVersion(fallback) {
 
 //#endregion
 //#region src/settings.ts
+/**
+* Schema for component prop mapping between user-defined components and host components
+*/
 const CustomComponentPropSchema = z.object({
 	name: z.string(),
 	as: z.optional(z.string()),
@@ -66,10 +69,9 @@ const CustomComponentPropSchema = z.object({
 	defaultValue: z.optional(z.string())
 });
 /**
-* @description
-* This will provide some key information to the rule before checking for user-defined components.
-* For example:
-* Which prop is used as the `href` prop for the user-defined `Link` component that represents the built-in `a` element.
+* Schema for custom components configuration
+* Provides key information about user-defined components before validation
+* Example: Which prop is used as the `href` prop in a custom `Link` component
 */
 const CustomComponentSchema = z.object({
 	name: z.string(),
@@ -77,6 +79,9 @@ const CustomComponentSchema = z.object({
 	attributes: z.optional(z.array(CustomComponentPropSchema)),
 	selector: z.optional(z.string())
 });
+/**
+* Schema for custom hooks aliases that should be treated as React Hooks
+*/
 const CustomHooksSchema = z.object({
 	use: z.optional(z.array(z.string())),
 	useActionState: z.optional(z.array(z.string())),
@@ -99,6 +104,7 @@ const CustomHooksSchema = z.object({
 	useTransition: z.optional(z.array(z.string()))
 });
 /**
+* Schema for ESLint React settings configuration
 * @internal
 */
 const ESLintReactSettingsSchema = z.object({
@@ -111,17 +117,12 @@ const ESLintReactSettingsSchema = z.object({
 	additionalComponents: z.optional(z.array(CustomComponentSchema))
 });
 /**
+* Schema for ESLint settings
 * @internal
 */
 const ESLintSettingsSchema = z.optional(z.object({ "react-x": z.optional(z.unknown()) }));
-function isESLintSettings(settings) {
-	return ESLintSettingsSchema.safeParse(settings).success;
-}
-function isESLintReactSettings(settings) {
-	return ESLintReactSettingsSchema.safeParse(settings).success;
-}
 /**
-* The default ESLint settings for "react-x".
+* Default ESLint React settings
 */
 const DEFAULT_ESLINT_REACT_SETTINGS = {
 	version: "detect",
@@ -135,21 +136,58 @@ const DEFAULT_ESLINT_REACT_SETTINGS = {
 		useLayoutEffect: ["useIsomorphicLayoutEffect"]
 	}
 };
+/**
+* Default ESLint settings with React settings included
+*/
 const DEFAULT_ESLINT_SETTINGS = { "react-x": DEFAULT_ESLINT_REACT_SETTINGS };
+/**
+* Checks if the provided settings conform to ESLintSettings schema
+* @param settings The settings object to validate
+*/
+function isESLintSettings(settings) {
+	return ESLintSettingsSchema.safeParse(settings).success;
+}
+/**
+* Checks if the provided settings conform to ESLintReactSettings schema
+* @param settings The settings object to validate
+*/
+function isESLintReactSettings(settings) {
+	return ESLintReactSettingsSchema.safeParse(settings).success;
+}
+/**
+* Coerces unknown input to ESLintSettings type
+* @param settings The settings object to coerce
+*/
 const coerceESLintSettings = (settings) => {
 	return settings;
 };
+/**
+* Decodes and validates ESLint settings, using defaults if invalid
+* @param settings The settings object to decode
+*/
 const decodeESLintSettings = (settings) => {
 	if (isESLintSettings(settings)) return settings;
 	return DEFAULT_ESLINT_SETTINGS;
 };
+/**
+* Coerces unknown input to ESLintReactSettings type
+* @param settings The settings object to coerce
+*/
 const coerceSettings = (settings) => {
 	return settings;
 };
+/**
+* Decodes and validates ESLint React settings, using defaults if invalid
+* @param settings The settings object to decode
+*/
 const decodeSettings = (settings) => {
 	if (isESLintReactSettings(settings)) return settings;
 	return DEFAULT_ESLINT_REACT_SETTINGS;
 };
+/**
+* Normalizes ESLint React settings to a consistent internal format
+* Transforms component definitions and resolves version information
+*/
 const normalizeSettings = ({ additionalComponents = [], additionalHooks = {}, importSource = "react", polymorphicPropName = "as", skipImportCheck = true, strict = true, version,...rest }) => {
 	return {
 		...rest,
@@ -177,14 +215,18 @@ const normalizeSettings = ({ additionalComponents = [], additionalHooks = {}, im
 	};
 };
 const cache = /* @__PURE__ */ new Map();
+/**
+* Retrieves normalized ESLint React settings from the rule context
+* Uses caching for performance optimization
+* @param context The ESLint rule context
+*/
 function getSettingsFromContext(context) {
 	const settings = context.settings;
 	return getOrElseUpdate(cache, settings["react-x"], () => normalizeSettings(decodeSettings(settings["react-x"])));
 }
 /**
-* A helper function to define settings for "react-x" with type checking in JavaScript files.
-* @param settings The settings.
-* @returns The settings.
+* Helper function for defining typed settings for "react-x" in JavaScript files
+* Provides type checking without runtime transformation
 */
 const defineSettings = identity;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "2.0.0-beta.55",
+  "version": "2.0.0-beta.58",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
@@ -29,9 +29,9 @@
   "dependencies": {
     "@typescript-eslint/utils": "^8.41.0",
     "ts-pattern": "^5.8.0",
-    "zod": "^4.1.4",
-    "@eslint-react/eff": "2.0.0-beta.55",
-    "@eslint-react/kit": "2.0.0-beta.55"
+    "zod": "^4.1.5",
+    "@eslint-react/eff": "2.0.0-beta.58",
+    "@eslint-react/kit": "2.0.0-beta.58"
   },
   "devDependencies": {
     "@tsconfig/node22": "^22.0.2",