@eslint-react/shared 1.6.1-beta.0 → 1.6.1-beta.2

package/dist/index.d.mts

@@ -8,18 +8,42 @@ import * as micro_memoize from 'micro-memoize';
  * Meta
  * -----------------------------------------------------------------------------
  */
+/**
+ * The NPM scope for this project.
+ */
 declare const NPM_SCOPE = "@eslint-react";
-declare const GITHUB_URL = "https://github.com/rel1cx/eslint-react/blob/main";
+/**
+ * The GitHub repository for this project.
+ */
+declare const GITHUB_URL = "https://github.com/rel1cx/eslint-react";
+/**
+ * The URL to the project's website.
+ */
 declare const WEBSITE_URL = "https://eslint-react.xyz";
 /**
  * -----------------------------------------------------------------------------
  * RegExps
  * -----------------------------------------------------------------------------
  */
+/**
+ * Regular expression for matching a PascalCase string.
+ */
 declare const RE_PASCAL_CASE: RegExp;
+/**
+ * Regular expression for matching a camelCase string.
+ */
 declare const RE_CAMEL_CASE: RegExp;
+/**
+ * Regular expression for matching a kebab-case string.
+ */
 declare const RE_KEBAB_CASE: RegExp;
+/**
+ * Regular expression for matching a snake_case string.
+ */
 declare const RE_SNAKE_CASE: RegExp;
+/**
+ * Regular expression for matching a CONSTANT_CASE string.
+ */
 declare const RE_CONSTANT_CASE: RegExp;
 declare const RE_JAVASCRIPT_PROTOCOL: RegExp;
 /**
@@ -36,6 +60,11 @@ declare const HOST_HTML_COMPONENT_TYPES: readonly ["aside", "audio", "b", "base"
  */
 declare const HOST_SVG_COMPONENT_TYPES: readonly ["a", "animate", "animateMotion", "animateTransform", "circle", "clipPath", "defs", "desc", "discard", "ellipse", "feBlend", "feColorMatrix", "feComponentTransfer", "feComposite", "feConvolveMatrix", "feDiffuseLighting", "feDisplacementMap", "feDistantLight", "feDropShadow", "feFlood", "feFuncA", "feFuncB", "feFuncG", "feFuncR", "feGaussianBlur", "feImage", "feMerge", "feMergeNode", "feMorphology", "feOffset", "fePointLight", "feSpecularLighting", "feSpotLight", "feTile", "feTurbulence", "filter", "foreignObject", "g", "hatch", "hatchpath", "image", "line", "linearGradient", "marker", "mask", "metadata", "mpath", "path", "pattern", "polygon", "polyline", "radialGradient", "rect", "script", "set", "stop", "style", "svg", "switch", "symbol", "text", "textPath", "title", "tspan", "use", "view"];
 
+/**
+ * Get the ESLint rule creator for a plugin.
+ * @param pluginName The name of the plugin.
+ * @returns The ESLint rule creator.
+ */
 declare const createRuleForPlugin: (pluginName: string) => <Options extends readonly unknown[], MessageIds extends string>({ name, meta, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds>>) => ESLintUtils.RuleModule<MessageIds, Options>;
 
 /**
@@ -379,12 +408,21 @@ declare const ESLintSettingsSchema: valibot.OptionalSchema<valibot.ObjectSchema<
         }, undefined>, never>;
     }, undefined>, {}>;
 }, undefined>, {}>;
-type CustomHook = InferOutput<typeof CustomHookSchema>;
-type CustomAttribute = InferOutput<typeof CustomAttributeSchema>;
-type CustomComponent = InferOutput<typeof CustomComponentSchema>;
-type ESLintReactSettings = InferOutput<typeof ESLintReactSettingsSchema>;
-type ESLintSettings = InferOutput<typeof ESLintSettingsSchema>;
+interface CustomHook extends InferOutput<typeof CustomHookSchema> {
+}
+interface CustomAttribute extends InferOutput<typeof CustomAttributeSchema> {
+}
+interface CustomComponent extends InferOutput<typeof CustomComponentSchema> {
+}
+interface ESLintReactSettings extends InferOutput<typeof ESLintReactSettingsSchema> {
+}
+interface ESLintSettings extends InferOutput<typeof ESLintSettingsSchema> {
+}
 
+/**
+ * This is an expanded version of `CustomComponent` with all shorthand properties expanded.
+ * @internal
+ */
 interface CustomComponentExpanded extends CustomComponent {
     attributes: {
         name: string;
@@ -392,11 +430,30 @@ interface CustomComponentExpanded extends CustomComponent {
     }[];
     re: RegExp;
 }
+/**
+ * This is an expanded version of `ESLintReactSettings` with all shorthand properties expanded.
+ * @internal
+ */
 interface ESLintReactSettingsExpanded extends ESLintReactSettings {
     additionalComponents: CustomComponentExpanded[];
 }
+/**
+ * Decodes settings from a data object from `context.settings`.
+ * @param data The data object.
+ * @returns settings The settings.
+ * @internal
+ */
 declare function decodeSettings(data: unknown): ESLintReactSettings;
+/**
+ * Expands the settings by converting all shorthand properties to their full form.
+ * @param settings The settings.
+ * @returns The expanded settings.
+ * @internal
+ */
 declare const expandSettings: micro_memoize.Memoized<(settings: ESLintReactSettings) => ESLintReactSettingsExpanded>;
+/**
+ * The default ESLint settings for "react-x".
+ */
 declare const DEFAULT_ESLINT_REACT_SETTINGS: ESLintReactSettings;
 
 export { type CustomAttribute, CustomAttributeSchema, type CustomComponent, type CustomComponentExpanded, CustomComponentSchema, type CustomHook, CustomHookSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, type ESLintReactSettingsExpanded, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, HOST_HTML_COMPONENT_TYPES, HOST_SVG_COMPONENT_TYPES, NPM_SCOPE, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createRuleForPlugin, decodeSettings, expandSettings };

package/dist/index.d.ts

@@ -8,18 +8,42 @@ import * as micro_memoize from 'micro-memoize';
  * Meta
  * -----------------------------------------------------------------------------
  */
+/**
+ * The NPM scope for this project.
+ */
 declare const NPM_SCOPE = "@eslint-react";
-declare const GITHUB_URL = "https://github.com/rel1cx/eslint-react/blob/main";
+/**
+ * The GitHub repository for this project.
+ */
+declare const GITHUB_URL = "https://github.com/rel1cx/eslint-react";
+/**
+ * The URL to the project's website.
+ */
 declare const WEBSITE_URL = "https://eslint-react.xyz";
 /**
  * -----------------------------------------------------------------------------
  * RegExps
  * -----------------------------------------------------------------------------
  */
+/**
+ * Regular expression for matching a PascalCase string.
+ */
 declare const RE_PASCAL_CASE: RegExp;
+/**
+ * Regular expression for matching a camelCase string.
+ */
 declare const RE_CAMEL_CASE: RegExp;
+/**
+ * Regular expression for matching a kebab-case string.
+ */
 declare const RE_KEBAB_CASE: RegExp;
+/**
+ * Regular expression for matching a snake_case string.
+ */
 declare const RE_SNAKE_CASE: RegExp;
+/**
+ * Regular expression for matching a CONSTANT_CASE string.
+ */
 declare const RE_CONSTANT_CASE: RegExp;
 declare const RE_JAVASCRIPT_PROTOCOL: RegExp;
 /**
@@ -36,6 +60,11 @@ declare const HOST_HTML_COMPONENT_TYPES: readonly ["aside", "audio", "b", "base"
  */
 declare const HOST_SVG_COMPONENT_TYPES: readonly ["a", "animate", "animateMotion", "animateTransform", "circle", "clipPath", "defs", "desc", "discard", "ellipse", "feBlend", "feColorMatrix", "feComponentTransfer", "feComposite", "feConvolveMatrix", "feDiffuseLighting", "feDisplacementMap", "feDistantLight", "feDropShadow", "feFlood", "feFuncA", "feFuncB", "feFuncG", "feFuncR", "feGaussianBlur", "feImage", "feMerge", "feMergeNode", "feMorphology", "feOffset", "fePointLight", "feSpecularLighting", "feSpotLight", "feTile", "feTurbulence", "filter", "foreignObject", "g", "hatch", "hatchpath", "image", "line", "linearGradient", "marker", "mask", "metadata", "mpath", "path", "pattern", "polygon", "polyline", "radialGradient", "rect", "script", "set", "stop", "style", "svg", "switch", "symbol", "text", "textPath", "title", "tspan", "use", "view"];
 
+/**
+ * Get the ESLint rule creator for a plugin.
+ * @param pluginName The name of the plugin.
+ * @returns The ESLint rule creator.
+ */
 declare const createRuleForPlugin: (pluginName: string) => <Options extends readonly unknown[], MessageIds extends string>({ name, meta, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds>>) => ESLintUtils.RuleModule<MessageIds, Options>;
 
 /**
@@ -379,12 +408,21 @@ declare const ESLintSettingsSchema: valibot.OptionalSchema<valibot.ObjectSchema<
         }, undefined>, never>;
     }, undefined>, {}>;
 }, undefined>, {}>;
-type CustomHook = InferOutput<typeof CustomHookSchema>;
-type CustomAttribute = InferOutput<typeof CustomAttributeSchema>;
-type CustomComponent = InferOutput<typeof CustomComponentSchema>;
-type ESLintReactSettings = InferOutput<typeof ESLintReactSettingsSchema>;
-type ESLintSettings = InferOutput<typeof ESLintSettingsSchema>;
+interface CustomHook extends InferOutput<typeof CustomHookSchema> {
+}
+interface CustomAttribute extends InferOutput<typeof CustomAttributeSchema> {
+}
+interface CustomComponent extends InferOutput<typeof CustomComponentSchema> {
+}
+interface ESLintReactSettings extends InferOutput<typeof ESLintReactSettingsSchema> {
+}
+interface ESLintSettings extends InferOutput<typeof ESLintSettingsSchema> {
+}
 
+/**
+ * This is an expanded version of `CustomComponent` with all shorthand properties expanded.
+ * @internal
+ */
 interface CustomComponentExpanded extends CustomComponent {
     attributes: {
         name: string;
@@ -392,11 +430,30 @@ interface CustomComponentExpanded extends CustomComponent {
     }[];
     re: RegExp;
 }
+/**
+ * This is an expanded version of `ESLintReactSettings` with all shorthand properties expanded.
+ * @internal
+ */
 interface ESLintReactSettingsExpanded extends ESLintReactSettings {
     additionalComponents: CustomComponentExpanded[];
 }
+/**
+ * Decodes settings from a data object from `context.settings`.
+ * @param data The data object.
+ * @returns settings The settings.
+ * @internal
+ */
 declare function decodeSettings(data: unknown): ESLintReactSettings;
+/**
+ * Expands the settings by converting all shorthand properties to their full form.
+ * @param settings The settings.
+ * @returns The expanded settings.
+ * @internal
+ */
 declare const expandSettings: micro_memoize.Memoized<(settings: ESLintReactSettings) => ESLintReactSettingsExpanded>;
+/**
+ * The default ESLint settings for "react-x".
+ */
 declare const DEFAULT_ESLINT_REACT_SETTINGS: ESLintReactSettings;
 
 export { type CustomAttribute, CustomAttributeSchema, type CustomComponent, type CustomComponentExpanded, CustomComponentSchema, type CustomHook, CustomHookSchema, DEFAULT_ESLINT_REACT_SETTINGS, type ESLintReactSettings, type ESLintReactSettingsExpanded, ESLintReactSettingsSchema, type ESLintSettings, ESLintSettingsSchema, GITHUB_URL, HOST_HTML_COMPONENT_TYPES, HOST_SVG_COMPONENT_TYPES, NPM_SCOPE, RE_CAMEL_CASE, RE_CONSTANT_CASE, RE_JAVASCRIPT_PROTOCOL, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_SNAKE_CASE, WEBSITE_URL, createRuleForPlugin, decodeSettings, expandSettings };

package/dist/index.js

@@ -9,7 +9,7 @@ var pm__default = /*#__PURE__*/_interopDefault(pm);
 
 // src/constants.ts
 var NPM_SCOPE = "@eslint-react";
-var GITHUB_URL = "https://github.com/rel1cx/eslint-react/blob/main";
+var GITHUB_URL = "https://github.com/rel1cx/eslint-react";
 var WEBSITE_URL = "https://eslint-react.xyz";
 var RE_PASCAL_CASE = /^[A-Z][\dA-Za-z]*$/u;
 var RE_CAMEL_CASE = /^[a-z][\dA-Za-z]*$/u;
@@ -867,7 +867,7 @@ var expandSettings = createMemoizedFunction((settings) => {
         ...attr,
         as: attr.as ?? attr.name
       })) ?? [],
-      re: pm__default.default.toRegex(pm__default.default.parse(component.name).output)
+      re: pm__default.default.makeRe(component.name, { fastpaths: true })
     })) ?? []
   };
 }, { isDeepEqual: false });

package/dist/index.mjs

@@ -3,7 +3,7 @@ import pm from 'picomatch';
 
 // src/constants.ts
 var NPM_SCOPE = "@eslint-react";
-var GITHUB_URL = "https://github.com/rel1cx/eslint-react/blob/main";
+var GITHUB_URL = "https://github.com/rel1cx/eslint-react";
 var WEBSITE_URL = "https://eslint-react.xyz";
 var RE_PASCAL_CASE = /^[A-Z][\dA-Za-z]*$/u;
 var RE_CAMEL_CASE = /^[a-z][\dA-Za-z]*$/u;
@@ -861,7 +861,7 @@ var expandSettings = createMemoizedFunction((settings) => {
         ...attr,
         as: attr.as ?? attr.name
       })) ?? [],
-      re: pm.toRegex(pm.parse(component.name).output)
+      re: pm.makeRe(component.name, { fastpaths: true })
     })) ?? []
   };
 }, { isDeepEqual: false });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "1.6.1-beta.0",
+  "version": "1.6.1-beta.2",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {