@weapp-tailwindcss/merge 2.2.1 → 2.2.3

package/README.md

@@ -1,100 +1,36 @@
-<p align="center">
+# @weapp-tailwindcss/merge
 
-<a href="https://tw.icebreaker.top">
+> English | [简体中文](./README.zh-CN.md)
 
-<img src="./assets/logo.png" alt="weapp-tailwindcss-logo" width="128">
-</a>
+A cross-platform wrapper around Tailwind Merge v3. It resolves conflicting utilities while keeping arbitrary values, `rpx`, and mini-program-safe class escaping consistent with `weapp-tailwindcss`.
 
-<br>
+## Installation
 
-<h1 align="center">weapp-tailwindcss</h1>
+```bash
+pnpm add @weapp-tailwindcss/merge
+```
 
-</p>
+## Usage
 
-> 简体中文(zh-cn) | [English](./README_en.md)
+```ts
+import { twMerge } from '@weapp-tailwindcss/merge'
 
-![star](https://badgen.net/github/stars/sonofmagic/weapp-tailwindcss)
-![dm0](https://badgen.net/npm/dm/weapp-tailwindcss)
-![dm1](https://badgen.net/npm/dm/weapp-tailwindcss-webpack-plugin)
-![license](https://badgen.net/npm/license/weapp-tailwindcss)
-[![test](https://github.com/sonofmagic/weapp-tailwindcss/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/sonofmagic/weapp-tailwindcss/actions/workflows/test.yml)
-[![codecov](https://codecov.io/gh/sonofmagic/weapp-tailwindcss/branch/main/graph/badge.svg?token=zn05qXYznt)](https://codecov.io/gh/sonofmagic/weapp-tailwindcss)
+const className = twMerge(
+  'rounded px-2 text-[28rpx]',
+  'px-4 text-surface-700',
+)
+```
 
-> [!NOTE]
-> 降低开发维护成本，提升开发效率的 `小程序` `tailwindcss` 全方面解决方案
->
-> `weapp-tailwindcss@4.2.x` 现已支持 `uni-app x` 同时构建 `Web`,`小程序`,`安卓`,`IOS`,`鸿蒙`，详见 [**uni-app x 专题**](https://tw.icebreaker.top/docs/uni-app-x)
+The default runtime returns escaped classes suitable for mini-program templates. Create an unescaped runtime when another target owns class serialization:
 
-\[[文档地址](https://tw.icebreaker.top)\] \| \[[备用文档地址](https://ice-tw.netlify.app/)\] \| \[[加入技术交流群](https://tw.icebreaker.top/docs/community/group)\]
+```ts
+import { create } from '@weapp-tailwindcss/merge'
 
-- [特性](#特性)
-- [版本对应](#版本对应)
-- [安装与使用方式](#安装与使用方式)
-- [生态和解决方案](#生态和解决方案)
-- [常见问题](#常见问题)
-- [各个框架的模板](#各个框架的模板)
-- [旧版本迁移指南](#旧版本迁移指南)
-- [配置项参考](#配置项参考)
-- [Contribute](#contribute)
-- [License](#license)
-- [Star History](#star-history)
-- [Related projects](#related-projects)
-  - [weapp-vite](#weapp-vite)
+const { twMerge } = create({ escape: false })
+```
 
-## 特性
+Use the `slim` entry for a smaller preconfigured class-group set or `lite` when you only need joining and escaping without conflict resolution.
 
-| 不仅仅是`webpack`                                   | 主流框架与原生开发支持                          |
-| --------------------------------------------------- | ----------------------------------------------- |
-| ![wepback+vite+gulp](./assets/weapp-tw-plugins.png) | ![frameworks](./assets/weapp-tw-frameworks.png) |
+## Documentation
 
-核心插件支持 `webpack`/`vite`/`rspack`/`rollup`/`rolldown`/`gulp` 为基底的框架类小程序开发，涵盖了市面上几乎所有的主流的开发框架。
-
-也支持直接从各个开发者工具中，直接创建的原生小程序应用。
-
-这些插件能够自动识别并精确处理所有 `tailwindcss` 的工具类来适配小程序环境。
-
-## 版本对应
-
-目前，`weapp-tailwindcss` 的 `4.x` 版本
-
-- 支持最新版本的 `tailwindcss v4` 和 `v3` 还有 `v2 jit` 版本。
-- 支持 `webpack5`，`webpack4`, `vite` 和 `gulp` 这些打包工具，也支持纯 `Nodejs` API 的方式，集成到你自己的构建工具中。
-
-> 如果你还在使用 `tailwindcss@2` 版本，那你应该使用从 `weapp-tailwindcss/webpack4` 导出的本插件的 `postcss7` `webpack4` 版本。另外请确保你的 `nodejs` 版本 `>=16.6.0`。目前低于 `16` 的长期维护版本(`偶数版本`) 都已经结束了生命周期，建议安装 `nodejs` 的 `LTS` 版本，详见 [nodejs/release](https://github.com/nodejs/release)
-
-## [安装与使用方式](https://tw.icebreaker.top/docs/quick-start/install)
-
-## [生态和解决方案](https://tw.icebreaker.top/docs/community/templates)
-
-## [常见问题](https://tw.icebreaker.top/docs/issues/)
-
-## [各个框架的模板](https://tw.icebreaker.top/docs/community/templates)
-
-## [旧版本迁移指南](https://tw.icebreaker.top/docs/migrations/v2)
-
-## [配置项参考](https://tw.icebreaker.top/docs/api/interfaces/UserDefinedOptions)
-
-## Contribute
-
-我们邀请你来贡献和帮助改进 `weapp-tailwindcss` 💚💚💚
-
-以下有几个方式可以参与:
-
-- 报告错误：如果您遇到任何错误或问题，请提`issue`并提供完善的错误信息和复现方式。
-- 建议：有增强 `weapp-tailwindcss` 的想法吗？请提 `issue` 来分享您的建议。
-- 文档：如果您对文档有更好的见解或者更棒的修辞方式，欢迎 `pr`。
-- 代码：任何人的代码都不是完美的，我们欢迎你通过 `pr` 给代码提供更好的质量与活力。
-
-## License
-
-[MIT](./LICENSE)
-
-## Star History
-
-[![Star History Chart](https://api.star-history.com/svg?repos=sonofmagic/weapp-tailwindcss&type=Date)](https://star-history.com/#sonofmagic/weapp-tailwindcss&Date)
-
-## Related projects
-
-### weapp-vite
-
-[weapp-vite](https://vite.icebreaker.top/): 把现代化的开发模式带入小程序开发!
+See the [merge guide](https://tw.weapp.dev/docs/community/merge/overview) for configuration and migration details.

package/README.zh-CN.md

@@ -0,0 +1,36 @@
+# @weapp-tailwindcss/merge
+
+> [English](./README.md) | 简体中文
+
+Tailwind Merge v3 的跨端运行时封装。它在合并冲突 utility 的同时，让任意值、`rpx` 与小程序安全 class 转义保持和 `weapp-tailwindcss` 一致。
+
+## 安装
+
+```bash
+pnpm add @weapp-tailwindcss/merge
+```
+
+## 使用
+
+```ts
+import { twMerge } from '@weapp-tailwindcss/merge'
+
+const className = twMerge(
+  'rounded px-2 text-[28rpx]',
+  'px-4 text-surface-700',
+)
+```
+
+默认运行时返回可直接用于小程序模板的安全 class。其他目标端自行负责 class 序列化时，可以创建不转义的运行时：
+
+```ts
+import { create } from '@weapp-tailwindcss/merge'
+
+const { twMerge } = create({ escape: false })
+```
+
+需要更小的预配置 class group 时使用 `slim` 入口；只需要拼接与转义、不需要冲突合并时使用 `lite` 入口。
+
+## 文档
+
+配置与迁移说明见 [merge 指南](https://tw.weapp.dev/zh-cn/docs/community/merge/overview)。

package/dist/index.cjs

@@ -2,13 +2,14 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 let _weapp_tailwindcss_runtime = require("@weapp-tailwindcss/runtime");
 let tailwind_merge = require("tailwind-merge");
 //#region src/index.ts
+const rpxTransform = (0, _weapp_tailwindcss_runtime.createRpxLengthTransform)();
 const create = (0, _weapp_tailwindcss_runtime.createRuntimeFactory)({
 	createTailwindMerge: tailwind_merge.createTailwindMerge,
 	extendTailwindMerge: tailwind_merge.extendTailwindMerge,
 	twJoin: tailwind_merge.twJoin,
 	twMerge: tailwind_merge.twMerge,
 	version: 3,
-	...(0, _weapp_tailwindcss_runtime.createRpxLengthTransform)()
+	...rpxTransform
 });
 const { version: tailwindMergeVersion, twMerge, twJoin, extendTailwindMerge, createTailwindMerge } = create();
 //#endregion

package/dist/index.d.cts

@@ -1,6 +1,5 @@
 import { ClassValue, CreateOptions, EscapeConfig, UnescapeConfig, weappTwIgnore } from "@weapp-tailwindcss/runtime";
 import { getDefaultConfig, mergeConfigs } from "tailwind-merge";
-
 //#region src/index.d.ts
 declare const create: (createOptions?: import("@weapp-tailwindcss/runtime").CreateOptions) => {
   version: import("@weapp-tailwindcss/runtime").TailwindMergeVersion;

package/dist/index.d.mts

@@ -1,6 +1,5 @@
 import { ClassValue, CreateOptions, EscapeConfig, UnescapeConfig, weappTwIgnore } from "@weapp-tailwindcss/runtime";
 import { getDefaultConfig, mergeConfigs } from "tailwind-merge";
-
 //#region src/index.d.ts
 declare const create: (createOptions?: import("@weapp-tailwindcss/runtime").CreateOptions) => {
   version: import("@weapp-tailwindcss/runtime").TailwindMergeVersion;

package/dist/index.mjs

@@ -1,13 +1,14 @@
 import { createRpxLengthTransform, createRuntimeFactory, weappTwIgnore } from "@weapp-tailwindcss/runtime";
 import { createTailwindMerge as createTailwindMerge$1, extendTailwindMerge as extendTailwindMerge$1, getDefaultConfig, mergeConfigs, twJoin as twJoin$1, twMerge as twMerge$1 } from "tailwind-merge";
 //#region src/index.ts
+const rpxTransform = createRpxLengthTransform();
 const create = createRuntimeFactory({
 	createTailwindMerge: createTailwindMerge$1,
 	extendTailwindMerge: extendTailwindMerge$1,
 	twJoin: twJoin$1,
 	twMerge: twMerge$1,
 	version: 3,
-	...createRpxLengthTransform()
+	...rpxTransform
 });
 const { version: tailwindMergeVersion, twMerge, twJoin, extendTailwindMerge, createTailwindMerge } = create();
 //#endregion

package/dist/lite.cjs

@@ -2,13 +2,14 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 let _weapp_tailwindcss_runtime = require("@weapp-tailwindcss/runtime");
 let tailwind_merge = require("tailwind-merge");
 //#region src/lite.ts
+const rpxTransform = (0, _weapp_tailwindcss_runtime.createRpxLengthTransform)();
 const create = (0, _weapp_tailwindcss_runtime.createRuntimeFactory)({
 	createTailwindMerge: tailwind_merge.createTailwindMerge,
 	extendTailwindMerge: tailwind_merge.createTailwindMerge,
 	twJoin: tailwind_merge.twJoin,
 	twMerge: tailwind_merge.twJoin,
 	version: 3,
-	...(0, _weapp_tailwindcss_runtime.createRpxLengthTransform)()
+	...rpxTransform
 });
 const { version: tailwindMergeVersion, twJoin, extendTailwindMerge: _wrappedExtendTailwindMerge, createTailwindMerge } = create();
 //#endregion

package/dist/lite.d.cts

@@ -1,6 +1,5 @@
 import { ClassValue, CreateOptions, EscapeConfig, UnescapeConfig, weappTwIgnore } from "@weapp-tailwindcss/runtime";
 import { mergeConfigs } from "tailwind-merge";
-
 //#region src/lite.d.ts
 declare const create: (createOptions?: import("@weapp-tailwindcss/runtime").CreateOptions) => {
   version: import("@weapp-tailwindcss/runtime").TailwindMergeVersion;

package/dist/lite.d.mts

@@ -1,6 +1,5 @@
 import { ClassValue, CreateOptions, EscapeConfig, UnescapeConfig, weappTwIgnore } from "@weapp-tailwindcss/runtime";
 import { mergeConfigs } from "tailwind-merge";
-
 //#region src/lite.d.ts
 declare const create: (createOptions?: import("@weapp-tailwindcss/runtime").CreateOptions) => {
   version: import("@weapp-tailwindcss/runtime").TailwindMergeVersion;

package/dist/lite.mjs

@@ -1,13 +1,14 @@
 import { createRpxLengthTransform, createRuntimeFactory, weappTwIgnore } from "@weapp-tailwindcss/runtime";
 import { createTailwindMerge as createTailwindMerge$1, mergeConfigs, twJoin as twJoin$1 } from "tailwind-merge";
 //#region src/lite.ts
+const rpxTransform = createRpxLengthTransform();
 const create = createRuntimeFactory({
 	createTailwindMerge: createTailwindMerge$1,
 	extendTailwindMerge: createTailwindMerge$1,
 	twJoin: twJoin$1,
 	twMerge: twJoin$1,
 	version: 3,
-	...createRpxLengthTransform()
+	...rpxTransform
 });
 const { version: tailwindMergeVersion, twJoin, extendTailwindMerge: _wrappedExtendTailwindMerge, createTailwindMerge } = create();
 //#endregion

package/dist/slim.cjs

@@ -1533,11 +1533,13 @@ const rpxTransform = (0, _weapp_tailwindcss_runtime.createRpxLengthTransform)();
 function _extendTailwindMerge(configExtension, ...createConfig) {
 	return typeof configExtension === "function" ? (0, tailwind_merge.createTailwindMerge)(getSlimConfig, configExtension, ...createConfig) : (0, tailwind_merge.createTailwindMerge)(() => (0, tailwind_merge.mergeConfigs)(getSlimConfig(), configExtension), ...createConfig);
 }
+/** 基于 Slim_Config 的预配置 twMerge */
+const _twMerge = (0, tailwind_merge.createTailwindMerge)(getSlimConfig);
 const create = (0, _weapp_tailwindcss_runtime.createRuntimeFactory)({
 	createTailwindMerge: tailwind_merge.createTailwindMerge,
 	extendTailwindMerge: _extendTailwindMerge,
 	twJoin: tailwind_merge.twJoin,
-	twMerge: (0, tailwind_merge.createTailwindMerge)(getSlimConfig),
+	twMerge: _twMerge,
 	version: 3,
 	...rpxTransform
 });

package/dist/slim.d.cts

@@ -1,6 +1,5 @@
 import { ClassValue, CreateOptions, EscapeConfig, UnescapeConfig, weappTwIgnore } from "@weapp-tailwindcss/runtime";
 import { Config, mergeConfigs } from "tailwind-merge";
-
 //#region src/slim-config.d.ts
 /**
  * 精简版 tailwind-merge 配置，仅包含小程序场景中高频使用的 Tailwind 类冲突分组。

package/dist/slim.d.mts

@@ -1,6 +1,5 @@
 import { ClassValue, CreateOptions, EscapeConfig, UnescapeConfig, weappTwIgnore } from "@weapp-tailwindcss/runtime";
 import { Config, mergeConfigs } from "tailwind-merge";
-
 //#region src/slim-config.d.ts
 /**
  * 精简版 tailwind-merge 配置，仅包含小程序场景中高频使用的 Tailwind 类冲突分组。

package/dist/slim.mjs

@@ -1532,11 +1532,13 @@ const rpxTransform = createRpxLengthTransform();
 function _extendTailwindMerge(configExtension, ...createConfig) {
 	return typeof configExtension === "function" ? createTailwindMerge$1(getSlimConfig, configExtension, ...createConfig) : createTailwindMerge$1(() => mergeConfigs(getSlimConfig(), configExtension), ...createConfig);
 }
+/** 基于 Slim_Config 的预配置 twMerge */
+const _twMerge = createTailwindMerge$1(getSlimConfig);
 const create = createRuntimeFactory({
 	createTailwindMerge: createTailwindMerge$1,
 	extendTailwindMerge: _extendTailwindMerge,
 	twJoin: twJoin$1,
-	twMerge: createTailwindMerge$1(getSlimConfig),
+	twMerge: _twMerge,
 	version: 3,
 	...rpxTransform
 });

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@weapp-tailwindcss/merge",
   "type": "module",
-  "version": "2.2.1",
-  "description": "Tailwind Merge v3 的 weapp 运行时封装，自动处理 escape/unescape。",
+  "version": "2.2.3",
+  "description": "Cross-platform Tailwind CSS class merging runtime with mini-program compatibility. 兼容小程序的跨端 Tailwind CSS 类名合并运行时。",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
-  "homepage": "https://tw.icebreaker.top/docs/community/merge/overview",
+  "homepage": "https://tw.weapp.dev/docs/community/merge/overview",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sonofmagic/weapp-tailwindcss.git",
@@ -73,11 +73,11 @@
   },
   "dependencies": {
     "@weapp-core/escape": "^8.0.0",
-    "tailwind-merge": "^3.6.0",
-    "@weapp-tailwindcss/runtime": "0.1.6"
+    "@weapp-tailwindcss/runtime": "0.1.8",
+    "tailwind-merge": "^3.6.0"
   },
   "devDependencies": {
-    "fast-check": "^4.8.0"
+    "fast-check": "^4.9.0"
   },
   "scripts": {
     "dev": "tsdown --watch --sourcemap",