@eslint-react/kit 4.0.2-beta.0 → 4.0.2-beta.2

package/README.md

@@ -1,6 +1,6 @@
 # @eslint-react/kit
 
-ESLint React's toolkit for building custom React lint rules right inside your `eslint.config.ts`.
+ESLint React's toolkit for building custom React rules with JavasSript functions right inside your `eslint.config.ts`.
 
 ## Index
 
@@ -143,7 +143,7 @@ Returns a flat `Linter.Config` object with all registered rules set to `"error"`
 ```ts
 eslintReactKit()
   .use(noForwardRef) // no-arg factory
-  .use(forbidElements, { forbidden: new Map() }) // factory with inferred options
+  .use(version, "19") // factory with inferred options
   .getConfig();
 ```
 
@@ -153,23 +153,22 @@ Returns an `ESLint.Plugin` object containing the registered rules and plugin met
 
 ```ts
 const kit = eslintReactKit()
-  .use(noForwardRef)
-  .use(forbidElements, { forbidden: new Map() });
+  .use(noForwardRef);
+  .use(version, "19")
 
 // Retrieve the raw plugin object
 const plugin = kit.getPlugin();
-// => { meta: { name: "@eslint-react/kit", version: "..." }, rules: { "no-forward-ref": ..., "forbid-elements": ... } }
 
 // Use it in a custom flat config with your own namespace and severity
 export default [
   {
     files: ["**/*.{ts,tsx}"],
     plugins: {
-      "react-custom-rules": plugin,
+      react: plugin,
     },
     rules: {
-      "react-custom-rules/no-forward-ref": "error",
-      "react-custom-rules/forbid-elements": "warn",
+      "react/version": "error",
+      "react/no-forward-ref": "error",
     },
   },
 ];
@@ -259,11 +258,33 @@ Factory functions (context pre-bound):
 
 Pre-built identifier predicates (context pre-bound):
 
-`captureOwnerStack`, `childrenCount`, `childrenForEach`, `childrenMap`, `childrenOnly`, `childrenToArray`, `cloneElement`, `createContext`, `createElement`, `forwardRef`, `memo`, `lazy`
+- `captureOwnerStack`
+- `childrenCount`
+- `childrenForEach`
+- `childrenMap`
+- `childrenOnly`
+- `childrenToArray`
+- `cloneElement`
+- `createContext`
+- `createElement`
+- `forwardRef`
+- `memo`
+- `lazy`
 
 Pre-built call predicates (context pre-bound):
 
-`captureOwnerStackCall`, `childrenCountCall`, `childrenForEachCall`, `childrenMapCall`, `childrenOnlyCall`, `childrenToArrayCall`, `cloneElementCall`, `createContextCall`, `createElementCall`, `forwardRefCall`, `memoCall`, `lazyCall`
+- `captureOwnerStackCall`
+- `childrenCountCall`
+- `childrenForEachCall`
+- `childrenMapCall`
+- `childrenOnlyCall`
+- `childrenToArrayCall`
+- `cloneElementCall`
+- `createContextCall`
+- `createElementCall`
+- `forwardRefCall`
+- `memoCall`
+- `lazyCall`
 
 All React API predicates and factories have `context` pre-bound — no need to pass the rule context manually:
 
@@ -356,13 +377,13 @@ Exposes the normalized `react-x` settings from the ESLint shared configuration (
 ```ts
 import type { RuleDefinition } from "@eslint-react/kit";
 
-function requireReact19(): RuleDefinition {
+function version(major = "19"): RuleDefinition {
   return (context, { settings }) => ({
     Program(program) {
-      if (!settings.version.startsWith("19.")) {
+      if (!settings.version.startsWith(`${major}.`)) {
         context.report({
           node: program,
-          message: `This project requires React 19, but detected version ${settings.version}.`,
+          message: `This project requires React ${major}, but detected version ${settings.version}.`,
         });
       }
     },
@@ -531,32 +552,32 @@ Use `getPlugin()` when you want full control over the plugin namespace and rule
 import eslintReactKit from "@eslint-react/kit";
 import type { RuleDefinition } from "@eslint-react/kit";
 
-function noForwardRef(): RuleDefinition {
-  return (context, { is }) => ({
-    CallExpression(node) {
-      if (is.forwardRefCall(node)) {
-        context.report({ node, message: "forwardRef is deprecated in React 19." });
-      }
-    },
-  });
-}
-
-function requireReact19(): RuleDefinition {
+function version(major = "19"): RuleDefinition {
   return (context, { settings }) => ({
     Program(program) {
-      if (!settings.version.startsWith("19.")) {
+      if (!settings.version.startsWith(`${major}.`)) {
         context.report({
           node: program,
-          message: `This project requires React 19, but detected version ${settings.version}.`,
+          message: `This project requires React ${major}, but detected version ${settings.version}.`,
         });
       }
     },
   });
 }
 
+function noForwardRef(): RuleDefinition {
+  return (context, { is }) => ({
+    CallExpression(node) {
+      if (is.forwardRefCall(node)) {
+        context.report({ node, message: "forwardRef is deprecated in React 19." });
+      }
+    },
+  });
+}
+
 const kit = eslintReactKit()
-  .use(noForwardRef)
-  .use(requireReact19);
+  .use(noForwardRef);
+  .use(version, "19")
 
 // Instead of kit.getConfig(), use kit.getPlugin() for full control:
 const plugin = kit.getPlugin();
@@ -566,12 +587,12 @@ export default [
     files: ["**/*.{ts,tsx}"],
     plugins: {
       // Choose your own namespace
-      "react-custom": plugin,
+      react: plugin,
     },
     rules: {
       // Set individual severities
-      "react-custom/no-forward-ref": "error",
-      "react-custom/require-react-19": "error",
+      "react/no-forward-ref": "error",
+      "react/version": "error",
     },
   },
 ];

package/dist/index.d.ts

@@ -107,7 +107,7 @@ interface Builder {
   getPlugin(): ESLint.Plugin;
   use<F extends (...args: any[]) => RuleDefinition>(factory: F, ...args: Parameters<F>): Builder;
 }
-declare function eslintReactKit(): Builder;
+declare function build(): Builder;
 declare module "@typescript-eslint/utils/ts-eslint" {
   interface RuleContext<MessageIds extends string = string, Options extends readonly unknown[] = readonly unknown[]> {
     report(descriptor: {
@@ -125,4 +125,4 @@ declare module "@typescript-eslint/utils/ts-eslint" {
   }
 }
 //#endregion
-export { Builder, Collector, CollectorWithContext, RuleDefinition, type RuleFix, type RuleFixer, type RuleListener, eslintReactKit as default, merge };
+export { Builder, Collector, CollectorWithContext, RuleDefinition, type RuleFix, type RuleFixer, type RuleListener, build as default, merge };

package/dist/index.js

@@ -4,7 +4,7 @@ import { kebabCase } from "string-ts";
 
 //#region package.json
 var name = "@eslint-react/kit";
-var version = "4.0.2-beta.0";
+var version = "4.0.2-beta.2";
 
 //#endregion
 //#region src/index.ts
@@ -102,7 +102,7 @@ function makeRuleToolkit(context) {
 		settings: getSettingsFromContext(context)
 	};
 }
-function eslintReactKit() {
+function build() {
 	const idGen = new IdGenerator();
 	const rules = {};
 	const builder = {
@@ -141,4 +141,4 @@ function eslintReactKit() {
 }
 
 //#endregion
-export { eslintReactKit as default, merge };
+export { build as default, merge };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eslint-react/kit",
-  "version": "4.0.2-beta.0",
-  "description": "ESLint React's utility module for building custom rules.",
+  "version": "4.0.2-beta.2",
+  "description": "ESLint React's utility module for building custom React rules with JavasSript functions.",
   "keywords": [
     "react",
     "eslint",
@@ -38,9 +38,9 @@
   "dependencies": {
     "@typescript-eslint/utils": "^8.57.2",
     "string-ts": "^2.3.1",
-    "@eslint-react/ast": "4.0.2-beta.0",
-    "@eslint-react/core": "4.0.2-beta.0",
-    "@eslint-react/shared": "4.0.2-beta.0"
+    "@eslint-react/ast": "4.0.2-beta.2",
+    "@eslint-react/core": "4.0.2-beta.2",
+    "@eslint-react/shared": "4.0.2-beta.2"
   },
   "devDependencies": {
     "eslint": "^10.1.0",