@eslint-react/shared 1.37.0 → 1.37.1-beta.3

package/dist/index.d.mts

@@ -1,7 +1,7 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
+import { _ } from '@eslint-react/eff';
 import * as tseslint from '@typescript-eslint/utils/ts-eslint';
 import { ReportDescriptor } from '@typescript-eslint/utils/ts-eslint';
-import { _ } from '@eslint-react/eff';
+import { ESLintUtils } from '@typescript-eslint/utils';
 
 /**
  * The NPM scope for this project.
@@ -38,21 +38,6 @@ declare const RE_CONSTANT_CASE: RegExp;
 declare const RE_JAVASCRIPT_PROTOCOL: RegExp;
 declare const REACT_BUILD_IN_HOOKS: readonly ["use", "useActionState", "useCallback", "useContext", "useDebugValue", "useDeferredValue", "useEffect", "useFormStatus", "useId", "useImperativeHandle", "useInsertionEffect", "useLayoutEffect", "useMemo", "useOptimistic", "useReducer", "useRef", "useState", "useSyncExternalStore", "useTransition"];
 
-/**
- * Get the ESLint rule creator for a plugin.
- * @internal
- * @param pluginName The name of the plugin.
- * @returns The ESLint rule creator.
- */
-declare const createRuleForPlugin: (pluginName: string) => <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, unknown>>) => ESLintUtils.RuleModule<MessageIds, Options, unknown, ESLintUtils.RuleListener>;
-
-declare function isInEditorEnv(): boolean;
-declare function isInGitHooksOrLintStaged(): boolean;
-
-declare const getId: () => string;
-
-declare function getReactVersion(fallback?: string): string;
-
 /**
  * Rule severity.
  * @since 0.0.1
@@ -90,7 +75,27 @@ type RuleFeature = "CFG" | "DBG" | "FIX" | "MOD" | "TSC";
  */
 type RuleStatus = "stable" | "experimental" | "deprecated" | "removed";
 
-declare function report<MessageID extends string>(context: RuleContext): (descriptor: undefined | null | ReportDescriptor<MessageID>) => void;
+/**
+ * Creates a report function that can conditionally report a descriptor.
+ * @param context - The context of the rule
+ * @returns A function that takes a descriptor and reports it if it's not null or undefined
+ */
+declare function createReport<MessageID extends string>(context: RuleContext): (descriptor: _ | null | ReportDescriptor<MessageID>) => void;
+
+/**
+ * Get the ESLint rule creator for a plugin.
+ * @internal
+ * @param pluginName The name of the plugin.
+ * @returns The ESLint rule creator.
+ */
+declare const createRuleForPlugin: (pluginName: string) => <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, unknown>>) => ESLintUtils.RuleModule<MessageIds, Options, unknown, ESLintUtils.RuleListener>;
+
+declare function isInEditorEnv(): boolean;
+declare function isInGitHooksOrLintStaged(): boolean;
+
+declare const getId: () => string;
+
+declare function getReactVersion(fallback?: string): string;
 
 /**
  * Fallback type.
@@ -2361,4 +2366,4 @@ declare module "@typescript-eslint/utils/ts-eslint" {
     }
 }
 
-export { type CustomComponent, type CustomComponentNormalized, type CustomComponentProp, type CustomComponentPropNormalized, CustomComponentPropSchema, CustomComponentSchema, type CustomHooks, CustomHooksSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, type ESLintReactSettingsNormalized, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, type RuleContext, type RuleDeclaration, type RuleFeature, type RuleNamespace, type RulePreset, type RuleSeverity, type RuleStatus, WEBSITE_URL, createRuleForPlugin, decodeSettings, defineSettings, getId, getReactVersion, getSettingsFromContext, isInEditorEnv, isInGitHooksOrLintStaged, report, toNormalizedSettings, unsafeDecodeSettings };
+export { type CustomComponent, type CustomComponentNormalized, type CustomComponentProp, type CustomComponentPropNormalized, CustomComponentPropSchema, CustomComponentSchema, type CustomHooks, CustomHooksSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, type ESLintReactSettingsNormalized, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, type RuleContext, type RuleDeclaration, type RuleFeature, type RuleNamespace, type RulePreset, type RuleSeverity, type RuleStatus, WEBSITE_URL, createReport, createRuleForPlugin, decodeSettings, defineSettings, getId, getReactVersion, getSettingsFromContext, isInEditorEnv, isInGitHooksOrLintStaged, toNormalizedSettings, unsafeDecodeSettings };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
+import { _ } from '@eslint-react/eff';
 import * as tseslint from '@typescript-eslint/utils/ts-eslint';
 import { ReportDescriptor } from '@typescript-eslint/utils/ts-eslint';
-import { _ } from '@eslint-react/eff';
+import { ESLintUtils } from '@typescript-eslint/utils';
 
 /**
  * The NPM scope for this project.
@@ -38,21 +38,6 @@ declare const RE_CONSTANT_CASE: RegExp;
 declare const RE_JAVASCRIPT_PROTOCOL: RegExp;
 declare const REACT_BUILD_IN_HOOKS: readonly ["use", "useActionState", "useCallback", "useContext", "useDebugValue", "useDeferredValue", "useEffect", "useFormStatus", "useId", "useImperativeHandle", "useInsertionEffect", "useLayoutEffect", "useMemo", "useOptimistic", "useReducer", "useRef", "useState", "useSyncExternalStore", "useTransition"];
 
-/**
- * Get the ESLint rule creator for a plugin.
- * @internal
- * @param pluginName The name of the plugin.
- * @returns The ESLint rule creator.
- */
-declare const createRuleForPlugin: (pluginName: string) => <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, unknown>>) => ESLintUtils.RuleModule<MessageIds, Options, unknown, ESLintUtils.RuleListener>;
-
-declare function isInEditorEnv(): boolean;
-declare function isInGitHooksOrLintStaged(): boolean;
-
-declare const getId: () => string;
-
-declare function getReactVersion(fallback?: string): string;
-
 /**
  * Rule severity.
  * @since 0.0.1
@@ -90,7 +75,27 @@ type RuleFeature = "CFG" | "DBG" | "FIX" | "MOD" | "TSC";
  */
 type RuleStatus = "stable" | "experimental" | "deprecated" | "removed";
 
-declare function report<MessageID extends string>(context: RuleContext): (descriptor: undefined | null | ReportDescriptor<MessageID>) => void;
+/**
+ * Creates a report function that can conditionally report a descriptor.
+ * @param context - The context of the rule
+ * @returns A function that takes a descriptor and reports it if it's not null or undefined
+ */
+declare function createReport<MessageID extends string>(context: RuleContext): (descriptor: _ | null | ReportDescriptor<MessageID>) => void;
+
+/**
+ * Get the ESLint rule creator for a plugin.
+ * @internal
+ * @param pluginName The name of the plugin.
+ * @returns The ESLint rule creator.
+ */
+declare const createRuleForPlugin: (pluginName: string) => <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, unknown>>) => ESLintUtils.RuleModule<MessageIds, Options, unknown, ESLintUtils.RuleListener>;
+
+declare function isInEditorEnv(): boolean;
+declare function isInGitHooksOrLintStaged(): boolean;
+
+declare const getId: () => string;
+
+declare function getReactVersion(fallback?: string): string;
 
 /**
  * Fallback type.
@@ -2361,4 +2366,4 @@ declare module "@typescript-eslint/utils/ts-eslint" {
     }
 }
 
-export { type CustomComponent, type CustomComponentNormalized, type CustomComponentProp, type CustomComponentPropNormalized, CustomComponentPropSchema, CustomComponentSchema, type CustomHooks, CustomHooksSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, type ESLintReactSettingsNormalized, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, type RuleContext, type RuleDeclaration, type RuleFeature, type RuleNamespace, type RulePreset, type RuleSeverity, type RuleStatus, WEBSITE_URL, createRuleForPlugin, decodeSettings, defineSettings, getId, getReactVersion, getSettingsFromContext, isInEditorEnv, isInGitHooksOrLintStaged, report, toNormalizedSettings, unsafeDecodeSettings };
+export { type CustomComponent, type CustomComponentNormalized, type CustomComponentProp, type CustomComponentPropNormalized, CustomComponentPropSchema, CustomComponentSchema, type CustomHooks, CustomHooksSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, type ESLintReactSettingsNormalized, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, type RuleContext, type RuleDeclaration, type RuleFeature, type RuleNamespace, type RulePreset, type RuleSeverity, type RuleStatus, WEBSITE_URL, createReport, createRuleForPlugin, decodeSettings, defineSettings, getId, getReactVersion, getSettingsFromContext, isInEditorEnv, isInGitHooksOrLintStaged, toNormalizedSettings, unsafeDecodeSettings };

package/dist/index.js

@@ -43,6 +43,13 @@ var REACT_BUILD_IN_HOOKS = [
   "useSyncExternalStore",
   "useTransition"
 ];
+
+// src/create-report.ts
+function createReport(context) {
+  return (descriptor) => {
+    if (descriptor != null) context.report(descriptor);
+  };
+}
 var getDocsUrl = (pluginName) => (ruleName) => {
   if (pluginName === "x") {
     return `${WEBSITE_URL}/docs/rules/${ruleName}`;
@@ -77,13 +84,6 @@ function getReactVersion(fallback = "19.0.0") {
   }
 }
 
-// src/report.ts
-function report(context) {
-  return (descriptor) => {
-    if (descriptor != null) context.report(descriptor);
-  };
-}
-
 // ../../node_modules/.pnpm/valibot@1.0.0_typescript@5.8.2/node_modules/valibot/dist/index.js
 var store;
 // @__NO_SIDE_EFFECTS__
@@ -1334,6 +1334,7 @@ exports.RE_KEBAB_CASE = RE_KEBAB_CASE;
 exports.RE_PASCAL_CASE = RE_PASCAL_CASE;
 exports.RE_SNAKE_CASE = RE_SNAKE_CASE;
 exports.WEBSITE_URL = WEBSITE_URL;
+exports.createReport = createReport;
 exports.createRuleForPlugin = createRuleForPlugin;
 exports.decodeSettings = decodeSettings;
 exports.defineSettings = defineSettings;
@@ -1342,6 +1343,5 @@ exports.getReactVersion = getReactVersion;
 exports.getSettingsFromContext = getSettingsFromContext;
 exports.isInEditorEnv = isInEditorEnv;
 exports.isInGitHooksOrLintStaged = isInGitHooksOrLintStaged;
-exports.report = report;
 exports.toNormalizedSettings = toNormalizedSettings;
 exports.unsafeDecodeSettings = unsafeDecodeSettings;

package/dist/index.mjs

@@ -35,6 +35,13 @@ var REACT_BUILD_IN_HOOKS = [
   "useSyncExternalStore",
   "useTransition"
 ];
+
+// src/create-report.ts
+function createReport(context) {
+  return (descriptor) => {
+    if (descriptor != null) context.report(descriptor);
+  };
+}
 var getDocsUrl = (pluginName) => (ruleName) => {
   if (pluginName === "x") {
     return `${WEBSITE_URL}/docs/rules/${ruleName}`;
@@ -69,13 +76,6 @@ function getReactVersion(fallback = "19.0.0") {
   }
 }
 
-// src/report.ts
-function report(context) {
-  return (descriptor) => {
-    if (descriptor != null) context.report(descriptor);
-  };
-}
-
 // ../../node_modules/.pnpm/valibot@1.0.0_typescript@5.8.2/node_modules/valibot/dist/index.js
 var store;
 // @__NO_SIDE_EFFECTS__
@@ -1310,4 +1310,4 @@ function getSettingsFromContext(context) {
 }
 var defineSettings = identity;
 
-export { CustomComponentPropSchema, CustomComponentSchema, CustomHooksSchema, DEFAULT_ESLINT_REACT_SETTINGS, ESLintReactSettingsSchema, ESLintSettingsSchema, GITHUB_URL, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createRuleForPlugin, decodeSettings, defineSettings, getId, getReactVersion, getSettingsFromContext, isInEditorEnv, isInGitHooksOrLintStaged, report, toNormalizedSettings, unsafeDecodeSettings };
+export { CustomComponentPropSchema, CustomComponentSchema, CustomHooksSchema, DEFAULT_ESLINT_REACT_SETTINGS, ESLintReactSettingsSchema, ESLintSettingsSchema, GITHUB_URL, NPM_SCOPE, REACT_BUILD_IN_HOOKS, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createReport, createRuleForPlugin, decodeSettings, defineSettings, getId, getReactVersion, getSettingsFromContext, isInEditorEnv, isInGitHooksOrLintStaged, toNormalizedSettings, unsafeDecodeSettings };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "1.37.0",
+  "version": "1.37.1-beta.3",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
@@ -38,7 +38,7 @@
     "@typescript-eslint/utils": "^8.27.0",
     "picomatch": "^4.0.2",
     "ts-pattern": "^5.6.2",
-    "@eslint-react/eff": "1.37.0"
+    "@eslint-react/eff": "1.37.1-beta.3"
   },
   "devDependencies": {
     "@types/picomatch": "^3.0.2",