@eslint-react/kit 4.0.0-beta.1 → 4.0.0-beta.2

package/README.md

@@ -14,6 +14,7 @@ ESLint React's toolkit for building custom React lint rules right inside your `e
     - [`kit.is`](#kitis) — Predicates
     - [`kit.hint`](#kithint) — Detection hint bit-flags
     - [`kit.flag`](#kitflag) — Component characteristic flags
+    - [`kit.settings`](#kitsettings) — Normalized ESLint React settings
 - [Examples](#examples)
   - [Simple: Ban `forwardRef`](#simple-ban-forwardref)
   - [Component: Destructure component props](#component-destructure-component-props)
@@ -115,6 +116,7 @@ kit
 ├── is                 -> All predicates (component, hook, React API, import source)
 ├── hint               -> Detection hint bit-flags
 ├── flag               -> Component characteristic bit-flags
+├── settings           -> Normalized ESLint React settings
 ```
 
 ---
@@ -253,6 +255,41 @@ for (const component of query.all(program)) {
 }
 ```
 
+#### `kit.settings`
+
+Exposes the normalized `react-x` settings from the ESLint shared configuration (`context.settings["react-x"]`). This lets your custom rules read and react to the same project-level settings used by the built-in rules.
+
+| Property                | Type                                                    | Default     | Description                                               |
+| ----------------------- | ------------------------------------------------------- | ----------- | --------------------------------------------------------- |
+| `version`               | `string`                                                | auto-detect | Resolved React version (e.g. `"19.2.4"`).                 |
+| `importSource`          | `string`                                                | `"react"`   | The module React is imported from (e.g. `"@pika/react"`). |
+| `compilationMode`       | `"infer" \| "annotation" \| "syntax" \| "all" \| "off"` | `"off"`     | The React Compiler compilation mode the project uses.     |
+| `polymorphicPropName`   | `string \| null`                                        | `"as"`      | Prop name used for polymorphic components.                |
+| `additionalStateHooks`  | `RegExpLike`                                            | —           | Pattern matching custom hooks treated as state hooks.     |
+| `additionalEffectHooks` | `RegExpLike`                                            | —           | Pattern matching custom hooks treated as effect hooks.    |
+
+`RegExpLike` is an object with a `test(s: string) => boolean` method (same interface as `RegExp`).
+
+**Usage:**
+
+```ts
+defineReactConfig({
+  name: "require-react-19",
+  make: (context, { settings }) => ({
+    Program(program) {
+      if (!settings.version.startsWith("19.")) {
+        context.report({
+          node: program,
+          message: `This project requires React 19, but detected version ${settings.version}.`,
+        });
+      }
+    },
+  }),
+});
+```
+
+---
+
 ## Examples
 
 ### Simple: Ban `forwardRef`

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import * as core from "@eslint-react/core";
+import { ESLintReactSettingsNormalized } from "@eslint-react/shared";
 import { TSESTreeFunction } from "@eslint-react/ast";
 import { TSESTree } from "@typescript-eslint/utils";
 import { RuleContext, RuleFix, RuleFixer, RuleListener } from "@typescript-eslint/utils/ts-eslint";
@@ -11,7 +12,7 @@ interface Collector<T> {
   };
   visitor: RuleListener;
 }
-interface CollectorWithContext<T, E> extends Collector<T> {
+interface CollectorWithContext<T> extends Collector<T> {
   query: {
     all(program: TSESTree.Program): T[];
   };
@@ -19,11 +20,8 @@ interface CollectorWithContext<T, E> extends Collector<T> {
 declare function components(ctx: RuleContext<string, unknown[]>, options?: {
   collectDisplayName?: boolean;
   hint?: bigint;
-}): CollectorWithContext<core.FunctionComponentSemanticNode, core.FunctionComponentSemanticNode>;
-declare function hooks(ctx: RuleContext<string, unknown[]>): CollectorWithContext<core.HookSemanticNode, {
-  key: string;
-  node: TSESTree.Node;
-}>;
+}): CollectorWithContext<core.FunctionComponentSemanticNode>;
+declare function hooks(ctx: RuleContext<string, unknown[]>): CollectorWithContext<core.HookSemanticNode>;
 interface RuleToolkit {
   is: {
     componentDefinition: (node: TSESTreeFunction, hint: bigint) => boolean;
@@ -101,6 +99,7 @@ interface RuleToolkit {
     components: typeof components;
     hooks: typeof hooks;
   };
+  settings: ESLintReactSettingsNormalized;
 }
 interface RuleDefinition {
   name: string;

package/dist/index.js

@@ -1,8 +1,9 @@
 import * as core from "@eslint-react/core";
+import { getSettingsFromContext } from "@eslint-react/shared";
 
 //#region package.json
 var name = "@eslint-react/kit";
-var version = "4.0.0-beta.1";
+var version = "4.0.0-beta.2";
 
 //#endregion
 //#region src/index.ts
@@ -94,7 +95,8 @@ function createKit(ctx) {
 		collect: {
 			components,
 			hooks
-		}
+		},
+		settings: getSettingsFromContext(ctx)
 	};
 }
 function defineConfig(...rules) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/kit",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0-beta.2",
   "description": "ESLint React's utility module for building custom rules.",
   "keywords": [
     "react",
@@ -37,14 +37,15 @@
   ],
   "dependencies": {
     "@typescript-eslint/utils": "^8.57.2",
-    "@eslint-react/ast": "4.0.0-beta.1",
-    "@eslint-react/core": "4.0.0-beta.1"
+    "@eslint-react/ast": "4.0.0-beta.2",
+    "@eslint-react/shared": "4.0.0-beta.2",
+    "@eslint-react/core": "4.0.0-beta.2"
   },
   "devDependencies": {
     "eslint": "^10.1.0",
-    "tsdown": "^0.21.4",
-    "@local/eff": "3.0.0-beta.72",
-    "@local/configs": "0.0.0"
+    "tsdown": "^0.21.5",
+    "@local/configs": "0.0.0",
+    "@local/eff": "3.0.0-beta.72"
   },
   "peerDependencies": {
     "eslint": "^10.0.0",