Style Dictionary项目中如何处理token引用时的前缀问题

在Style Dictionary项目中，开发者经常需要处理设计系统中的token前缀问题。本文将深入探讨如何灵活控制token引用时的前缀行为，特别是针对不同来源(token来源)的前缀差异化处理方案。

前缀问题的背景

在大型设计系统中，我们通常会为CSS变量添加前缀以避免命名冲突。例如：

--PREFIX-padding-sm: var(--PREFIX-size-4);

但有时我们希望引用的基础token不包含前缀：

--PREFIX-padding-sm: var(--size-4);

默认行为分析

Style Dictionary的默认行为是将配置的prefix应用于所有token，无论它们是来自include(基础token)还是source(项目特有token)。这种一刀切的方式在某些场景下并不理想。

自定义解决方案

通过自定义name转换器(transformer)，我们可以实现更精细的前缀控制。核心思路是：

1. 检查token的来源属性(isSource)
2. 根据条件决定是否应用prefix
3. 保留原有的路径转换逻辑

实现代码示例

以下是一个功能完整的自定义name转换器实现：

export default {
  name: 'name/pathToKebabCasePrefix',
  type: 'name',
  transformer: (token, platform = {}) => {
    const {prefix} = platform
    const addPrefix = platform.addPrefix ?? (() => true)

    const getPrefix = (token, addPrefix) => addPrefix(token) && prefix

    return (
      [getPrefix(token, addPrefix), ...token.path]
        .filter(part => typeof part === 'string' && part !== '@')
        .join('-')
    )
  },
}

关键点解析

1. 平台配置读取：从platform参数中获取prefix配置
2. 条件判断：通过addPrefix函数决定是否应用prefix
3. 路径处理：保留原有的路径转换和过滤逻辑
4. 灵活性：支持通过platform.addPrefix覆盖默认行为

实际应用建议

在实际项目中，你可以：

1. 为不同来源的token设置不同的prefix规则
2. 通过platform.addPrefix实现复杂的前缀逻辑
3. 结合其他转换器构建完整的设计系统管道

这种方案比在format阶段处理前缀更加灵活和可维护，是Style Dictionary推荐的最佳实践。

总结

通过自定义name转换器，我们可以精细控制Style Dictionary中token的前缀行为，满足不同来源token的前缀差异化需求。这种方法既保持了系统的灵活性，又不失可维护性，是处理复杂设计系统token命名的理想选择。