@weapp-tailwindcss/cli 4.0.0-alpha.8 → 5.3.0

package/README.md

@@ -1,7 +1,58 @@
 # @weapp-tailwindcss/cli
 
-`weapp-tailwindcss` 的 原生小程序 `CLI` 启动插件
+> English | [简体中文](./README.zh-CN.md)
 
-相关文档:
+A Tailwind CSS v4 command-line interface for Web and mini-program CSS. It generates browser-compatible Web CSS by default and can emit mini-program-compatible CSS explicitly with `--target weapp`.
 
-👉 [https://tw.icebreaker.top/](https://tw.icebreaker.top/docs/quick-start/native/install)
+> [!IMPORTANT]
+> Versions `3.x` and `4.0.0-alpha.x` on npm belong to the legacy Gulp workflow for native mini programs. The current CLI starts from the `5.x` release line and does not provide the legacy `init`, Sass/Less, or project-directory scanning workflow.
+
+## Installation
+
+```bash
+pnpm add -D @weapp-tailwindcss/cli weapp-tailwindcss tailwindcss
+```
+
+## Quick start
+
+`weapp-tw` and `weapp-tailwindcss` are equivalent command names:
+
+```bash
+pnpm exec weapp-tw -i src/input.css -o dist/output.css
+pnpm exec weapp-tw build -i src/input.css -o dist/output.css --minify
+pnpm exec weapp-tailwindcss canonicalize "py-3 p-1 px-3"
+```
+
+The CLI reuses the Tailwind v4 generator, design system, and CSS transformation APIs from `weapp-tailwindcss`. It neither depends on nor invokes `@tailwindcss/cli`.
+
+## Output targets
+
+| Target | Behavior |
+| --- | --- |
+| `web` | The default. Preserves Tailwind CSS browser selectors, escaping, and Web semantics. |
+| `weapp` | Transforms generated CSS for mini-program style environments. |
+
+`--target weapp` is CSS-only. It does not scan or rewrite WXML, JavaScript, TypeScript, JSX, TSX, or existing WXSS assets. Use the Vite, Webpack, Rspack, or Gulp integrations from `weapp-tailwindcss` for complete mini-program projects.
+
+## Watch mode
+
+Watch mode uses native file-system events through `@parcel/watcher` by default. Pass `--poll` or `--poll=500` to use polling instead. The CLI also falls back automatically when the native watcher is unavailable.
+
+```bash
+pnpm exec weapp-tw -i src/input.css -o dist/output.css --watch
+pnpm exec weapp-tw -i src/input.css -o dist/output.css --watch --poll=500
+```
+
+## Programmatic API
+
+```ts
+import { runCli } from '@weapp-tailwindcss/cli'
+
+const exitCode = await runCli(['-i', 'src/input.css', '-o', 'dist/output.css'])
+```
+
+Importing the package does not execute the CLI. `runCli` follows the same stdout, stderr, and `process.exitCode` behavior as the binary.
+
+## Documentation
+
+See the [CLI guide](https://tw.icebreaker.top/docs/tools/weapp-tw-cli) for all options, stdin/stdout, source maps, watch mode, and `canonicalize`.

package/README.zh-CN.md

@@ -0,0 +1,58 @@
+# @weapp-tailwindcss/cli
+
+> [English](./README.md) | 简体中文
+
+面向 Web 与小程序 CSS 的 Tailwind CSS v4 命令行工具。默认保持浏览器语义生成 Web CSS，也可以通过 `--target weapp` 显式输出小程序兼容 CSS。
+
+> [!IMPORTANT]
+> npm 上的 `3.x` 与 `4.0.0-alpha.x` 属于旧版原生小程序 Gulp 工具链。当前 CLI 从 `5.x` 版本线开始发布，不再提供旧版 `init`、Sass/Less 或项目目录扫描流程。
+
+## 安装
+
+```bash
+pnpm add -D @weapp-tailwindcss/cli weapp-tailwindcss tailwindcss
+```
+
+## 快速开始
+
+`weapp-tw` 与 `weapp-tailwindcss` 是等价的命令入口：
+
+```bash
+pnpm exec weapp-tw -i src/input.css -o dist/output.css
+pnpm exec weapp-tw build -i src/input.css -o dist/output.css --minify
+pnpm exec weapp-tailwindcss canonicalize "py-3 p-1 px-3"
+```
+
+CLI 复用 `weapp-tailwindcss` 的 Tailwind v4 generator、design system 与 CSS 转换能力，不依赖或调用 `@tailwindcss/cli`。
+
+## 输出目标
+
+| 目标 | 行为 |
+| --- | --- |
+| `web` | 默认目标，保留 Tailwind CSS 的浏览器选择器、转义与 Web 语义。 |
+| `weapp` | 只转换生成后的 CSS，使其兼容小程序样式环境。 |
+
+`--target weapp` 不扫描或改写 WXML、JavaScript、TypeScript、JSX、TSX 或已有 WXSS。完整小程序项目应继续使用 `weapp-tailwindcss` 的 Vite、Webpack、Rspack 或 Gulp 集成。
+
+## Watch
+
+watch 默认使用 `@parcel/watcher` 原生文件系统事件。使用 `--poll` 或 `--poll=500` 可切换为轮询；原生 watcher 不可用时会自动降级。
+
+```bash
+pnpm exec weapp-tw -i src/input.css -o dist/output.css --watch
+pnpm exec weapp-tw -i src/input.css -o dist/output.css --watch --poll=500
+```
+
+## 程序化调用
+
+```ts
+import { runCli } from '@weapp-tailwindcss/cli'
+
+const exitCode = await runCli(['-i', 'src/input.css', '-o', 'dist/output.css'])
+```
+
+导入包不会自动执行命令。`runCli` 沿用命令行的 stdout、stderr 与 `process.exitCode` 语义。
+
+## 文档
+
+完整参数、stdin/stdout、source map、watch 与 `canonicalize` 用法见 [CLI 使用指南](https://tw.icebreaker.top/zh-cn/docs/tools/weapp-tw-cli)。

package/dist/bin.cjs

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+const require_src = require("./src-C97Lmsr-.cjs");
+let node_process = require("node:process");
+node_process = require_src.__toESM(node_process, 1);
+//#region src/bin.ts
+node_process.default.title = "node (@weapp-tailwindcss/cli)";
+require_src.runCli().then((exitCode) => {
+	node_process.default.exitCode = exitCode;
+});
+//#endregion

package/dist/bin.d.ts

@@ -0,0 +1 @@
+export {}

package/dist/bin.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+import { t as runCli } from "./src-CiuzVG0J.js";
+import process from "node:process";
+//#region src/bin.ts
+process.title = "node (@weapp-tailwindcss/cli)";
+runCli().then((exitCode) => {
+	process.exitCode = exitCode;
+});
+//#endregion
+export {};