@styleframe/transpiler 3.3.0 → 3.4.1

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @styleframe/transpiler
 
+## 3.4.1
+
+### Patch Changes
+
+- [#238](https://github.com/styleframe-dev/styleframe/pull/238) [`4ace91d`](https://github.com/styleframe-dev/styleframe/commit/4ace91d5e15020c29d585848ee66f6250946b2d1) Thanks [@alexgrozav](https://github.com/alexgrozav)! - Bundle type declarations on build. The shared Vite config now enables `vite-plugin-dts`'s `bundleTypes`, so each package ships a single rolled-up `.d.ts` per entry (via `@microsoft/api-extractor`) instead of a tree of per-file declarations. `@microsoft/api-extractor` is now a peer dependency of `@styleframe/config-vite`.
+
+- Updated dependencies [[`4ace91d`](https://github.com/styleframe-dev/styleframe/commit/4ace91d5e15020c29d585848ee66f6250946b2d1)]:
+  - @styleframe/core@3.6.1
+
+## 3.4.0
+
+### Minor Changes
+
+- [#234](https://github.com/styleframe-dev/styleframe/pull/234) [`c7ff8c8`](https://github.com/styleframe-dev/styleframe/commit/c7ff8c89776b2e117b0f45f3e1f8ca6695f24a29) Thanks [@alexgrozav](https://github.com/alexgrozav)! - Add recipe-level tree-shaking. Unused recipes and their utility classes are excluded from the CSS and TypeScript consumer module during production builds.
+  - **Core**: `Root._usage` gains `recipes` and `recipeUtilities` fields. Recipe utility class names are tracked per-recipe in `recipeUtilities` and promoted to `utilities` via `registerRecipeUtilities()`.
+  - **Scanner**: New `scanImports()` and `scanFileImports()` methods use importree v2's `parseImports()` to detect which recipes are imported from `virtual:styleframe`.
+  - **Transpiler**: TS and DTS consumers filter recipes by `_usage.recipes` — only emitting used recipes when the set is populated.
+  - **Plugin**: Recipe scanning integrated into the build flow after content scanning. Defaults to tree-shaking ON for builds, OFF for dev. Safety: namespace/dynamic imports include all recipes with a warning. `recipes.include` option provides an escape hatch for force-including recipes.
+
+- [#226](https://github.com/styleframe-dev/styleframe/pull/226) [`dc99d46`](https://github.com/styleframe-dev/styleframe/commit/dc99d4699046f5e5f3dcac965648fd50b0339412) Thanks [@alexgrozav](https://github.com/alexgrozav)! - Add build-time utility class name shortening for production builds.
+
+  Generates shortening maps at transpile time with collision-safe abbreviation and built-in defaults for common CSS properties. Hashes long arbitrary values for stable compact names. Supports underscore-as-space in arbitrary values (`_padding:[10px_20px]`). Exposes `minify` plugin option with user-overridable defaults.
+
+- [#224](https://github.com/styleframe-dev/styleframe/pull/224) [`6941920`](https://github.com/styleframe-dev/styleframe/commit/6941920a50e560e4686aebd154bb6aea4c59c258) Thanks [@alexgrozav](https://github.com/alexgrozav)! - Export named Props types from `virtual:styleframe` for each recipe (e.g. `import { button, type ButtonProps } from 'virtual:styleframe'`).
+
+### Patch Changes
+
+- [#235](https://github.com/styleframe-dev/styleframe/pull/235) [`6acd766`](https://github.com/styleframe-dev/styleframe/commit/6acd766eefc82139d8cd98dfb9b553449945d704) Thanks [@alexgrozav](https://github.com/alexgrozav)! - Generate DTS output as two files that describe the virtual modules in two complementary forms. The transpiler's `dts` mode now emits:
+  - `styleframe.d.ts` — top-level exports describing the `virtual:styleframe` module
+  - `shims.d.ts` — self-contained ambient declarations: a `declare module "virtual:styleframe"` carrying the full typed exports, plus the `virtual:styleframe.css` string shim
+
+  Non-Vue consumers resolve both virtual modules from `shims.d.ts` alone (picked up via the `.styleframe/**/*.d.ts` include) with **zero `paths` configuration**. Vue consumers additionally map `virtual:styleframe` to `styleframe.d.ts` via a `compilerOptions.paths` entry, because `vue-tsc` won't resolve a bare-specifier ambient module imported inside a `.vue` SFC. `styleframe init` detects plain Vue projects (a `vue` dependency without `nuxt`) and writes that `paths` entry only for them, merging into any existing `paths`; non-Vue projects just get the includes. Nuxt is excluded because its module already injects the mapping via `prepare:types`, and writing `paths` into an `extends`-based Nuxt root tsconfig would replace (not merge) Nuxt's inherited aliases.
+
+  The Nuxt module registers the same `virtual:styleframe` path mapping into Nuxt's generated types via the `prepare:types` hook, so imports type-check without manual tsconfig changes. It also fixes the module's `configKey`/`name`, which were leftover `unpluginStarter` placeholders that caused `styleframe: {}` options in `nuxt.config` to be ignored.
+
+- [#233](https://github.com/styleframe-dev/styleframe/pull/233) [`0ef38e6`](https://github.com/styleframe-dev/styleframe/commit/0ef38e69ca941cefab31463c23980f52cae1541f) Thanks [@alexgrozav](https://github.com/alexgrozav)! - Migrate from Vite 7 to Vite 8 with native Rolldown integration. Replace esbuild transforms with Oxc in the plugin, rename `rollupOptions` to `rolldownOptions`, upgrade `vite-plugin-dts` v4 to v5 (`rollupTypes` → `bundleTypes`), and bump vitest from v3 to v4.
+
+- Updated dependencies [[`c7ff8c8`](https://github.com/styleframe-dev/styleframe/commit/c7ff8c89776b2e117b0f45f3e1f8ca6695f24a29), [`dc99d46`](https://github.com/styleframe-dev/styleframe/commit/dc99d4699046f5e5f3dcac965648fd50b0339412), [`0ef38e6`](https://github.com/styleframe-dev/styleframe/commit/0ef38e69ca941cefab31463c23980f52cae1541f)]:
+  - @styleframe/core@3.6.0
+
 ## 3.3.0
 
 ### Minor Changes

package/dist/{transpiler.d.ts → index.d.cts}

@@ -1,13 +1,19 @@
 import { CamelCase } from 'scule';
 import { defaultUtilitySelectorFn } from '@styleframe/core';
 import { KebabCase } from 'scule';
+import { Root } from '@styleframe/core';
+import { ShorteningMap } from '@styleframe/core';
 import { Styleframe } from '@styleframe/core';
 import { StyleframeOptions } from '@styleframe/core';
 import { ThemeSelectorFn } from '@styleframe/core';
+import { UtilitySelectorFn } from '@styleframe/core';
+import { UtilitySelectorOptions } from '@styleframe/core';
 import { VariableNameFn } from '@styleframe/core';
 
 export declare function addIndentToLine(line: string): string;
 
+export declare function buildClassNameLookup(root: Root, map: ShorteningMap, selectorFn?: UtilitySelectorFn): Record<string, string>;
+
 /**
  * Consumes any token instance and returns the CSS string representation
  */
@@ -18,18 +24,30 @@ export declare type ConsumeFunction = (instance: unknown, options: StyleframeOpt
 /**
  * Consumes any token instance and returns the TS string representation
  */
-export declare function consumeTS(instance: unknown, options: StyleframeOptions): string;
+export declare function consumeTS(instance: unknown, options: StyleframeOptions, context?: TranspileContext): string;
 
 export declare function createFile(name: string, content?: string): OutputFile;
 
 export declare const DEFAULT_INDENT = "\t";
 
+export declare const defaultModifierShortNames: Record<string, string>;
+
+export declare const defaultPropertyShortNames: Record<string, string>;
+
 export declare const defaultThemeSelectorFn: ThemeSelectorFn;
 
 export { defaultUtilitySelectorFn }
 
 export declare const defaultVariableNameFn: VariableNameFn;
 
+/** File holding the self-contained ambient shims for the virtual modules. */
+export declare const DTS_SHIMS_FILENAME = "shims.d.ts";
+
+/** File holding the top-level exports for the `virtual:styleframe` module. */
+export declare const DTS_TYPES_FILENAME = "styleframe.d.ts";
+
+export declare function generateShorteningMap(root: Root, defaults?: ShorteningMapDefaults): ShorteningMap;
+
 export declare function indentLines(lines: string): string;
 
 export declare function isUppercase(char: string): boolean;
@@ -43,6 +61,14 @@ export declare type OutputFile = {
     content: string;
 };
 
+export declare type ShorteningMapDefaults = {
+    properties?: Record<string, string>;
+    values?: Record<string, string>;
+    modifiers?: Record<string, string>;
+};
+
+export declare function shortenUtilityOptions(opts: UtilitySelectorOptions, map: ShorteningMap): UtilitySelectorOptions;
+
 export declare const STATEMENT_AT_RULES: string[];
 
 export declare const STATEMENT_OR_BLOCK_AT_RULES: string[];
@@ -51,17 +77,24 @@ export declare function toCamelCase<S extends string>(str: S): CamelCase<S>;
 
 export declare function toKebabCase<S extends string>(str: S): KebabCase<S>;
 
-export declare function transpile(instance: Styleframe, { type, treeshake, scanner, consumers, }?: TranspileOptions): Promise<Output>;
+export declare function transpile(instance: Styleframe, { type, treeshake, scanner, minify, minifyOptions, consumers, }?: TranspileOptions): Promise<Output>;
 
 export declare type TranspileContext = {
     treeshake?: boolean;
     scanner?: boolean;
+    shortMap?: ShorteningMap;
 };
 
 export declare type TranspileOptions = {
     type?: "css" | "ts" | "dts" | "all";
     treeshake?: boolean;
     scanner?: boolean;
+    minify?: boolean;
+    minifyOptions?: {
+        properties?: Record<string, string>;
+        values?: Record<string, string>;
+        modifiers?: Record<string, string>;
+    };
     consumers?: {
         css: ConsumeFunction;
         ts: ConsumeFunction;

package/dist/index.d.mts

@@ -0,0 +1,105 @@
+import { CamelCase } from 'scule';
+import { defaultUtilitySelectorFn } from '@styleframe/core';
+import { KebabCase } from 'scule';
+import { Root } from '@styleframe/core';
+import { ShorteningMap } from '@styleframe/core';
+import { Styleframe } from '@styleframe/core';
+import { StyleframeOptions } from '@styleframe/core';
+import { ThemeSelectorFn } from '@styleframe/core';
+import { UtilitySelectorFn } from '@styleframe/core';
+import { UtilitySelectorOptions } from '@styleframe/core';
+import { VariableNameFn } from '@styleframe/core';
+
+export declare function addIndentToLine(line: string): string;
+
+export declare function buildClassNameLookup(root: Root, map: ShorteningMap, selectorFn?: UtilitySelectorFn): Record<string, string>;
+
+/**
+ * Consumes any token instance and returns the CSS string representation
+ */
+export declare function consumeCSS(instance: unknown, options: StyleframeOptions, context?: TranspileContext): string;
+
+export declare type ConsumeFunction = (instance: unknown, options: StyleframeOptions, context?: TranspileContext) => string;
+
+/**
+ * Consumes any token instance and returns the TS string representation
+ */
+export declare function consumeTS(instance: unknown, options: StyleframeOptions, context?: TranspileContext): string;
+
+export declare function createFile(name: string, content?: string): OutputFile;
+
+export declare const DEFAULT_INDENT = "\t";
+
+export declare const defaultModifierShortNames: Record<string, string>;
+
+export declare const defaultPropertyShortNames: Record<string, string>;
+
+export declare const defaultThemeSelectorFn: ThemeSelectorFn;
+
+export { defaultUtilitySelectorFn }
+
+export declare const defaultVariableNameFn: VariableNameFn;
+
+/** File holding the self-contained ambient shims for the virtual modules. */
+export declare const DTS_SHIMS_FILENAME = "shims.d.ts";
+
+/** File holding the top-level exports for the `virtual:styleframe` module. */
+export declare const DTS_TYPES_FILENAME = "styleframe.d.ts";
+
+export declare function generateShorteningMap(root: Root, defaults?: ShorteningMapDefaults): ShorteningMap;
+
+export declare function indentLines(lines: string): string;
+
+export declare function isUppercase(char: string): boolean;
+
+export declare type Output = {
+    files: OutputFile[];
+};
+
+export declare type OutputFile = {
+    name: string;
+    content: string;
+};
+
+export declare type ShorteningMapDefaults = {
+    properties?: Record<string, string>;
+    values?: Record<string, string>;
+    modifiers?: Record<string, string>;
+};
+
+export declare function shortenUtilityOptions(opts: UtilitySelectorOptions, map: ShorteningMap): UtilitySelectorOptions;
+
+export declare const STATEMENT_AT_RULES: string[];
+
+export declare const STATEMENT_OR_BLOCK_AT_RULES: string[];
+
+export declare function toCamelCase<S extends string>(str: S): CamelCase<S>;
+
+export declare function toKebabCase<S extends string>(str: S): KebabCase<S>;
+
+export declare function transpile(instance: Styleframe, { type, treeshake, scanner, minify, minifyOptions, consumers, }?: TranspileOptions): Promise<Output>;
+
+export declare type TranspileContext = {
+    treeshake?: boolean;
+    scanner?: boolean;
+    shortMap?: ShorteningMap;
+};
+
+export declare type TranspileOptions = {
+    type?: "css" | "ts" | "dts" | "all";
+    treeshake?: boolean;
+    scanner?: boolean;
+    minify?: boolean;
+    minifyOptions?: {
+        properties?: Record<string, string>;
+        values?: Record<string, string>;
+        modifiers?: Record<string, string>;
+    };
+    consumers?: {
+        css: ConsumeFunction;
+        ts: ConsumeFunction;
+        dts: ConsumeFunction;
+    };
+};
+
+export { }

package/dist/index.d.ts

@@ -0,0 +1,105 @@
+import { CamelCase } from 'scule';
+import { defaultUtilitySelectorFn } from '@styleframe/core';
+import { KebabCase } from 'scule';
+import { Root } from '@styleframe/core';
+import { ShorteningMap } from '@styleframe/core';
+import { Styleframe } from '@styleframe/core';
+import { StyleframeOptions } from '@styleframe/core';
+import { ThemeSelectorFn } from '@styleframe/core';
+import { UtilitySelectorFn } from '@styleframe/core';
+import { UtilitySelectorOptions } from '@styleframe/core';
+import { VariableNameFn } from '@styleframe/core';
+
+export declare function addIndentToLine(line: string): string;
+
+export declare function buildClassNameLookup(root: Root, map: ShorteningMap, selectorFn?: UtilitySelectorFn): Record<string, string>;
+
+/**
+ * Consumes any token instance and returns the CSS string representation
+ */
+export declare function consumeCSS(instance: unknown, options: StyleframeOptions, context?: TranspileContext): string;
+
+export declare type ConsumeFunction = (instance: unknown, options: StyleframeOptions, context?: TranspileContext) => string;
+
+/**
+ * Consumes any token instance and returns the TS string representation
+ */
+export declare function consumeTS(instance: unknown, options: StyleframeOptions, context?: TranspileContext): string;
+
+export declare function createFile(name: string, content?: string): OutputFile;
+
+export declare const DEFAULT_INDENT = "\t";
+
+export declare const defaultModifierShortNames: Record<string, string>;
+
+export declare const defaultPropertyShortNames: Record<string, string>;
+
+export declare const defaultThemeSelectorFn: ThemeSelectorFn;
+
+export { defaultUtilitySelectorFn }
+
+export declare const defaultVariableNameFn: VariableNameFn;
+
+/** File holding the self-contained ambient shims for the virtual modules. */
+export declare const DTS_SHIMS_FILENAME = "shims.d.ts";
+
+/** File holding the top-level exports for the `virtual:styleframe` module. */
+export declare const DTS_TYPES_FILENAME = "styleframe.d.ts";
+
+export declare function generateShorteningMap(root: Root, defaults?: ShorteningMapDefaults): ShorteningMap;
+
+export declare function indentLines(lines: string): string;
+
+export declare function isUppercase(char: string): boolean;
+
+export declare type Output = {
+    files: OutputFile[];
+};
+
+export declare type OutputFile = {
+    name: string;
+    content: string;
+};
+
+export declare type ShorteningMapDefaults = {
+    properties?: Record<string, string>;
+    values?: Record<string, string>;
+    modifiers?: Record<string, string>;
+};
+
+export declare function shortenUtilityOptions(opts: UtilitySelectorOptions, map: ShorteningMap): UtilitySelectorOptions;
+
+export declare const STATEMENT_AT_RULES: string[];
+
+export declare const STATEMENT_OR_BLOCK_AT_RULES: string[];
+
+export declare function toCamelCase<S extends string>(str: S): CamelCase<S>;
+
+export declare function toKebabCase<S extends string>(str: S): KebabCase<S>;
+
+export declare function transpile(instance: Styleframe, { type, treeshake, scanner, minify, minifyOptions, consumers, }?: TranspileOptions): Promise<Output>;
+
+export declare type TranspileContext = {
+    treeshake?: boolean;
+    scanner?: boolean;
+    shortMap?: ShorteningMap;
+};
+
+export declare type TranspileOptions = {
+    type?: "css" | "ts" | "dts" | "all";
+    treeshake?: boolean;
+    scanner?: boolean;
+    minify?: boolean;
+    minifyOptions?: {
+        properties?: Record<string, string>;
+        values?: Record<string, string>;
+        modifiers?: Record<string, string>;
+    };
+    consumers?: {
+        css: ConsumeFunction;
+        ts: ConsumeFunction;
+        dts: ConsumeFunction;
+    };
+};
+
+export { }