teacss 0.5.2 → 0.6.2

package/README.md

@@ -1,14 +1,15 @@
 # TeaCSS
 
-The application package for TeaCSS.
+The development tool package for TeaCSS.
 
-The root entry exports the official `cn`, `recipe`, `omitAttributes`,
-runtime types, and Standard constant tables. Engine and preset factories are
-available through explicit subpaths.
+It provides the `teacss` command, the `teacss/cli` programmatic API, and
+Standard constant tables at the root. Core and preset factories remain
+available through explicit subpaths. Runtime class helpers live in
+`@teacss/classes`.
 
 ## Install
 
-Install `teacss` as an application dependency and add the adapter for the
+Install `teacss` as a development dependency with the adapter and host for the
 project's build tool:
 
 | Build tool     | Development packages            |
@@ -18,7 +19,24 @@ project's build tool:
 | Rsbuild        | `@teacss/rsbuild @rsbuild/core` |
 | PostCSS        | `@teacss/postcss postcss`       |
 | Bun Build      | `@teacss/bun`                   |
-| Standalone CLI | `@teacss/cli`                   |
+| Standalone CLI | Included with `teacss`        |
+
+For example, `npm install --save-dev teacss @teacss/vite vite` sets up Vite.
+For standalone output, install only `teacss` and run its CLI:
+
+```sh
+npx teacss "src/**/*.{ts,tsx,html}" --preset standard -o tea.css
+```
+
+`--preset standard` enables utilities when the project has no CSS entry. Add
+`--watch` to rebuild as source files change, and include `tea.css` in the page.
+
+The independent `@teacss/cli` package remains available for direct installs.
+Both `teacss/cli` and `@teacss/cli` expose the programmatic `build` API:
+
+```ts
+import { build } from "teacss/cli";
+```
 
 Example with Vite:
 
@@ -30,7 +48,7 @@ export default defineConfig({ plugins: [pluginTeacss()] });
 ```
 
 ```css
-@preset "standard";
+@presets "standard";
 @source "./src/**/*.{ts,tsx,html}";
 @teacss;
 ```
@@ -44,31 +62,36 @@ import "virtual:teacss.css";
 Enable optional vocabularies explicitly:
 
 ```css
-@preset "standard";
-@preset "official";
-@preset "icons";
+@presets "standard,official";
+@presets "icons";
 ```
 
-Official includes `prose`, `prose-hans` and `prose-hant` for long-form content;
-the separate Articles preset is retired. Official does not enable Standard. All preset factories are available from
-subpaths:
+Official includes `prose`, `prose-hans` and `prose-hant` for long-form content
+and does not enable Standard. Preset factories are available from subpaths:
 
 | Import                    | Export              |
 | ------------------------- | ------------------- |
-| `teacss/preset-standard`  | `presetStandard`    |
-| `teacss/preset-official` | `presetOfficial`   |
+| `teacss/preset-standard` | `presetStandard`    |
+| `teacss/preset-official` | `presetOfficial`    |
 | `teacss/preset-icons`     | `presetIcons`       |
 | `teacss/core`             | Core engine exports |
 
 ## Runtime classes
 
+Install `@teacss/classes` as an application dependency to compose class
+strings at runtime:
+
+```sh
+npm install @teacss/classes
+```
+
 ```ts
-import { cn, recipe, type ClassProp, type VariantProps } from "teacss";
+import { cn, recipe, type ClassProp, type VariantProps } from "@teacss/classes";
 
 cn("p:4 d:flex", "p:8"); // "d:flex p:8"
 
 const badge = recipe({
-  className: "d:inline-flex p:2",
+  defaults: "d:inline-flex p:2",
   variants: {
     tone: { accent: "bg-color:blue-500 text-color:white" },
   },
@@ -77,10 +100,18 @@ const badge = recipe({
 type BadgeProps = VariantProps<typeof badge> & ClassProp;
 ```
 
-`cn` understands Standard and canonical icon conflicts but does not validate
-values. `recipe` supports string or named-element `className` definitions,
-variants, compounds, and exact-reciper extension. Import low-level factories
-such as `createMerger` and `createReciper` from `@teacss/classes`.
+`cn` understands Standard conflicts and merges all `icon:value` declarations
+by prefix without validating values. `recipe` uses string or named-element
+`defaults` for base styles, `variants` for conditional styles, and
+`defaultVariants` for initial selections. It supports compounds and extension
+within the same loaded classes module.
+These functions and their `ClassDict`, `ClassValue`, `Merger`, `ClassProp`,
+`RecipeIntrospection`, `Reciper`, and `VariantProps` types are exported only by
+`@teacss/classes`. The `teacss` root no longer re-exports them.
+
+Custom merger hooks, injected recipe mergers, and preset-only merge entries are
+not supported. See the [migration guide](../../docs/guides/upgrading-to-0-6.md#2-classes-与-recipe)
+when upgrading an integration that used them.
 
 Standard constant tables are re-exported from the root; there is no
 `teacss/constants` subpath.

package/bin/teacss.mjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import "@teacss/cli/cli";

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+import { CliOptions, CliWatchSession, build, checkProject, initializeConfig } from "@teacss/cli";
+export { type CliOptions, type CliWatchSession, build, checkProject, initializeConfig };

package/dist/cli.js

@@ -0,0 +1 @@
+import{build as e,checkProject as t,initializeConfig as n}from"@teacss/cli";export{e as build,t as checkProject,n as initializeConfig};

package/dist/index.d.ts

@@ -1,7 +1 @@
-import { ClassProp, Merger, RecipeIntrospection, Reciper, VariantProps, omitAttributes } from "@teacss/classes";
-export * from "@teacss/preset-standard/constants";
-//#region src/index.d.ts
-export declare const cn: Merger;
-export declare const recipe: Reciper;
-//#endregion
-export { type ClassProp, type RecipeIntrospection, type VariantProps, omitAttributes };
+export * from "@teacss/preset-standard/constants";

package/dist/index.js

@@ -1 +1 @@
-import{createMerger as e,createReciper as t,omitAttributes as n}from"@teacss/classes";import{pluginIcon as r}from"@teacss/preset-icons/merge";import{pluginStandard as i}from"@teacss/preset-standard/merge";export*from"@teacss/preset-standard/constants";const a=e({plugins:[i,r]});let o;const s=(e=>(o??=t({merge:a}),o(e)));export{a as cn,n as omitAttributes,s as recipe};
+export*from"@teacss/preset-standard/constants";export{};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "teacss",
-  "version": "0.5.2",
-  "description": "The TeaCSS application entry with the official `cn`, `recipe`, engine, and preset subpaths.",
+  "version": "0.6.2",
+  "description": "TeaCSS developer tooling with a CLI and engine and preset subpaths.",
   "homepage": "https://css.teasim.com",
   "funding": "https://github.com/sponsors/billgo",
   "license": "MIT",
@@ -10,6 +10,7 @@
   "type": "module",
   "exports": {
     ".": "./dist/index.js",
+    "./cli": "./dist/cli.js",
     "./core": "./dist/core.js",
     "./preset-icons": "./dist/preset-icons.js",
     "./preset-official": "./dist/preset-official.js",
@@ -17,7 +18,11 @@
     "./package.json": "./package.json"
   },
   "types": "./dist/index.d.ts",
+  "bin": {
+    "teacss": "./bin/teacss.mjs"
+  },
   "files": [
+    "bin",
     "dist",
     "README.md"
   ],
@@ -26,11 +31,11 @@
     "dev": "tsdown --watch"
   },
   "dependencies": {
-    "@teacss/classes": "0.5.2",
-    "@teacss/core": "0.5.2",
-    "@teacss/preset-icons": "0.5.2",
-    "@teacss/preset-official": "0.5.2",
-    "@teacss/preset-standard": "0.5.2"
+    "@teacss/cli": "0.6.2",
+    "@teacss/core": "0.6.2",
+    "@teacss/preset-icons": "0.6.2",
+    "@teacss/preset-official": "0.6.2",
+    "@teacss/preset-standard": "0.6.2"
   },
   "engines": {
     "node": ">=22.12.0"