tailwind-unwind 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Expression, JSXAttribute, Node } from '@babel/types';
+import { Node, CallExpression, Expression, JSXAttribute } from '@babel/types';
 
 type CliCommand = 'analyze' | 'generate' | 'apply';
 interface CommandConfig {
@@ -10,6 +10,9 @@ interface CommandConfig {
     output?: string;
     dedupeSubsets?: boolean;
     dryRun?: boolean;
+    prettier?: boolean;
+    fromReport?: string;
+    extractableOnly?: boolean;
 }
 /** Keys are space-separated utility strings; values are base class names (without prefix). */
 type CustomNamesConfig = Record<string, string>;
@@ -99,6 +102,9 @@ interface AnalyzeOptions {
     configPath?: string;
     /** Custom base class names keyed by space-separated utility strings */
     names?: Record<string, string>;
+    prettier?: boolean;
+    fromReport?: string;
+    extractableOnly?: boolean;
 }
 
 /**
@@ -106,20 +112,32 @@ interface AnalyzeOptions {
  */
 declare function analyzeCommand(targetPath: string, options?: AnalyzeOptions): Promise<AnalysisReport>;
 
-interface ApplyOptions extends AnalyzeOptions {
-    output: string;
-    dryRun?: boolean;
+interface GeneratedComponent {
+    className: string;
+    classes: string[];
+    occurrences: number;
 }
-interface ApplyResult {
-    filesModified: number;
-    replacementsTotal: number;
-    outputPath: string;
-    componentsGenerated: number;
+interface CssGeneratorOptions {
+    sourcePath: string;
+    combinations: ClassCombination[];
+    prefix?: string;
+    names?: CustomNamesConfig;
+}
+interface CssGeneratorResult {
+    css: string;
+    components: GeneratedComponent[];
 }
+interface AssignClassNamesOptions {
+    prefix?: string;
+    names?: CustomNamesConfig;
+}
+/** Assign unique, prefixed component class names. */
+declare function assignComponentClassNames(combinations: ClassCombination[], options?: AssignClassNamesOptions): GeneratedComponent[];
 /**
- * Generate component CSS and replace matching className strings in source files.
+ * Build a Tailwind CSS file with @layer components and @apply rules
+ * for the most frequent class combinations.
  */
-declare function applyCommand(targetPath: string, options: ApplyOptions): Promise<ApplyResult>;
+declare function generateComponentCss(options: CssGeneratorOptions): CssGeneratorResult;
 
 interface PatternFinderOptions {
     minOccurrences?: number;
@@ -144,6 +162,86 @@ declare function findRepeatedClassSets(occurrences: ClassNameOccurrence[], optio
  */
 declare function calculatePotentialReduction(occurrences: ClassNameOccurrence[], topCombinations: ClassCombination[]): number;
 
+interface BuildComponentsOptions extends PatternFinderOptions {
+    sourcePath: string;
+    prefix?: string;
+    names?: Record<string, string>;
+}
+interface BuildComponentsResult {
+    components: GeneratedComponent[];
+    css: string;
+    replacementMap: Map<string, string>;
+}
+/** Build component classes, CSS, and a normalized-class → name lookup map. */
+declare function buildComponents(occurrences: ClassNameOccurrence[], options: BuildComponentsOptions): BuildComponentsResult;
+/** Build components from pre-selected combinations (e.g. analyze report). */
+declare function buildComponentsFromCombinations(combinations: ClassCombination[], options: BuildComponentsOptions): BuildComponentsResult;
+
+interface ClassReplacement {
+    filePath: string;
+    line?: number;
+    from: string;
+    to: string;
+    partial?: boolean;
+}
+interface SkippedReplacement {
+    filePath: string;
+    line?: number;
+    reason: string;
+    classes: string[];
+}
+interface ReplaceClassNamesResult {
+    source: string;
+    replacements: ClassReplacement[];
+    skipped: SkippedReplacement[];
+    changed: boolean;
+}
+/**
+ * Replace exact matching className/class values with generated component classes.
+ * Supports partial replacement inside cn()/clsx() when dynamic args are present.
+ */
+declare function replaceClassNamesInSource(source: string, replacementMap: Map<string, string>, filePath: string): ReplaceClassNamesResult;
+
+interface GenerateJsonReport {
+    command: 'generate';
+    outputPath: string;
+    componentsGenerated: number;
+    components: GeneratedComponent[];
+    cssWritten: boolean;
+}
+interface ApplyJsonReport {
+    command: 'apply';
+    dryRun: boolean;
+    outputPath: string;
+    filesModified: number;
+    replacementsTotal: number;
+    componentsGenerated: number;
+    components: GeneratedComponent[];
+    replacements: ClassReplacement[];
+    skipped: SkippedReplacement[];
+}
+declare function printGenerateJsonReport(report: GenerateJsonReport): void;
+declare function printApplyJsonReport(report: ApplyJsonReport): void;
+
+interface ApplyOptions extends AnalyzeOptions {
+    output: string;
+    dryRun?: boolean;
+}
+interface ApplyResult {
+    filesModified: number;
+    replacementsTotal: number;
+    outputPath: string;
+    componentsGenerated: number;
+    components: Awaited<ReturnType<typeof buildComponents>>['components'];
+    replacements: ApplyJsonReport['replacements'];
+    skipped: ApplyJsonReport['skipped'];
+    prettierFormatted: string[];
+}
+/**
+ * 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[];
@@ -169,77 +267,54 @@ interface GenerateOptions extends AnalyzeOptions {
 interface GenerateResult {
     outputPath: string;
     componentsGenerated: number;
-    report: Awaited<ReturnType<typeof scanProject>>['report'];
+    components: Awaited<ReturnType<typeof buildComponents>>['components'];
+    report: Awaited<ReturnType<typeof scanProject>>['report'] | null;
 }
 /**
  * Analyze a project and write @layer components CSS to the output file.
  */
 declare function generateCommand(targetPath: string, options: GenerateOptions): Promise<GenerateResult>;
 
-interface GeneratedComponent {
-    className: string;
-    classes: string[];
-    occurrences: number;
-}
-interface CssGeneratorOptions {
-    sourcePath: string;
+interface LoadedAnalyzeReport {
+    targetPath: string;
     combinations: ClassCombination[];
-    prefix?: string;
-    names?: CustomNamesConfig;
-}
-interface CssGeneratorResult {
-    css: string;
-    components: GeneratedComponent[];
-}
-interface AssignClassNamesOptions {
-    prefix?: string;
-    names?: CustomNamesConfig;
 }
-/** Assign unique, prefixed component class names. */
-declare function assignComponentClassNames(combinations: ClassCombination[], options?: AssignClassNamesOptions): GeneratedComponent[];
 /**
- * Build a Tailwind CSS file with @layer components and @apply rules
- * for the most frequent class combinations.
+ * Load an analyze JSON report and return extractable combinations for generate.
  */
-declare function generateComponentCss(options: CssGeneratorOptions): CssGeneratorResult;
+declare function loadExtractableCombinations(reportPath: string, options?: {
+    extractableOnly?: boolean;
+}): Promise<LoadedAnalyzeReport>;
 
-interface BuildComponentsOptions extends PatternFinderOptions {
-    sourcePath: string;
-    prefix?: string;
-    names?: Record<string, string>;
-}
-interface BuildComponentsResult {
-    components: GeneratedComponent[];
-    css: string;
-    replacementMap: Map<string, string>;
-}
-/** Build component classes, CSS, and a normalized-class → name lookup map. */
-declare function buildComponents(occurrences: ClassNameOccurrence[], options: BuildComponentsOptions): BuildComponentsResult;
-
-interface ClassReplacement {
-    filePath: string;
-    line?: number;
-    from: string;
-    to: string;
-    partial?: boolean;
-}
-interface SkippedReplacement {
+interface FormatSourceOptions {
     filePath: string;
-    line?: number;
-    reason: string;
-    classes: string[];
+    cwd?: string;
 }
-interface ReplaceClassNamesResult {
+/**
+ * Format source with Prettier when available in the project.
+ * Returns original source unchanged if Prettier is not installed.
+ */
+declare function formatSource(source: string, options: FormatSourceOptions): Promise<{
     source: string;
-    replacements: ClassReplacement[];
-    skipped: SkippedReplacement[];
-    changed: boolean;
-}
+    formatted: boolean;
+}>;
+declare function formatModifiedFiles(files: string[], sources: Map<string, string>, cwd?: string): Promise<{
+    formatted: string[];
+    skipped: string[];
+}>;
+
+/** Variant APIs that define reusable Tailwind class sets. */
+declare const VARIANT_CALLEES: Set<string>;
+declare function isVariantCallee(expression: Expression): boolean;
 /**
- * Replace exact matching className/class values with generated component classes.
- * Supports partial replacement inside cn()/clsx() when dynamic args are present.
+ * Extract Tailwind tokens from a cva()/tv() definition call.
  */
-declare function replaceClassNamesInSource(source: string, replacementMap: Map<string, string>, filePath: string): ReplaceClassNamesResult;
+declare function extractClassesFromVariantCall(call: CallExpression): string[];
+type VariantRegistry = Map<string, string[]>;
+/**
+ * Collect `const x = cva(...)` / `const x = tv(...)` definitions in a file.
+ */
+declare function collectVariantRegistry(ast: Node): VariantRegistry;
 
 /**
  * Suggest a short, human-readable component class name from a utility list.
@@ -281,15 +356,11 @@ interface ExtractedClasses {
     classes: string[];
     isDynamic: boolean;
 }
-/**
- * Recursively pull static Tailwind tokens from JSX className expressions.
- * Unknown/dynamic fragments set `isDynamic: true` but may still yield partial classes.
- */
-declare function extractClassesFromExpression(expression: Expression): ExtractedClasses;
+declare function extractClassesFromExpression(expression: Expression, registry?: VariantRegistry): ExtractedClasses;
 
 declare function isClassAttribute(attr: JSXAttribute): boolean;
 /** Extract Tailwind classes from a className/class JSX attribute. */
-declare function extractFromJSXAttribute(attr: JSXAttribute): ClassNameExtraction | null;
+declare function extractFromJSXAttribute(attr: JSXAttribute, registry?: VariantRegistry): ClassNameExtraction | null;
 declare function parseSourceToAst(source: string): Node;
 
 /**
@@ -326,4 +397,4 @@ declare const IGNORED_DIRECTORIES: readonly ["node_modules", ".next", "dist", "b
 /** 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, analyzeCommand, applyCommand, assignComponentClassNames, buildComponents, calculatePotentialReduction, dedupeSubsetCombinations, extractClassesFromExpression, extractFromJSXAttribute, findFrequentPatterns, findRepeatedClassSets, generateCombinations, generateCommand, generateComponentCss, isClassAttribute, isStrictSubset, loadCommandOptions, normalizeClassPrefix, normalizeClasses, normalizeNamesConfig, parseFile, parseSource, parseSourceToAst, printConsoleReport, 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, 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 };

package/dist/index.js

@@ -3,29 +3,39 @@ import {
   DEFAULT_CLASS_PREFIX,
   IGNORED_DIRECTORIES,
   IGNORE_PATTERNS,
+  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,
@@ -34,35 +44,45 @@ import {
   validateConfigFile,
   walkSourceFiles,
   withClassPrefix
-} from "./chunk-FASYIEVZ.js";
+} from "./chunk-4GXMK3NB.js";
 export {
   CLASS_MERGE_CALLEES,
   DEFAULT_CLASS_PREFIX,
   IGNORED_DIRECTORIES,
   IGNORE_PATTERNS,
+  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,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tailwind-unwind",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Analyze Tailwind CSS class usage patterns in React/Next.js projects",
   "type": "module",
   "main": "./dist/index.js",
@@ -44,6 +44,14 @@
   "engines": {
     "node": ">=18"
   },
+  "peerDependencies": {
+    "prettier": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "prettier": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "@babel/generator": "^7.27.0",
     "@babel/parser": "^7.27.0",
@@ -60,6 +68,7 @@
     "@types/node": "^22.15.3",
     "tsup": "^8.4.0",
     "typescript": "^5.8.3",
+    "prettier": "^3.5.3",
     "vitest": "^3.1.2"
   }
 }

package/tailwind-unwind.config.example.json

@@ -14,11 +14,14 @@
     "minOccurrences": 3,
     "prefix": "twu-",
     "output": "src/styles/components.css",
-    "top": 20
+    "top": 20,
+    "fromReport": "report.json",
+    "extractableOnly": true
   },
   "apply": {
     "minOccurrences": 3,
     "prefix": "twu-",
-    "output": "src/styles/components.css"
+    "output": "src/styles/components.css",
+    "prettier": true
   }
 }