uilint-eslint 0.2.9 → 0.2.10

package/dist/{chunk-IL6RYCMD.js → chunk-6EI7LWV5.js}

@@ -3,8 +3,12 @@ import { ESLintUtils } from "@typescript-eslint/utils";
 var createRule = ESLintUtils.RuleCreator(
   (name) => `https://github.com/peter-suggate/uilint/blob/main/packages/uilint-eslint/docs/rules/${name}.md`
 );
+function defineRuleMeta(meta) {
+  return meta;
+}
 
 export {
-  createRule
+  createRule,
+  defineRuleMeta
 };
-//# sourceMappingURL=chunk-IL6RYCMD.js.map
+//# sourceMappingURL=chunk-6EI7LWV5.js.map

package/dist/chunk-6EI7LWV5.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils/create-rule.ts"],"sourcesContent":["/**\n * Rule creation helper using @typescript-eslint/utils\n */\n\nimport { ESLintUtils } from \"@typescript-eslint/utils\";\n\nexport const createRule = ESLintUtils.RuleCreator(\n  (name) =>\n    `https://github.com/peter-suggate/uilint/blob/main/packages/uilint-eslint/docs/rules/${name}.md`\n);\n\n/**\n * Schema for prompting user to configure a rule option in the CLI\n */\nexport interface OptionFieldSchema {\n  /** Field name in the options object */\n  key: string;\n  /** Display label for the prompt */\n  label: string;\n  /** Prompt type */\n  type: \"text\" | \"number\" | \"boolean\" | \"select\" | \"multiselect\";\n  /** Default value */\n  defaultValue: unknown;\n  /** Placeholder text (for text/number inputs) */\n  placeholder?: string;\n  /** Options for select/multiselect */\n  options?: Array<{ value: string | number; label: string }>;\n  /** Description/hint for the field */\n  description?: string;\n}\n\n/**\n * Schema describing how to prompt for rule options during installation\n */\nexport interface RuleOptionSchema {\n  /** Fields that can be configured for this rule */\n  fields: OptionFieldSchema[];\n}\n\n/**\n * Colocated rule metadata - exported alongside each rule\n *\n * This structure keeps all rule metadata in the same file as the rule implementation,\n * making it easy to maintain and extend as new rules are added.\n */\nexport interface RuleMeta {\n  /** Rule identifier (e.g., \"no-arbitrary-tailwind\") - must match filename */\n  id: string;\n\n  /** Display name for CLI (e.g., \"No Arbitrary Tailwind\") */\n  name: string;\n\n  /** Short description for CLI selection prompts (one line) */\n  description: string;\n\n  /** Default severity level */\n  defaultSeverity: \"error\" | \"warn\" | \"off\";\n\n  /** Category for grouping in CLI */\n  category: \"static\" | \"semantic\";\n\n  /** Whether this rule requires a styleguide file */\n  requiresStyleguide?: boolean;\n\n  /** Default options for the rule (passed as second element in ESLint config) */\n  defaultOptions?: unknown[];\n\n  /** Schema for prompting user to configure options during install */\n  optionSchema?: RuleOptionSchema;\n\n  /**\n   * Detailed documentation in markdown format.\n   * Should include:\n   * - What the rule does\n   * - Why it's useful\n   * - Examples of incorrect and correct code\n   * - Configuration options explained\n   */\n  docs: string;\n}\n\n/**\n * Helper to define rule metadata with type safety\n */\nexport function defineRuleMeta(meta: RuleMeta): RuleMeta {\n  return meta;\n}\n"],"mappings":";AAIA,SAAS,mBAAmB;AAErB,IAAM,aAAa,YAAY;AAAA,EACpC,CAAC,SACC,uFAAuF,IAAI;AAC/F;AA2EO,SAAS,eAAe,MAA0B;AACvD,SAAO;AACT;","names":[]}

package/dist/index.d.ts

@@ -9,6 +9,72 @@ import { ESLintUtils } from '@typescript-eslint/utils';
 declare const createRule: <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, unknown>>) => ESLintUtils.RuleModule<MessageIds, Options, unknown, ESLintUtils.RuleListener> & {
     name: string;
 };
+/**
+ * Schema for prompting user to configure a rule option in the CLI
+ */
+interface OptionFieldSchema {
+    /** Field name in the options object */
+    key: string;
+    /** Display label for the prompt */
+    label: string;
+    /** Prompt type */
+    type: "text" | "number" | "boolean" | "select" | "multiselect";
+    /** Default value */
+    defaultValue: unknown;
+    /** Placeholder text (for text/number inputs) */
+    placeholder?: string;
+    /** Options for select/multiselect */
+    options?: Array<{
+        value: string | number;
+        label: string;
+    }>;
+    /** Description/hint for the field */
+    description?: string;
+}
+/**
+ * Schema describing how to prompt for rule options during installation
+ */
+interface RuleOptionSchema {
+    /** Fields that can be configured for this rule */
+    fields: OptionFieldSchema[];
+}
+/**
+ * Colocated rule metadata - exported alongside each rule
+ *
+ * This structure keeps all rule metadata in the same file as the rule implementation,
+ * making it easy to maintain and extend as new rules are added.
+ */
+interface RuleMeta {
+    /** Rule identifier (e.g., "no-arbitrary-tailwind") - must match filename */
+    id: string;
+    /** Display name for CLI (e.g., "No Arbitrary Tailwind") */
+    name: string;
+    /** Short description for CLI selection prompts (one line) */
+    description: string;
+    /** Default severity level */
+    defaultSeverity: "error" | "warn" | "off";
+    /** Category for grouping in CLI */
+    category: "static" | "semantic";
+    /** Whether this rule requires a styleguide file */
+    requiresStyleguide?: boolean;
+    /** Default options for the rule (passed as second element in ESLint config) */
+    defaultOptions?: unknown[];
+    /** Schema for prompting user to configure options during install */
+    optionSchema?: RuleOptionSchema;
+    /**
+     * Detailed documentation in markdown format.
+     * Should include:
+     * - What the rule does
+     * - Why it's useful
+     * - Examples of incorrect and correct code
+     * - Configuration options explained
+     */
+    docs: string;
+}
+/**
+ * Helper to define rule metadata with type safety
+ */
+declare function defineRuleMeta(meta: RuleMeta): RuleMeta;
 
 /**
  * Styleguide loader for the LLM semantic rule
@@ -139,74 +205,36 @@ declare function clearCache(): void;
  * Rule Registry
  *
  * Central registry of all UILint ESLint rules with metadata for CLI tooling.
- * This allows the installer to auto-discover available rules and present them
- * to the user with descriptions.
+ * Metadata is now colocated with each rule file - this module re-exports
+ * the collected metadata for use by installers and other tools.
  */
-/**
- * Schema for prompting user to configure a rule option
- */
-interface OptionFieldSchema {
-    /** Field name in the options object */
-    key: string;
-    /** Display label for the prompt */
-    label: string;
-    /** Prompt type */
-    type: "text" | "number" | "boolean" | "select" | "multiselect";
-    /** Default value */
-    defaultValue: unknown;
-    /** Placeholder text (for text/number inputs) */
-    placeholder?: string;
-    /** Options for select/multiselect */
-    options?: Array<{
-        value: string | number;
-        label: string;
-    }>;
-    /** Description/hint for the field */
-    description?: string;
-}
-/**
- * Schema describing how to prompt for rule options during installation
- */
-interface RuleOptionSchema {
-    /** Fields that can be configured for this rule */
-    fields: OptionFieldSchema[];
-}
-interface RuleMetadata {
-    /** Rule identifier (e.g., "no-arbitrary-tailwind") */
-    id: string;
-    /** Display name for CLI */
-    name: string;
-    /** Short description for CLI selection prompts */
-    description: string;
-    /** Default severity level */
-    defaultSeverity: "error" | "warn" | "off";
-    /** Default options for the rule */
-    defaultOptions?: unknown[];
-    /** Schema for prompting user to configure options during install */
-    optionSchema?: RuleOptionSchema;
-    /** Whether this rule requires a styleguide file */
-    requiresStyleguide?: boolean;
-    /** Category for grouping */
-    category: "static" | "semantic";
-}
+
 /**
  * Registry of all available UILint ESLint rules
  *
  * When adding a new rule:
- * 1. Add the rule implementation to src/rules/
- * 2. Add an entry here with metadata
- * 3. Export the rule from src/index.ts
- * 4. The CLI installer will automatically discover and offer it
+ * 1. Create the rule file in src/rules/
+ * 2. Export a `meta` object using `defineRuleMeta()`
+ * 3. Import and add the meta to this array
+ * 4. Run `pnpm generate:index` to regenerate exports
  */
-declare const ruleRegistry: RuleMetadata[];
+declare const ruleRegistry: RuleMeta[];
 /**
  * Get rule metadata by ID
  */
-declare function getRuleMetadata(id: string): RuleMetadata | undefined;
+declare function getRuleMetadata(id: string): RuleMeta | undefined;
 /**
  * Get all rules in a category
  */
-declare function getRulesByCategory(category: "static" | "semantic"): RuleMetadata[];
+declare function getRulesByCategory(category: "static" | "semantic"): RuleMeta[];
+/**
+ * Get documentation for a rule (useful for CLI help commands)
+ */
+declare function getRuleDocs(id: string): string | undefined;
+/**
+ * Get all rule IDs
+ */
+declare function getAllRuleIds(): string[];
 
 /**
  * All available rules
@@ -337,4 +365,4 @@ interface UILintESLint {
  */
 declare const uilintEslint: UILintESLint;
 
-export { type CacheEntry, type CacheStore, type CachedIssue, type LibraryName, type OptionFieldSchema, type RuleMetadata, type RuleOptionSchema, type UILintESLint, clearCache$1 as clearCache, clearCacheEntry, clearCache as clearImportGraphCache, configs, createRule, uilintEslint as default, findStyleguidePath, getCacheEntry, getComponentLibrary, getRuleMetadata, getRulesByCategory, getStyleguide, hashContent, hashContentSync, loadCache, loadStyleguide, meta, plugin, ruleRegistry, rules, saveCache, setCacheEntry };
+export { type CacheEntry, type CacheStore, type CachedIssue, type LibraryName, type OptionFieldSchema, type RuleMeta, type RuleMeta as RuleMetadata, type RuleOptionSchema, type UILintESLint, clearCache$1 as clearCache, clearCacheEntry, clearCache as clearImportGraphCache, configs, createRule, uilintEslint as default, defineRuleMeta, findStyleguidePath, getAllRuleIds, getCacheEntry, getComponentLibrary, getRuleDocs, getRuleMetadata, getRulesByCategory, getStyleguide, hashContent, hashContentSync, loadCache, loadStyleguide, meta, plugin, ruleRegistry, rules, saveCache, setCacheEntry };