@eslint-react/shared 2.0.0-next.146 → 2.0.0-next.148

package/dist/index.js

@@ -1,242 +1,192 @@
-import module from 'module';
-import path from 'path';
-import { identity, getOrElseUpdate } from '@eslint-react/eff';
-import { match, P } from 'ts-pattern';
-import { RegExp } from '@eslint-react/kit';
-import { z } from 'zod/v4';
+import module from "node:module";
+import path from "node:path";
+import { getOrElseUpdate, identity } from "@eslint-react/eff";
+import { P, match } from "ts-pattern";
+import { RegExp } from "@eslint-react/kit";
+import { z } from "zod/v4";
 
-// src/_id.ts
-var id = 0n;
-var getId = () => (id++).toString();
-var _require = module.createRequire(process.cwd() + path.sep);
+//#region src/_id.ts
+let id = 0n;
+/**
+* @internal
+*/
+const getId = () => (id++).toString();
 
-// src/constants.ts
-var NPM_SCOPE = "@eslint-react";
-var GITHUB_URL = "https://github.com/Rel1cx/eslint-react";
-var WEBSITE_URL = "https://eslint-react.xyz";
+//#endregion
+//#region src/_require.ts
+/**
+* @internal
+*/
+const _require = module.createRequire(process.cwd() + path.sep);
 
-// src/get-doc-url.ts
-var getDocsUrl = (pluginName) => (ruleName) => {
-  if (pluginName === "x") {
-    return `${WEBSITE_URL}/docs/rules/${ruleName}`;
-  }
-  return `${WEBSITE_URL}/docs/rules/${pluginName}-${ruleName}`;
+//#endregion
+//#region src/constants.ts
+/**
+* The NPM scope for this project.
+*/
+const NPM_SCOPE = "@eslint-react";
+/**
+* The GitHub repository for this project.
+*/
+const GITHUB_URL = "https://github.com/Rel1cx/eslint-react";
+/**
+* The URL to the project's website.
+*/
+const WEBSITE_URL = "https://eslint-react.xyz";
+
+//#endregion
+//#region src/get-doc-url.ts
+/**
+* Get the URL for the documentation of a rule in a plugin.
+* @internal
+* @param pluginName The name of the plugin.
+* @returns The URL for the documentation of a rule.
+*/
+const getDocsUrl = (pluginName) => (ruleName) => {
+	if (pluginName === "x") return `${WEBSITE_URL}/docs/rules/${ruleName}`;
+	return `${WEBSITE_URL}/docs/rules/${pluginName}-${ruleName}`;
 };
+
+//#endregion
+//#region src/get-react-version.ts
 function getReactVersion(fallback) {
-  try {
-    return match(_require("react")).with({ version: P.select(P.string) }, identity).otherwise(() => fallback);
-  } catch {
-    return fallback;
-  }
+	try {
+		return match(_require("react")).with({ version: P.select(P.string) }, identity).otherwise(() => fallback);
+	} catch {
+		return fallback;
+	}
 }
-var CustomComponentPropSchema = z.object({
-  /**
-   * The name of the prop in the user-defined component.
-   * @example
-   * "to"
-   */
-  name: z.string(),
-  /**
-   * The name of the prop in the host component.
-   * @example
-   * "href"
-   */
-  as: z.optional(z.string()),
-  /**
-   * Whether the prop is controlled or not in the user-defined component.
-   * @internal
-   * @example
-   * `true`
-   */
-  controlled: z.optional(z.boolean()),
-  /**
-   * The default value of the prop in the user-defined component.
-   * @example
-   * `"/"`
-   */
-  defaultValue: z.optional(z.string())
+
+//#endregion
+//#region src/settings.ts
+const CustomComponentPropSchema = z.object({
+	name: z.string(),
+	as: z.optional(z.string()),
+	controlled: z.optional(z.boolean()),
+	defaultValue: z.optional(z.string())
 });
-var CustomComponentSchema = z.object({
-  /**
-   * The name of the user-defined component.
-   * @example
-   * "Link"
-   */
-  name: z.string(),
-  /**
-   * The name of the host component that the user-defined component represents.
-   * @example
-   * "a"
-   */
-  as: z.optional(z.string()),
-  /**
-   * Attributes mapping between the user-defined component and the host 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: z.optional(z.array(CustomComponentPropSchema)),
-  /**
-   * The ESQuery selector to select the component precisely.
-   * @internal
-   * @example
-   * `JSXElement:has(JSXAttribute[name.name='component'][value.value='a'])`
-   */
-  selector: 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.
+*/
+const CustomComponentSchema = z.object({
+	name: z.string(),
+	as: z.optional(z.string()),
+	attributes: z.optional(z.array(CustomComponentPropSchema)),
+	selector: z.optional(z.string())
 });
-var CustomHooksSchema = z.object({
-  use: z.optional(z.array(z.string())),
-  useActionState: z.optional(z.array(z.string())),
-  useCallback: z.optional(z.array(z.string())),
-  useContext: z.optional(z.array(z.string())),
-  useDebugValue: z.optional(z.array(z.string())),
-  useDeferredValue: z.optional(z.array(z.string())),
-  useEffect: z.optional(z.array(z.string())),
-  useFormStatus: z.optional(z.array(z.string())),
-  useId: z.optional(z.array(z.string())),
-  useImperativeHandle: z.optional(z.array(z.string())),
-  useInsertionEffect: z.optional(z.array(z.string())),
-  useLayoutEffect: z.optional(z.array(z.string())),
-  useMemo: z.optional(z.array(z.string())),
-  useOptimistic: z.optional(z.array(z.string())),
-  useReducer: z.optional(z.array(z.string())),
-  useRef: z.optional(z.array(z.string())),
-  useState: z.optional(z.array(z.string())),
-  useSyncExternalStore: z.optional(z.array(z.string())),
-  useTransition: z.optional(z.array(z.string()))
+const CustomHooksSchema = z.object({
+	use: z.optional(z.array(z.string())),
+	useActionState: z.optional(z.array(z.string())),
+	useCallback: z.optional(z.array(z.string())),
+	useContext: z.optional(z.array(z.string())),
+	useDebugValue: z.optional(z.array(z.string())),
+	useDeferredValue: z.optional(z.array(z.string())),
+	useEffect: z.optional(z.array(z.string())),
+	useFormStatus: z.optional(z.array(z.string())),
+	useId: z.optional(z.array(z.string())),
+	useImperativeHandle: z.optional(z.array(z.string())),
+	useInsertionEffect: z.optional(z.array(z.string())),
+	useLayoutEffect: z.optional(z.array(z.string())),
+	useMemo: z.optional(z.array(z.string())),
+	useOptimistic: z.optional(z.array(z.string())),
+	useReducer: z.optional(z.array(z.string())),
+	useRef: z.optional(z.array(z.string())),
+	useState: z.optional(z.array(z.string())),
+	useSyncExternalStore: z.optional(z.array(z.string())),
+	useTransition: z.optional(z.array(z.string()))
 });
-var ESLintReactSettingsSchema = z.object({
-  /**
-   * The source where React is imported from.
-   * @description This allows to specify a custom import location for React when not using the official distribution.
-   * @default `"react"`
-   * @example `"@pika/react"`
-   */
-  importSource: z.optional(z.string()),
-  /**
-   * 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: z.optional(z.string()),
-  /**
-   * @default `true`
-   * @internal
-   */
-  strict: z.optional(z.boolean()),
-  /**
-   * Check both the shape and the import to determine if an API is from React.
-   * @default `true`
-   * @internal
-   */
-  skipImportCheck: z.optional(z.boolean()),
-  /**
-   * 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: z.optional(z.string()),
-  /**
-   * 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 `{ useEffect: ["useIsomorphicLayoutEffect"] }`
-   */
-  additionalHooks: z.optional(CustomHooksSchema),
-  /**
-   * An array of user-defined components
-   * @description This is used to inform the ESLint React plugins how to treat these components during checks.
-   * @example `[{ name: "Link", as: "a", attributes: [{ name: "to", as: "href" }, { name: "rel", defaultValue: "noopener noreferrer" }] }]`
-   */
-  additionalComponents: z.optional(z.array(CustomComponentSchema))
+/**
+* @internal
+*/
+const ESLintReactSettingsSchema = z.object({
+	importSource: z.optional(z.string()),
+	polymorphicPropName: z.optional(z.string()),
+	strict: z.optional(z.boolean()),
+	skipImportCheck: z.optional(z.boolean()),
+	version: z.optional(z.string()),
+	additionalHooks: z.optional(CustomHooksSchema),
+	additionalComponents: z.optional(z.array(CustomComponentSchema))
 });
-var ESLintSettingsSchema = z.optional(
-  z.object({
-    "react-x": z.optional(z.unknown())
-  })
-);
+/**
+* @internal
+*/
+const ESLintSettingsSchema = z.optional(z.object({ "react-x": z.optional(z.unknown()) }));
 function isESLintSettings(settings) {
-  return ESLintSettingsSchema.safeParse(settings).success;
+	return ESLintSettingsSchema.safeParse(settings).success;
 }
 function isESLintReactSettings(settings) {
-  return ESLintReactSettingsSchema.safeParse(settings).success;
+	return ESLintReactSettingsSchema.safeParse(settings).success;
 }
-var DEFAULT_ESLINT_REACT_SETTINGS = {
-  version: "detect",
-  importSource: "react",
-  strict: true,
-  skipImportCheck: true,
-  polymorphicPropName: "as",
-  additionalComponents: [],
-  additionalHooks: {
-    useEffect: ["useIsomorphicLayoutEffect"],
-    useLayoutEffect: ["useIsomorphicLayoutEffect"]
-  }
-};
-var DEFAULT_ESLINT_SETTINGS = {
-  "react-x": DEFAULT_ESLINT_REACT_SETTINGS
+/**
+* The default ESLint settings for "react-x".
+*/
+const DEFAULT_ESLINT_REACT_SETTINGS = {
+	version: "detect",
+	importSource: "react",
+	strict: true,
+	skipImportCheck: true,
+	polymorphicPropName: "as",
+	additionalComponents: [],
+	additionalHooks: {
+		useEffect: ["useIsomorphicLayoutEffect"],
+		useLayoutEffect: ["useIsomorphicLayoutEffect"]
+	}
 };
-var coerceESLintSettings = (settings) => {
-  return settings;
+const DEFAULT_ESLINT_SETTINGS = { "react-x": DEFAULT_ESLINT_REACT_SETTINGS };
+const coerceESLintSettings = (settings) => {
+	return settings;
 };
-var decodeESLintSettings = (settings) => {
-  if (isESLintSettings(settings)) {
-    return settings;
-  }
-  return DEFAULT_ESLINT_SETTINGS;
+const decodeESLintSettings = (settings) => {
+	if (isESLintSettings(settings)) return settings;
+	return DEFAULT_ESLINT_SETTINGS;
 };
-var coerceSettings = (settings) => {
-  return settings;
+const coerceSettings = (settings) => {
+	return settings;
 };
-var decodeSettings = (settings) => {
-  if (isESLintReactSettings(settings)) {
-    return settings;
-  }
-  return DEFAULT_ESLINT_REACT_SETTINGS;
+const decodeSettings = (settings) => {
+	if (isESLintReactSettings(settings)) return settings;
+	return DEFAULT_ESLINT_REACT_SETTINGS;
 };
-var normalizeSettings = ({
-  additionalComponents = [],
-  additionalHooks = {},
-  importSource = "react",
-  polymorphicPropName = "as",
-  skipImportCheck = true,
-  strict = true,
-  version,
-  ...rest
-}) => {
-  return {
-    ...rest,
-    components: additionalComponents.map((component) => {
-      const { name, as = name, attributes = [], ...rest2 } = component;
-      const re = RegExp.toRegExp(name);
-      return {
-        ...rest2,
-        name,
-        re,
-        as,
-        attributes: attributes.map(({ name: name2, as: as2 = name2, ...rest3 }) => ({
-          ...rest3,
-          name: name2,
-          as: as2
-        }))
-      };
-    }),
-    additionalHooks,
-    importSource,
-    polymorphicPropName,
-    skipImportCheck,
-    strict,
-    version: match(version).with(P.union(P.nullish, "", "detect"), () => getReactVersion("19.1.0")).otherwise(identity)
-  };
+const normalizeSettings = ({ additionalComponents = [], additionalHooks = {}, importSource = "react", polymorphicPropName = "as", skipImportCheck = true, strict = true, version,...rest }) => {
+	return {
+		...rest,
+		components: additionalComponents.map((component) => {
+			const { name, as = name, attributes = [],...rest$1 } = component;
+			const re = RegExp.toRegExp(name);
+			return {
+				...rest$1,
+				name,
+				re,
+				as,
+				attributes: attributes.map(({ name: name$1, as: as$1 = name$1,...rest$2 }) => ({
+					...rest$2,
+					name: name$1,
+					as: as$1
+				}))
+			};
+		}),
+		additionalHooks,
+		importSource,
+		polymorphicPropName,
+		skipImportCheck,
+		strict,
+		version: match(version).with(P.union(P.nullish, "", "detect"), () => getReactVersion("19.1.0")).otherwise(identity)
+	};
 };
-var cache = /* @__PURE__ */ new Map();
+const cache = /* @__PURE__ */ new Map();
 function getSettingsFromContext(context) {
-  const settings = context.settings;
-  return getOrElseUpdate(
-    cache,
-    settings["react-x"],
-    () => normalizeSettings(decodeSettings(settings["react-x"]))
-  );
+	const settings = context.settings;
+	return getOrElseUpdate(cache, settings["react-x"], () => normalizeSettings(decodeSettings(settings["react-x"])));
 }
-var defineSettings = identity;
+/**
+* A helper function to define settings for "react-x" with type checking in JavaScript files.
+* @param settings The settings.
+* @returns The settings.
+*/
+const defineSettings = identity;
 
-export { CustomComponentPropSchema, CustomComponentSchema, CustomHooksSchema, DEFAULT_ESLINT_REACT_SETTINGS, DEFAULT_ESLINT_SETTINGS, ESLintReactSettingsSchema, ESLintSettingsSchema, GITHUB_URL, NPM_SCOPE, WEBSITE_URL, _require, coerceESLintSettings, coerceSettings, decodeESLintSettings, decodeSettings, defineSettings, getDocsUrl, getId, getReactVersion, getSettingsFromContext, isESLintReactSettings, isESLintSettings, normalizeSettings };
+//#endregion
+export { CustomComponentPropSchema, CustomComponentSchema, CustomHooksSchema, DEFAULT_ESLINT_REACT_SETTINGS, DEFAULT_ESLINT_SETTINGS, ESLintReactSettingsSchema, ESLintSettingsSchema, GITHUB_URL, NPM_SCOPE, WEBSITE_URL, _require, coerceESLintSettings, coerceSettings, decodeESLintSettings, decodeSettings, defineSettings, getDocsUrl, getId, getReactVersion, getSettingsFromContext, isESLintReactSettings, isESLintSettings, normalizeSettings };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "2.0.0-next.146",
+  "version": "2.0.0-next.148",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
@@ -27,16 +27,16 @@
     "./package.json"
   ],
   "dependencies": {
-    "@typescript-eslint/utils": "^8.40.0",
+    "@typescript-eslint/utils": "^8.41.0",
     "ts-pattern": "^5.8.0",
-    "zod": "^4.1.1",
-    "@eslint-react/eff": "2.0.0-next.146",
-    "@eslint-react/kit": "2.0.0-next.146"
+    "zod": "^4.1.3",
+    "@eslint-react/eff": "2.0.0-next.148",
+    "@eslint-react/kit": "2.0.0-next.148"
   },
   "devDependencies": {
     "@tsconfig/node22": "^22.0.2",
     "@types/picomatch": "^4.0.2",
-    "tsup": "^8.5.0",
+    "tsdown": "^0.14.2",
     "type-fest": "^4.41.0",
     "@local/configs": "0.0.0"
   },
@@ -44,7 +44,7 @@
     "node": ">=20.19.0"
   },
   "scripts": {
-    "build": "tsup --dts-resolve",
+    "build": "tsdown --dts-resolve",
     "build:docs": "typedoc",
     "lint:publish": "publint",
     "lint:ts": "tsc --noEmit"