@eslint-react/shared 2.8.2-beta.5 → 2.8.2-beta.6

package/dist/index.d.ts

@@ -55,10 +55,16 @@ type RuleContext<MessageIds extends string = string, Options extends readonly un
  * @since 1.20.0
  */
 type RuleFeature = "CFG" | "DBG" | "FIX" | "MOD" | "TSC" | "EXP";
+/**
+ * The numeric policy value for a rule (severity level).
+ */
 type RulePolicy = number;
+/**
+ * A suggestion for fixing a reported issue.
+ */
 type RuleSuggest<MessageIds extends string = string> = {
-  messageId: MessageIds;
-  data?: Record<string, unknown>;
+  /** The message ID for the suggestion. */messageId: MessageIds; /** Optional data to pass to the message formatter. */
+  data?: Record<string, unknown>; /** The fix function to apply the suggestion. */
   fix: tseslint.ReportFixFunction;
 };
 /**
@@ -67,10 +73,18 @@ type RuleSuggest<MessageIds extends string = string> = {
 interface SettingsConfig {
   [key: string]: unknown;
 }
+/**
+ * A rule with a compatible shape for use with `defineConfig()` and `tseslint.config()`.
+ * Intentionally wide/inaccurate for compatibility purposes.
+ */
 interface CompatibleRule {
   meta: Record<string, any>;
   create: (...args: any[]) => any;
 }
+/**
+ * A plugin with a compatible shape for use with `defineConfig()` and `tseslint.config()`.
+ * Intentionally wide/inaccurate for compatibility purposes.
+ */
 interface CompatiblePlugin {
   meta: {
     name: string;
@@ -78,13 +92,26 @@ interface CompatiblePlugin {
   };
   rules: Record<string, CompatibleRule>;
 }
+/**
+ * A configuration object with a compatible shape for use with `defineConfig()` and `tseslint.config()`.
+ * Intentionally wide/inaccurate for compatibility purposes.
+ */
 interface CompatibleConfig {
+  /** Optional configuration name. */
   name?: string;
+  /** Rule configurations. */
   rules?: Record<string, RuleConfig>;
+  /** Shared settings. */
   settings?: SettingsConfig;
 }
 //#endregion
 //#region src/config-adapters.d.ts
+/**
+ * Get configuration adapters for converting between flat and legacy config formats
+ * @param pluginName The name of the plugin
+ * @param plugin The plugin instance
+ * @returns Object with toFlatConfig and toLegacyConfig functions
+ */
 declare function getConfigAdapters(pluginName: string, plugin: CompatiblePlugin): {
   readonly toFlatConfig: (config: CompatibleConfig) => {
     plugins: {
@@ -204,6 +231,11 @@ declare const RE_HOOK_NAME: RegExp;
 declare function defineRuleListener(base: RuleListener, ...rest: RuleListener[]): RuleListener;
 //#endregion
 //#region src/react-version.d.ts
+/**
+ * Gets 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.
+ */
 declare function getReactVersion(fallback: string): string;
 //#endregion
 //#region src/regexp.d.ts
@@ -230,6 +262,11 @@ declare function toRegExp(string: string | unit): RegExpLike;
 declare function isRegExp(string: string): boolean;
 //#endregion
 //#region src/report.d.ts
+/**
+ * Creates a report function for the given rule context.
+ * @param context The ESLint rule context.
+ * @returns A function that can be used to report violations.
+ */
 declare function report(context: RuleContext): (descriptor?: null | ReportDescriptor<string>) => void;
 //#endregion
 //#region src/settings.d.ts
@@ -250,7 +287,13 @@ declare const ESLintReactSettingsSchema: z.ZodObject<{
 declare const ESLintSettingsSchema: z.ZodOptional<z.ZodObject<{
   "react-x": z.ZodOptional<z.ZodUnknown>;
 }, z.core.$strip>>;
+/**
+ * ESLint settings type inferred from the settings schema.
+ */
 type ESLintSettings = z.infer<typeof ESLintSettingsSchema>;
+/**
+ * ESLint React settings type inferred from the React settings schema.
+ */
 type ESLintReactSettings = z.infer<typeof ESLintReactSettingsSchema>;
 /**
  * Normalized ESLint React settings with processed values

package/dist/index.js

@@ -30,6 +30,12 @@ var IdGenerator = class {
 
 //#endregion
 //#region src/config-adapters.ts
+/**
+* Get configuration adapters for converting between flat and legacy config formats
+* @param pluginName The name of the plugin
+* @param plugin The plugin instance
+* @returns Object with toFlatConfig and toLegacyConfig functions
+*/
 function getConfigAdapters(pluginName, plugin) {
 	function toFlatConfig(config) {
 		return {
@@ -164,6 +170,11 @@ function defineRuleListener(base, ...rest) {
 //#endregion
 //#region src/react-version.ts
 const _require = module.createRequire(process.cwd() + path.sep);
+/**
+* Gets 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(_require("react")).with({ version: P.select(P.string) }, identity).otherwise(() => fallback);
@@ -199,6 +210,11 @@ function isRegExp(string) {
 
 //#endregion
 //#region src/report.ts
+/**
+* Creates a report function for the given rule context.
+* @param context The ESLint rule context.
+* @returns A function that can be used to report violations.
+*/
 function report(context) {
 	return (descriptor) => {
 		if (descriptor == null) return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "2.8.2-beta.5",
+  "version": "2.8.2-beta.6",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
@@ -33,7 +33,7 @@
     "@typescript-eslint/utils": "^8.54.0",
     "ts-pattern": "^5.9.0",
     "zod": "^3.25.0 || ^4.0.0",
-    "@eslint-react/eff": "2.8.2-beta.5"
+    "@eslint-react/eff": "2.8.2-beta.6"
   },
   "devDependencies": {
     "@tsconfig/node22": "^22.0.5",