首页
/ Style Dictionary v4 迁移指南:format 与 formatter 的正确使用

Style Dictionary v4 迁移指南:format 与 formatter 的正确使用

2025-06-15 20:17:27作者:裴麒琰

在 Style Dictionary v4 版本升级过程中,配置项命名的一个关键变化是将 formatter 改为 format。这个变化虽然看似简单,但对于开发者正确配置样式字典至关重要。

背景说明

Style Dictionary 是一个强大的设计令牌管理工具,允许开发者将设计系统转化为跨平台可用的代码。在 v4 版本中,开发团队对 API 进行了多项优化,其中就包括配置项命名的标准化。

关键变更点

在 v3 版本中,开发者使用 formatter 属性来定义输出格式:

{
  formatter: () => {...}
}

而在 v4 版本中,这个属性被简化为 format

  format: () => {...}
}

版本兼容性说明

值得注意的是,在 v4.0.0-prerelease.26 版本中,源代码仍然保留了 formatter 的使用方式。这是因为文档更新先于代码变更发布造成的暂时性不一致。这个问题在 prerelease.27 版本中已经得到修复。

最佳实践建议

对于正在迁移到 v4 版本的开发者:

  1. 确保使用 v4.0.0-prerelease.27 或更高版本
  2. 在配置文件中统一使用 format 而非 formatter
  3. 如果遇到兼容性问题,检查 Style Dictionary 的确切版本

总结

这个变更体现了 Style Dictionary 团队对 API 简洁性的追求。虽然是一个小的命名变化,但统一使用 format 能使配置更加直观和一致。开发者在迁移过程中应该注意版本差异,确保使用最新的 API 规范。

登录后查看全文
热门项目推荐