Style Dictionary中尺寸转换过滤器的文档修正说明

在Style Dictionary项目中，有一个关于尺寸转换过滤器的文档错误需要引起开发者注意。本文将详细解释这个问题及其修正方案。

问题背景

Style Dictionary是一个强大的设计令牌管理工具，它提供了多种预定义的转换器(transforms)来处理设计系统中的各种令牌类型。其中，size/compose/remToDp和size/compose/remToSp是两个常用的尺寸转换器，用于将rem单位转换为平台特定的尺寸单位。

当前问题

在源代码实现中，这两个转换器使用了不同的过滤器：

1. size/compose/remToDp使用了isDimension过滤器
2. size/compose/remToSp使用了isFontSize过滤器

这种区分是合理的，因为：

• dp(密度无关像素)通常用于一般的尺寸测量
• sp(缩放像素)专门用于字体大小，会考虑用户的字体大小偏好设置

然而，在官方文档中，size/compose/remToDp的匹配条件被错误地记录为token.type === 'isFontSize'，这会导致开发者在使用时产生混淆。

技术影响

这个文档错误可能会导致以下问题：

1. 开发者可能错误地认为remToDp转换器只适用于字体大小相关的令牌
2. 在实际使用中，一些应该被转换的尺寸令牌可能被错误地排除
3. 开发者可能会对转换器的预期行为产生误解

正确实现

正确的文档应该反映实际的代码实现：

• size/compose/remToDp应匹配token.type === 'dimension'
• size/compose/remToSp应匹配token.type === 'fontSize'

这种区分确保了：

• 一般尺寸使用dp转换
• 字体相关尺寸使用sp转换(考虑用户的可访问性设置)

最佳实践建议

在使用这些转换器时，开发者应该：

1. 明确区分一般尺寸和字体尺寸的设计令牌
2. 为字体相关的尺寸使用fontSize类型
3. 为非字体相关的尺寸使用dimension类型
4. 在配置转换器时，确保类型匹配正确

总结

文档准确性对于开源项目至关重要，特别是像Style Dictionary这样的工具库，它被广泛用于设计系统的基础设施建设。这个特定的文档错误虽然看起来很小，但可能会影响开发者对尺寸转换行为的理解和使用。正确的文档应该反映代码的实际行为，即size/compose/remToDp转换器匹配dimension类型的令牌，而不是fontSize类型。