tailwind-unwind 0.3.0 → 0.5.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Node, CallExpression, Expression, JSXAttribute } from '@babel/types';
 
-type CliCommand = 'analyze' | 'generate' | 'apply';
+type CliCommand = 'analyze' | 'generate' | 'apply' | 'init';
 interface CommandConfig {
     minOccurrences?: number;
     minSize?: number;
@@ -31,6 +31,8 @@ interface TailwindUnwindConfig extends CommandConfig {
 }
 interface ResolvedCommandOptions extends TailwindUnwindConfig {
     configPath?: string;
+    changed?: boolean | string;
+    force?: boolean;
 }
 
 /**
@@ -82,6 +84,12 @@ interface AnalysisStats {
     totalClassUsages: number;
     topCombinations: ClassCombination[];
     potentialReductionPercent: number;
+    /** Exact duplicates eligible for generate/apply (not limited by --top) */
+    extractablePatternCount: number;
+    /** analyze min-occurrences used for the frequent-pattern list */
+    analyzeMinOccurrences: number;
+    /** threshold used to mark patterns as extractable */
+    extractableMinOccurrences: number;
 }
 interface AnalysisReport {
     targetPath: string;
@@ -90,6 +98,8 @@ interface AnalysisReport {
 }
 interface AnalyzeOptions {
     minOccurrences?: number;
+    /** Threshold for marking patterns as extractable (defaults to generate min-occurrences) */
+    extractableMinOccurrences?: number;
     minSize?: number;
     maxSize?: number;
     top?: number;
@@ -105,13 +115,73 @@ interface AnalyzeOptions {
     prettier?: boolean;
     fromReport?: string;
     extractableOnly?: boolean;
+    changed?: boolean | string;
+    force?: boolean;
+}
+
+interface InitOptions extends AnalyzeOptions {
+    output?: string;
+    force?: boolean;
 }
+interface InitResult {
+    configPath: string;
+    extractablePatterns: number;
+}
+/**
+ * Scan a project and write a starter tailwind-unwind.config.json.
+ */
+declare function initCommand(targetPath: string, options?: InitOptions): Promise<InitResult>;
 
 /**
  * Run the full analyze pipeline: scan → parse → find patterns → report.
  */
 declare function analyzeCommand(targetPath: string, options?: AnalyzeOptions): Promise<AnalysisReport>;
 
+interface PatternFinderOptions {
+    minOccurrences?: number;
+    minSize?: number;
+    maxSize?: number;
+    topLimit?: number;
+    dedupeSubsets?: boolean;
+}
+/**
+ * From every className occurrence, enumerate class subsets,
+ * count normalized combinations, and return the most frequent ones.
+ */
+declare function findFrequentPatterns(occurrences: ClassNameOccurrence[], options?: PatternFinderOptions): ClassCombination[];
+/**
+ * Find exact duplicate className sets (full class lists per element).
+ * Better suited for CSS generation than combinatorial subset search.
+ */
+declare function findRepeatedClassSets(occurrences: ClassNameOccurrence[], options?: PatternFinderOptions): ClassCombination[];
+/**
+ * Estimate how much repeated utility usage could be collapsed into components.
+ * Uses the best full combination: each redundant instance could replace N utilities with 1.
+ */
+declare function calculatePotentialReduction(occurrences: ClassNameOccurrence[], topCombinations: ClassCombination[]): number;
+
+interface ScanProjectOptions extends PatternFinderOptions {
+    targetPath: string;
+    include?: string[];
+    exclude?: string[];
+    /** Threshold used to mark combinations as extractable by generate/apply */
+    extractableMinOccurrences?: number;
+    /** Scan only git-changed files; string value is the git ref to diff against */
+    changed?: boolean | string;
+}
+interface ScanProjectResult {
+    resolvedPath: string;
+    files: string[];
+    occurrences: ClassNameOccurrence[];
+    warnings: string[];
+    report: AnalysisReport;
+    extractableCombinations: ClassCombination[];
+}
+/**
+ * Scan a directory, parse className usage, and build an analysis report.
+ */
+declare function scanProject(options: ScanProjectOptions): Promise<ScanProjectResult>;
+
 interface GeneratedComponent {
     className: string;
     classes: string[];
@@ -139,29 +209,6 @@ declare function assignComponentClassNames(combinations: ClassCombination[], opt
  */
 declare function generateComponentCss(options: CssGeneratorOptions): CssGeneratorResult;
 
-interface PatternFinderOptions {
-    minOccurrences?: number;
-    minSize?: number;
-    maxSize?: number;
-    topLimit?: number;
-    dedupeSubsets?: boolean;
-}
-/**
- * From every className occurrence, enumerate class subsets,
- * count normalized combinations, and return the most frequent ones.
- */
-declare function findFrequentPatterns(occurrences: ClassNameOccurrence[], options?: PatternFinderOptions): ClassCombination[];
-/**
- * Find exact duplicate className sets (full class lists per element).
- * Better suited for CSS generation than combinatorial subset search.
- */
-declare function findRepeatedClassSets(occurrences: ClassNameOccurrence[], options?: PatternFinderOptions): ClassCombination[];
-/**
- * Estimate how much repeated utility usage could be collapsed into components.
- * Uses the best full combination: each redundant instance could replace N utilities with 1.
- */
-declare function calculatePotentialReduction(occurrences: ClassNameOccurrence[], topCombinations: ClassCombination[]): number;
-
 interface BuildComponentsOptions extends PatternFinderOptions {
     sourcePath: string;
     prefix?: string;
@@ -202,6 +249,19 @@ interface ReplaceClassNamesResult {
  */
 declare function replaceClassNamesInSource(source: string, replacementMap: Map<string, string>, filePath: string): ReplaceClassNamesResult;
 
+interface SavingsReport {
+    replacementCount: number;
+    utilityTokensBefore: number;
+    utilityTokensAfter: number;
+    tokensSaved: number;
+    percentReduction: number;
+}
+/**
+ * Estimate utility-token savings from applied replacements.
+ * Each replacement collapses N utilities into 1 component class.
+ */
+declare function calculateSavings(replacements: ClassReplacement[]): SavingsReport;
+
 interface GenerateJsonReport {
     command: 'generate';
     outputPath: string;
@@ -219,6 +279,7 @@ interface ApplyJsonReport {
     components: GeneratedComponent[];
     replacements: ClassReplacement[];
     skipped: SkippedReplacement[];
+    savings: SavingsReport;
 }
 declare function printGenerateJsonReport(report: GenerateJsonReport): void;
 declare function printApplyJsonReport(report: ApplyJsonReport): void;
@@ -226,6 +287,9 @@ declare function printApplyJsonReport(report: ApplyJsonReport): void;
 interface ApplyOptions extends AnalyzeOptions {
     output: string;
     dryRun?: boolean;
+    verboseSkipped?: boolean;
+    /** Suppress console/json output (for internal callers like check) */
+    quiet?: boolean;
 }
 interface ApplyResult {
     filesModified: number;
@@ -236,30 +300,39 @@ interface ApplyResult {
     replacements: ApplyJsonReport['replacements'];
     skipped: ApplyJsonReport['skipped'];
     prettierFormatted: string[];
+    savings: SavingsReport;
 }
 /**
  * Generate component CSS and replace matching className strings in source files.
  */
 declare function applyCommand(targetPath: string, options: ApplyOptions): Promise<ApplyResult>;
 
-interface ScanProjectOptions extends PatternFinderOptions {
-    targetPath: string;
-    include?: string[];
-    exclude?: string[];
-    /** Threshold used to mark combinations as extractable by generate/apply */
-    extractableMinOccurrences?: number;
+interface CheckOptions extends AnalyzeOptions {
+    output: string;
+    /** Exit with code 1 when extractablePatternCount exceeds this value */
+    failOnExtractable?: number;
+    verboseSkipped?: boolean;
 }
-interface ScanProjectResult {
-    resolvedPath: string;
-    files: string[];
-    occurrences: ClassNameOccurrence[];
-    warnings: string[];
-    report: AnalysisReport;
+interface CheckResult {
+    passed: boolean;
+    extractablePatternCount: number;
+    report: Awaited<ReturnType<typeof scanProject>>['report'];
+    preview: ApplyResult | null;
 }
 /**
- * Scan a directory, parse className usage, and build an analysis report.
+ * Scan for extractable duplicates and preview what apply would change (dry-run).
  */
-declare function scanProject(options: ScanProjectOptions): Promise<ScanProjectResult>;
+declare function checkCommand(targetPath: string, options: CheckOptions): Promise<CheckResult>;
+
+/**
+ * List source files changed relative to a git ref (default: working tree vs HEAD).
+ */
+declare function getChangedSourceFiles(rootPath: string, ref?: string): Promise<string[]>;
+declare function isGitRepository(rootPath: string): Promise<boolean>;
+/**
+ * Changed source files under `scopePath`, resolved to absolute paths.
+ */
+declare function getChangedFilesInScope(scopePath: string, ref?: string): Promise<string[]>;
 
 interface GenerateOptions extends AnalyzeOptions {
     output: string;
@@ -392,9 +465,45 @@ declare function printConsoleReport(report: AnalysisReport, options?: ConsoleRep
 /** Serialize the analysis report as formatted JSON. */
 declare function printJsonReport(report: AnalysisReport): void;
 
+interface CheckJsonReport {
+    command: 'check';
+    passed: boolean;
+    outputPath: string;
+    extractablePatternCount: number;
+    analyzeMinOccurrences: number;
+    extractableMinOccurrences: number;
+    report: AnalysisReport;
+    preview: {
+        componentsGenerated: number;
+        filesModified: number;
+        replacementsTotal: number;
+        skippedTotal: number;
+        savings: ApplyResult['savings'];
+    } | null;
+}
+declare function printCheckJsonReport(report: CheckJsonReport): void;
+interface CheckConsoleOptions {
+    outputPath: string;
+    topLimit?: number;
+    preview?: ApplyResult | null;
+    verboseSkipped?: boolean;
+    passed: boolean;
+}
+declare function printCheckConsoleReport(analysisReport: AnalysisReport, options: CheckConsoleOptions): void;
+
+interface SkippedSummary {
+    reason: string;
+    count: number;
+    items: SkippedReplacement[];
+}
+declare function groupSkippedByReason(skipped: SkippedReplacement[]): SkippedSummary[];
+declare function printSkippedReport(skipped: SkippedReplacement[], options?: {
+    verbose?: boolean;
+}): void;
+
 /** Directories excluded from recursive file scanning. */
 declare const IGNORED_DIRECTORIES: readonly ["node_modules", ".next", "dist", "build", ".git"];
 /** fast-glob ignore patterns — match directories at any depth. */
 declare const IGNORE_PATTERNS: string[];
 
-export { type AnalysisReport, type AnalysisStats, type AnalyzeOptions, type ApplyOptions, type ApplyResult, CLASS_MERGE_CALLEES, type ClassCombination, type ClassNameExtraction, type ClassNameOccurrence, type ClassReplacement, type CliCommand, type CombinationLocation, type CommandConfig, type CssGeneratorOptions, type CssGeneratorResult, type CustomNamesConfig, DEFAULT_CLASS_PREFIX, type GenerateOptions, type GenerateResult, type GeneratedComponent, IGNORED_DIRECTORIES, IGNORE_PATTERNS, type ParseResult, type ReplaceClassNamesResult, type SkippedReplacement, type TailwindUnwindConfig, type TailwindUnwindConfigFile, VARIANT_CALLEES, analyzeCommand, applyCommand, assignComponentClassNames, buildComponents, buildComponentsFromCombinations, calculatePotentialReduction, collectVariantRegistry, dedupeSubsetCombinations, extractClassesFromExpression, extractClassesFromVariantCall, extractFromJSXAttribute, findFrequentPatterns, findRepeatedClassSets, formatModifiedFiles, formatSource, generateCombinations, generateCommand, generateComponentCss, isClassAttribute, isStrictSubset, isVariantCallee, loadCommandOptions, loadExtractableCombinations, normalizeClassPrefix, normalizeClasses, normalizeNamesConfig, parseFile, parseSource, parseSourceToAst, printApplyJsonReport, printConsoleReport, printGenerateJsonReport, printJsonReport, replaceClassNamesInSource, scanProject, splitClassString, suggestClassName, validateConfigFile, walkSourceFiles, withClassPrefix };
+export { type AnalysisReport, type AnalysisStats, type AnalyzeOptions, type ApplyOptions, type ApplyResult, CLASS_MERGE_CALLEES, type ClassCombination, type ClassNameExtraction, type ClassNameOccurrence, type ClassReplacement, type CliCommand, type CombinationLocation, type CommandConfig, type CssGeneratorOptions, type CssGeneratorResult, type CustomNamesConfig, DEFAULT_CLASS_PREFIX, type GenerateOptions, type GenerateResult, type GeneratedComponent, IGNORED_DIRECTORIES, IGNORE_PATTERNS, type ParseResult, type ReplaceClassNamesResult, type SkippedReplacement, type TailwindUnwindConfig, type TailwindUnwindConfigFile, VARIANT_CALLEES, analyzeCommand, applyCommand, assignComponentClassNames, buildComponents, buildComponentsFromCombinations, calculatePotentialReduction, calculateSavings, checkCommand, collectVariantRegistry, dedupeSubsetCombinations, extractClassesFromExpression, extractClassesFromVariantCall, extractFromJSXAttribute, findFrequentPatterns, findRepeatedClassSets, formatModifiedFiles, formatSource, generateCombinations, generateCommand, generateComponentCss, getChangedFilesInScope, getChangedSourceFiles, groupSkippedByReason, initCommand, isClassAttribute, isGitRepository, isStrictSubset, isVariantCallee, loadCommandOptions, loadExtractableCombinations, normalizeClassPrefix, normalizeClasses, normalizeNamesConfig, parseFile, parseSource, parseSourceToAst, printApplyJsonReport, printCheckConsoleReport, printCheckJsonReport, printConsoleReport, printGenerateJsonReport, printJsonReport, printSkippedReport, replaceClassNamesInSource, scanProject, splitClassString, suggestClassName, validateConfigFile, walkSourceFiles, withClassPrefix };

package/dist/index.js

@@ -10,6 +10,8 @@ import {
   buildComponents,
   buildComponentsFromCombinations,
   calculatePotentialReduction,
+  calculateSavings,
+  checkCommand,
   collectVariantRegistry,
   dedupeSubsetCombinations,
   extractClassesFromExpression,
@@ -22,7 +24,12 @@ import {
   generateCombinations,
   generateCommand,
   generateComponentCss,
+  getChangedFilesInScope,
+  getChangedSourceFiles,
+  groupSkippedByReason,
+  initCommand,
   isClassAttribute,
+  isGitRepository,
   isStrictSubset,
   isVariantCallee,
   loadCommandOptions,
@@ -34,9 +41,12 @@ import {
   parseSource,
   parseSourceToAst,
   printApplyJsonReport,
+  printCheckConsoleReport,
+  printCheckJsonReport,
   printConsoleReport,
   printGenerateJsonReport,
   printJsonReport,
+  printSkippedReport,
   replaceClassNamesInSource,
   scanProject,
   splitClassString,
@@ -44,7 +54,7 @@ import {
   validateConfigFile,
   walkSourceFiles,
   withClassPrefix
-} from "./chunk-4GXMK3NB.js";
+} from "./chunk-RMTZCCPS.js";
 export {
   CLASS_MERGE_CALLEES,
   DEFAULT_CLASS_PREFIX,
@@ -57,6 +67,8 @@ export {
   buildComponents,
   buildComponentsFromCombinations,
   calculatePotentialReduction,
+  calculateSavings,
+  checkCommand,
   collectVariantRegistry,
   dedupeSubsetCombinations,
   extractClassesFromExpression,
@@ -69,7 +81,12 @@ export {
   generateCombinations,
   generateCommand,
   generateComponentCss,
+  getChangedFilesInScope,
+  getChangedSourceFiles,
+  groupSkippedByReason,
+  initCommand,
   isClassAttribute,
+  isGitRepository,
   isStrictSubset,
   isVariantCallee,
   loadCommandOptions,
@@ -81,9 +98,12 @@ export {
   parseSource,
   parseSourceToAst,
   printApplyJsonReport,
+  printCheckConsoleReport,
+  printCheckJsonReport,
   printConsoleReport,
   printGenerateJsonReport,
   printJsonReport,
+  printSkippedReport,
   replaceClassNamesInSource,
   scanProject,
   splitClassString,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tailwind-unwind",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Analyze Tailwind CSS class usage patterns in React/Next.js projects",
   "type": "module",
   "main": "./dist/index.js",
@@ -60,7 +60,8 @@
     "chalk": "^5.4.1",
     "cli-table3": "^0.6.5",
     "commander": "^13.1.0",
-    "fast-glob": "^3.3.3"
+    "fast-glob": "^3.3.3",
+    "jiti": "^2.4.2"
   },
   "devDependencies": {
     "@types/babel__generator": "^7.6.8",