feat: 允许 escape/unescape 传入 true/false 布尔值

Author: sonofmagic

.changeset/odd-meals-taste.md

@@ -0,0 +1,5 @@
+---
+"@weapp-tailwindcss/runtime": patch
+---
+
+允许 `escape`/`unescape` 传入 `true`/`false` 布尔值，并保持默认转换行为一致。

package.json

@@ -50,7 +50,7 @@
     "build:nocache": "cross-env TURBO_FORCE=1 pnpm build",
     "build:docs": "turbo run build --filter=./website/",
     "build:apps": "turbo run build --filter=./apps/*",
-    "build:pkgs": "turbo run build --filter=./packages/*",
+    "build:pkgs": "turbo run build --filter=./packages/* --filter=./packages-runtime/*",
     "build:demo": "turbo run build --filter=./demo/*",
     "build:analyze": "tsx scripts/check-build-size.ts",
     "test": "vitest run",

packages-runtime/cva/test/cva.test.ts

@@ -15,6 +15,13 @@ describe('cva runtime', () => {
     expect(badge()).toBe('text-[#ececec]')
   })
 
+  it('accepts boolean escape/unescape options', () => {
+    const { cva: rawCva } = create({ escape: true, unescape: true })
+    const badge = rawCva('text-[#ececec]')
+
+    expect(badge()).toBe('text-_b_hececec_B')
+  })
+
   it('normalizes escaped classes before evaluating variants', () => {
     const badge = cva('text-_b_hececec_B', {
       variants: {

packages-runtime/merge-v3/test/runtime.test.ts

@@ -25,6 +25,12 @@ describe('merge-v3 runtime exports', () => {
     expect(rawTwMerge('text-[#ececec]')).toBe('text-[#ececec]')
   })
 
+  it('accepts boolean escape/unescape options', () => {
+    const { twMerge: rawTwMerge } = create({ escape: true, unescape: true })
+
+    expect(rawTwMerge('text-[#ececec]', 'text-[#ECECEC]')).toBe('text-_b_hECECEC_B')
+  })
+
   it('treats rpx arbitrary values as lengths for color-like utilities', () => {
     expect(twMerge('text-red', 'text-[80rpx]')).toBe('text-red text-_b80rpx_B')
     expect(twMerge('border-red-500', 'border-[10rpx]')).toBe('border-red-500 border-_b10rpx_B')

packages-runtime/merge/test/v4.unit.test.ts

@@ -24,4 +24,10 @@ describe('v4 runtime exports', () => {
 
     expect(rawTwMerge('text-[#ececec]')).toBe('text-[#ececec]')
   })
+
+  it('accepts boolean escape/unescape options', () => {
+    const { twMerge: rawTwMerge } = create({ escape: true, unescape: true })
+
+    expect(rawTwMerge('text-[#ececec]', 'text-[#ECECEC]')).toBe('text-_b_hECECEC_B')
+  })
 })

packages-runtime/runtime/src/transformers.ts

@@ -8,7 +8,7 @@ import {
 
 const identity = (value: string) => value
 
-function isConfig<T extends object>(value: false | T | undefined): value is T {
+function isConfig<T extends object>(value: boolean | T | undefined): value is T {
   return typeof value === 'object' && value !== null
 }
 

packages-runtime/runtime/src/types.ts

@@ -1,9 +1,9 @@
 import type { EscapeOptions, UnescapeOptions } from '@weapp-core/escape'
 import type { ClassValue } from 'clsx'
 
-export type EscapeConfig = false | EscapeOptions
+export type EscapeConfig = boolean | EscapeOptions
 
-export type UnescapeConfig = false | UnescapeOptions
+export type UnescapeConfig = boolean | UnescapeOptions
 
 export interface CreateOptions {
   escape?: EscapeConfig

packages-runtime/runtime/test/create-runtime.test.ts

@@ -11,7 +11,7 @@ describe('createRuntimeFactory', () => {
       value: `prepared:${value}`,
       metadata: 'meta-token',
     }))
-    const restoreValue = vi.fn((value: string, metadata?: string) => {
+    const restoreValue = vi.fn((value: string, metadata?: unknown) => {
       expect(metadata).toBe('meta-token')
       return value.replace('prepared:', 'restored:')
     })
@@ -74,6 +74,24 @@ describe('createRuntimeFactory', () => {
     expect(merged).toBe('text-[#ececec]')
   })
 
+  it('accepts boolean escape/unescape options', () => {
+    const twMergeImpl = vi.fn((value: string) => value)
+
+    const createRuntime = createRuntimeFactory({
+      version: 3,
+      twMerge: twMergeImpl,
+      twJoin: twMergeImpl,
+      extendTailwindMerge: vi.fn(() => twMergeImpl),
+      createTailwindMerge: vi.fn(() => twMergeImpl),
+    })
+
+    const runtime = createRuntime({ escape: true, unescape: true })
+    const merged = runtime.twMerge('text-_b_hececec_B')
+
+    expect(twMergeImpl).toHaveBeenCalledWith('text-[#ececec]')
+    expect(merged).toBe('text-_b_hececec_B')
+  })
+
   it('accepts plain string responses from prepareValue hooks', () => {
     const twMergeImpl = vi.fn((value: string) => value)
     const prepareValue = vi.fn((value: string) => `prepared:${value}`)

packages-runtime/variants-v3/test/variants.test.ts

@@ -64,6 +64,13 @@ describe('variants-v3 runtime', () => {
     expect(badge()).toBe('text-[#ececec]')
   })
 
+  it('accepts boolean escape/unescape options', () => {
+    const { tv: rawTv } = create({ escape: true, unescape: true })
+    const badge = rawTv({ base: 'text-[#ececec]' })
+
+    expect(badge()).toBe('text-_b_hececec_B')
+  })
+
   it('respects disabled escape/unescape options in runtime factory', () => {
     const runtime = create({ escape: false, unescape: false })
     const badge = runtime.tv({

packages-runtime/variants/test/variants.test.ts

@@ -64,6 +64,13 @@ describe('variants runtime', () => {
     expect(badge()).toBe('text-[#ececec]')
   })
 
+  it('accepts boolean escape/unescape options', () => {
+    const { tv: rawTv } = createVariants({ escape: true, unescape: true })
+    const badge = rawTv({ base: 'text-[#ececec]' })
+
+    expect(badge()).toBe('text-_b_hececec_B')
+  })
+
   it('respects disabled escape/unescape options in runtime factory', () => {
     const runtime = createVariants({ escape: false, unescape: false })
     const badge = runtime.tv({