uilint-eslint 0.2.33 → 0.2.34

package/dist/index.d.ts

@@ -38,6 +38,17 @@ interface RuleOptionSchema {
     /** Fields that can be configured for this rule */
     fields: OptionFieldSchema[];
 }
+/**
+ * External requirement that a rule needs to function
+ */
+interface RuleRequirement {
+    /** Requirement type for programmatic checks */
+    type: "ollama" | "git" | "coverage" | "semantic-index" | "styleguide";
+    /** Human-readable description */
+    description: string;
+    /** Optional: how to satisfy the requirement */
+    setupHint?: string;
+}
 /**
  * Colocated rule metadata - exported alongside each rule
  *
@@ -55,6 +66,18 @@ interface RuleMeta {
     defaultSeverity: "error" | "warn" | "off";
     /** Category for grouping in CLI */
     category: "static" | "semantic";
+    /** Icon for display in CLI/UI (emoji or icon name) */
+    icon?: string;
+    /** Short hint about the rule type/requirements */
+    hint?: string;
+    /** Whether rule is enabled by default during install */
+    defaultEnabled?: boolean;
+    /** External requirements the rule needs */
+    requirements?: RuleRequirement[];
+    /** Instructions to show after installation */
+    postInstallInstructions?: string;
+    /** Framework compatibility */
+    frameworks?: ("next" | "vite" | "cra" | "remix")[];
     /** Whether this rule requires a styleguide file */
     requiresStyleguide?: boolean;
     /** Default options for the rule (passed as second element in ESLint config) */
@@ -221,6 +244,37 @@ declare function getComponentLibrary(contextFilePath: string, componentName: str
  */
 declare function clearCache(): void;
 
+/**
+ * Category Registry
+ *
+ * Centralized metadata for rule categories.
+ * Used by CLI installers and UI components to display category information
+ * without hardcoding assumptions.
+ */
+/**
+ * Metadata for a rule category
+ */
+interface CategoryMeta {
+    /** Category identifier */
+    id: "static" | "semantic";
+    /** Display name */
+    name: string;
+    /** Short description */
+    description: string;
+    /** Icon for display (emoji) */
+    icon: string;
+    /** Whether rules in this category are enabled by default during install */
+    defaultEnabled: boolean;
+}
+/**
+ * Registry of all rule categories
+ */
+declare const categoryRegistry: CategoryMeta[];
+/**
+ * Get metadata for a specific category
+ */
+declare function getCategoryMeta(id: string): CategoryMeta | undefined;
+
 /**
  * Rule Registry
  *
@@ -665,7 +719,7 @@ declare const rules: {
     }], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    "require-test-coverage": _typescript_eslint_utils_ts_eslint.RuleModule<"noTestFile" | "noCoverage" | "belowThreshold" | "noCoverageData" | "belowAggregateThreshold" | "jsxBelowThreshold", [{
+    "require-test-coverage": _typescript_eslint_utils_ts_eslint.RuleModule<"noCoverage" | "belowThreshold" | "noCoverageData" | "belowAggregateThreshold" | "jsxBelowThreshold" | "chunkBelowThreshold" | "untestedFunction", [{
         coveragePath?: string;
         threshold?: number;
         thresholdsByPattern?: Array<{
@@ -673,7 +727,6 @@ declare const rules: {
             threshold: number;
         }>;
         severity?: {
-            noTestFile?: "error" | "warn" | "off";
             noCoverage?: "error" | "warn" | "off";
             belowThreshold?: "error" | "warn" | "off";
         };
@@ -685,6 +738,11 @@ declare const rules: {
         aggregateSeverity?: "error" | "warn" | "off";
         jsxThreshold?: number;
         jsxSeverity?: "error" | "warn" | "off";
+        chunkCoverage?: boolean;
+        chunkThreshold?: number;
+        focusNonReact?: boolean;
+        relaxedThreshold?: number;
+        chunkSeverity?: "error" | "warn" | "off";
     }], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
@@ -801,7 +859,7 @@ declare const plugin: {
         }], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        "require-test-coverage": _typescript_eslint_utils_ts_eslint.RuleModule<"noTestFile" | "noCoverage" | "belowThreshold" | "noCoverageData" | "belowAggregateThreshold" | "jsxBelowThreshold", [{
+        "require-test-coverage": _typescript_eslint_utils_ts_eslint.RuleModule<"noCoverage" | "belowThreshold" | "noCoverageData" | "belowAggregateThreshold" | "jsxBelowThreshold" | "chunkBelowThreshold" | "untestedFunction", [{
             coveragePath?: string;
             threshold?: number;
             thresholdsByPattern?: Array<{
@@ -809,7 +867,6 @@ declare const plugin: {
                 threshold: number;
             }>;
             severity?: {
-                noTestFile?: "error" | "warn" | "off";
                 noCoverage?: "error" | "warn" | "off";
                 belowThreshold?: "error" | "warn" | "off";
             };
@@ -821,6 +878,11 @@ declare const plugin: {
             aggregateSeverity?: "error" | "warn" | "off";
             jsxThreshold?: number;
             jsxSeverity?: "error" | "warn" | "off";
+            chunkCoverage?: boolean;
+            chunkThreshold?: number;
+            focusNonReact?: boolean;
+            relaxedThreshold?: number;
+            chunkSeverity?: "error" | "warn" | "off";
         }], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
@@ -844,4 +906,4 @@ interface UILintESLint {
  */
 declare const uilintEslint: UILintESLint;
 
-export { type AggregatedCoverage, type CacheEntry, type CacheStore, type CachedIssue, type CoverageStats, type DependencyGraph, type FileCategory, type FileCategoryResult, type FileCoverageInfo, type IstanbulCoverage, type IstanbulFileCoverage, type JSXCoverageResult, type LibraryName, type OptionFieldSchema, type RuleMeta, type RuleMeta as RuleMetadata, type RuleOptionSchema, type SourceLocation, type UILintESLint, aggregateCoverage, analyzeJSXElementCoverage, buildDataLoc, buildDependencyGraph, calculateCoverageFromStatements, categorizeFile, clearCache$1 as clearCache, clearCacheEntry, clearCache as clearImportGraphCache, configs, createRule, uilintEslint as default, defineRuleMeta, findCoverageForFile, findStatementsInRange, findStyleguidePath, getAllRuleIds, getCacheEntry, getComponentLibrary, getRuleDocs, getRuleMetadata, getRulesByCategory, getStyleguide, hashContent, hashContentSync, isEventHandlerAttribute, loadCache, loadStyleguide, meta, plugin, ruleRegistry, rules, saveCache, setCacheEntry };
+export { type AggregatedCoverage, type CacheEntry, type CacheStore, type CachedIssue, type CategoryMeta, type CoverageStats, type DependencyGraph, type FileCategory, type FileCategoryResult, type FileCoverageInfo, type IstanbulCoverage, type IstanbulFileCoverage, type JSXCoverageResult, type LibraryName, type OptionFieldSchema, type RuleMeta, type RuleMeta as RuleMetadata, type RuleOptionSchema, type RuleRequirement, type SourceLocation, type UILintESLint, aggregateCoverage, analyzeJSXElementCoverage, buildDataLoc, buildDependencyGraph, calculateCoverageFromStatements, categorizeFile, categoryRegistry, clearCache$1 as clearCache, clearCacheEntry, clearCache as clearImportGraphCache, configs, createRule, uilintEslint as default, defineRuleMeta, findCoverageForFile, findStatementsInRange, findStyleguidePath, getAllRuleIds, getCacheEntry, getCategoryMeta, getComponentLibrary, getRuleDocs, getRuleMetadata, getRulesByCategory, getStyleguide, hashContent, hashContentSync, isEventHandlerAttribute, loadCache, loadStyleguide, meta, plugin, ruleRegistry, rules, saveCache, setCacheEntry };