Figma Sync

🔄 设计代码双向同步,一键生成多平台组件

双向同步 Figma 设计与代码,自动生成 React Native/Expo TS 或 Web React+Tailwind 组件,支持设计令牌提取、差异对比与增量回写。

收藏
4.9k
安装
1.9k
版本
1.0.0
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

figma-sync 是一款面向设计与开发协作的双向同步工具,打通 Figma 设计稿与前端代码的闭环。核心工作流包括:

1. Pull 拉取:通过 Figma REST API 读取文件,提取设计令牌(colors, typography, spacing, effects),并生成目标平台的组件代码。支持 rn-expo(React Native + Expo + TypeScript)和 web-react(React + Tailwind CSS)两种输出格式。

2. Push 回写:将本地设计模型的变更以补丁形式写回 Figma,默认 Dry-run 预览,确认后 --execute 执行。

3. Diff 对比:比对本地 designModel.json 与远程 Figma 状态,输出变更集与可应用的 patchSpec

4. Preview 预览:在不修改任何内容的前提下,模拟操作结果。

配置仅需设置 FIGMA_TOKEN 环境变量,通过 --file-key 指定目标文件,支持 --node-ids 精准选取图层。内置指数退避、ETag 缓存及速率限制保护(约 30 req/min),缓存存储于 .figma-cache/

显著优点

  • 双向同步:打破设计稿与代码单向导出的局限,实现设计系统的持续对齐。
  • 多平台生成:原生支持移动端(Expo)与 Web(Tailwind)双栈,一套设计源多端复用。
  • 增量补丁:Diff/Patch 机制避免全量覆盖,降低协作冲突风险。
  • 安全可控:Push 操作默认 Dry-run,强制执行需显式开关,配合预览能力减少误操作。
  • 令牌化架构:提取标准化 Design Tokens,便于跨团队/跨工具的设计系统治理。

潜在缺点与局限性

  • API 依赖:完全依赖 Figma REST API 稳定性与速率限制,大规模文件同步可能耗时较长。
  • 生成代码质量:自动生成的组件代码可能需要人工微调,复杂交互逻辑(手势、动画)无法自动推导。
  • 权限要求:需要具有写入权限的 Personal Access Token,团队级协作需考虑密钥安全分发。
  • 平台覆盖有限:目前仅支持 React 技术栈,Vue、Flutter、SwiftUI 等未覆盖。
  • 缓存一致性:本地缓存若未及时失效,可能导致对比结果与远程实际状态偏差。

适合人群

  • 采用 Design Token 驱动的跨职能产品团队
  • 使用 React Native/Expo 开发移动应用的前端工程师
  • 需要维护设计-代码一致性的设计系统负责人
  • 追求自动化、减少设计交付手工搬运的中大型项目

常规风险

  • Token 泄露FIGMA_TOKEN 若硬编码或误提交,可能导致 Figma 文件被未授权访问或篡改。
  • 误覆盖风险:尽管有 Dry-run 保护,强制执行前若未充分 review patch,可能意外覆盖设计师最新改动。
  • API 变更:Figma API 版本迭代可能导致字段解析异常,需持续维护脚本兼容性。
  • 并发写入冲突:多成员同时 Push 可能产生覆盖竞争,建议配合分支化设计稿或锁机制使用。

Figma Sync 内容

references文件夹
scripts文件夹
手动下载zip · 22.9 kB
api-guide.mdtext/markdown
请选择文件