@design-parity/kit-index

设计包是自己的 词汇如此的目录 6个变体的组件可以说明6个变体中每个变体的哪个是工具包节点 相反,没有人手持这份清单.

问题

A 类 design-map.json 条目将代码组件绑定为 一个 设计节点 :

{ "code": "ui/Button.kt#FilledButton", "source": "figma", "ref": "figma:AbCdEf/57994:2324" }

这完全正确,对于对等 diff,而不足以为组件 生成多个变体。 描述目录 Button 3个大小和 两个形状有6个调子和1个调子, 没有说明哪一个套件节点 其他五个属于。 用手来想象它们,就是地图配置的扩展a 设计图的存在是为了避免——它静悄悄地漂移在工具包获得时 变量,因为缺少的条目读作 "没有对应的装备" 相当 比起来 "没有人看"。 。 。 .

因此,这个包 来源于工具包本身的出版.

输油管

  design kit
      │  dump   ── walk every page, deep
      ▼
  figma-inventory.json      disposable, megabytes
      │  build  ── keep only what design-map.json references
      │            + fetch the component properties the walk cannot see
      ▼
  figma-kit-index.json      COMMITTED, tens of kilobytes
      │  resolve ── project a code knob onto it
      ▼
  { nodeId, name }

只有两代的台阶触动网络 两者都是故意的 "更新词汇"操作 登陆一个承诺 一个审查者可以看到. 解析度与承诺指数相悖,从不使用活套,因此,对等 运行报告对每个人都一样 不需要设计工具的证书.

代码边从哪里来

地图及其变种声明 来源于 说明 而不是写作。 那半个住在上游 compose-ai-tools,因为 它所读的每个字段(@CatalogComponent(reference = …), (中文(简体) ), @CatalogVariant, (中文(简体) ), @OverrideVariant)是在那里定义的——它止于设计时 工具包的词汇需要:

  previews.json
      │  emit-design-map.mjs             compose-ai-tools: knows the ANNOTATIONS
      ├──▶ design-map.json               base refs, one per component
      └──▶ design-map-variants.json      "same component, these knobs turned" —
           (compose-preview-design-map-      unresolved, because `size=l` is a
            variants/v1)                     Compose fact and `Size=Large` is a
      │                                      kit fact
      │  design-parity-kit-index resolve  THIS PACKAGE: knows the KIT
      ▼
  design-map.json with a tagged ref/previewId pair per variant

resolve 只读已承诺的文件,所以与 dump编号 :build 它需要没有 证书,在每个建筑上都是安全的:

$ design-parity-kit-index resolve
Wrote design-map.json: 1 variant reference(s) across 1 component(s).

1 variant(s) are a component PROPERTY in the kit, not a variant beside it. A
definition node renders at the defaults, and no exact configured instance was
indexed for these values, so they remain unpaired:
  - Button/Filled / true (icon=true) — Button: `Icon` (INSTANCE_SWAP, default "54616:25409")

1 reference(s) draw optional content by default. Every render made from them
includes it, so a sticker that leaves it out is compared against something it
never claimed:
  - Button/Filled — Button: `Show icon`

三种错失的报告是分开的,因为他们的主人不同:a 变换工具包模型 绝对不行 是一个真正的空白; a 属性形状 一个 意思是这个工具箱有它,一个节点的参考点就是不能要求它 默认内容 表示已解决但绘制多于代码的引用 对 把它们拼凑在一起 就会把退休的图案看成是疏忽.

--check 把它变成一个漂移的大门 而不是一个作家。 A 类 碰撞 - 两个 解析到一个节点的预览被断然拒绝( exit 2, 无写入) : 相同的节点不能既是预览的对应点, 也可以是一幅这样写的地图 要求二人之一的 diff 报告是错的.

一种情况不是碰撞: 明确要求种子全名的变种 他们的套装财产完全kitAxis + 键 kitValue,哪个 @OverrideVariant(kitProps = …) 写入) 从预览中取出一个单元格 是通过翻译达到的,无论是基础预览还是隐含的变体. 因此,在一个状态下绘制的工具包单元格无法被捕获(a) 焦取出第一个项目,如)与驱动它的变体相配. 插槽保留着 校正并标记, 只更改其预览 。 每件索赔都作了报告,第二件索赔则作了报告 对同一个牢房的明确索赔仍然相互碰撞.

三种变异——只有两种是可以解决的

中行是静静地毒害等分结果的一行. GET /v1/images 在其 属性默认,而一个引用是一个节点代号 无处可挂 覆盖。 所以一个工具箱 Button 默认 Show icon 改为 true 为名称只表示的变体创建图标+标签引用 Type=Round, Size=Small 仅标有标签的代码显示 缺少图标 代码 错了.

出路不是改变装备 是有人已经放过 实例页,以及 那个实例的节点 id 是属性空间点的可渲染的控点 表达式。 。 。 . resolvePropertyInstance 找到它, 匹配 整体 属性 矢量,所以一个接近的失分 从来没有像一个精确的.

第三行是故意不放过. leading=icon 说内容 表示绝不是哪个节点能供给它 提到错误的事情.

支配规则

一个错误的翻译必须无所作为,而不是产生自信的坏 参考文献.

A 项下 design-led 一个错误的引用驱动 代码远离工具包 它正在复制,同时报告一个干净的对等结果,即: 现有最坏的结果。 每个未解决的种子被浮出水面作为未解决.

表面 有个原因但是,因为"没有对应的包"是真实的 几乎无一幸免. resolve 每个都分类 (单位:千美元)explainUnresolved:

第三列为分. 在一个真正的目录上,它变成了 error-unselected (state=unselected, status=error) - 在哪个地方 state=unselected 以自己的方式完全解决 no counterpart for status=error, (中文(简体) ), 拦住两个 size=small 使当 参考文献 实值 小变体.

当表格无法到达时:命名工具箱自己的拼写

一些没有翻译的值 。 3号材料包拼出一个取枣人 变体 Type=Full-screen (range); 目录种子 type=range 决定: 无所事事,而且——在以上理由表之前——默默无声地放弃了 比较中的节点. 工作比问题更糟糕:种子 type=full-screen (range) 在克特林, 和一个包 拼写,括号和所有, 成为目录来源中的负载, 下次套件会腐烂 重命名一个值.

因此,一个种子除了自己的外,还可以携带包名:

resolver.resolveVariant("figma:AbCdEf/53977:33595", {
  key: "action",
  raw: "longer",              // what the Compose knob is called
  kitAxis: "Configuration",   // what the kit calls the axis
  kitValue: "Text & longer action", // …and the value
});
// → { nodeId: "53977:33576", name: "Configuration=Text & longer action, …" }

三个属性值得了解:

• 权威而非暗示. 声明 替换 表格的别名 那个种子. size=l 自行决定罚款; size=l 声明 kitAxis: "Sise" 决定: 无倒地会打字 与正确的声明无法区分.
• 仍然检查与工具包. 宣布的轴或值必须是 因此,执政规则是: 没有人能宣布他们 到节点的方法 工具包不绘制。 他们得到的是 declared 上面的原因, 命名错失的拼写 和集的出版内容.
• 在任何剧本中都无标注或大小写匹配. of lines 发现 装箱 # of lines; 声明轴不应是打字工作。 仅 分隔器和分音符被忽略了——一个将轴归档为 サイズ 财务报告和审定财务报表 状態 在别处使用的涕丸正常化时,保持它们的差异 既去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去去.

同一准确性适用于申报的任何地方。 已宣布名称到达 (单位:千美元) 组成部分财产 与轴线一样容易——两个工具箱中的哪个是 它自己的生意,但它必须是财产的真名,所以 kitAxis: "focus" 不再通过 Show focus indicator 键的方式 focus 已经 打开 家庭 工具箱模型为 文件夹兄弟姐妹 而不是一套,一个宣布 值名 兄弟姐妹直截了当(Middle-inset,而不是 Inset 即将到来的人 搜索将会发现) 轴 拒绝:没有轴 名称。 并检查已声明的另一种子在轴上的声明 通过与任何其他人相同的聚变规则—— Type=Selected 外加一个声明 Error unselected 宁可默默地抛弃第一个 种子 .

任意一个字段都可以单独给出:只有 名称 不同,一个 单值,只有拼写才有.

一种情况是,一项声明蓄意无法达到: 两个种子相接一个 写入空格的脚本中的值。核聚变规则问: 公布的数值 完全说两个种子 在一起说,它答案 比较词组——和 エラー選択済み 是一个单一的征兆 不管字有多多 一个读者看到它。 封闭是明显的替代物,不安全: 選択 (所选)是 未選択 (未选中),所以一个支票 建在它上 接受绘制相反状态的节点。 将语言约束从 语义核聚变需要一个分解器 这个包没有业务携带,所以 a 矢量未解决,报为未解决。 空格分隔脚本 保险丝一般,不管字母.

这个规则就是为什么 匹配比最初看起来要大惊小怪的原因 布尔轴 接受 True 从 任意 把手,一个天真的配对者 footer=true 解决 改为 Show back=True 财务报告和审定财务报表 supporting=on 决心 Leading icon=True 两者 真实的节点, 两者都是错误的 。 因此,候选人轴必须共享a 整体 单词 与取号或取值相匹配的单词而不是 子字符串( e)Leading icon 包含 on) (中文(简体) ).

使用量

import { KitIndexResolver, loadKitIndex } from "@design-parity/kit-index";

const resolver = new KitIndexResolver(await loadKitIndex("figma-kit-index.json"));

// A rendered cross-product cell — every seed must map to a distinct axis, and
// the exact resulting vector must name a real sibling.
resolver.resolveVariant("figma:AbCdEf/57994:2324", [
  { key: "size", raw: "l" },
  { key: "shape", raw: "square" },
]);
// → { nodeId: "57994:2310", name: "Type=Square, Size=Large, State=Enabled" }

// A property-shaped variant, paired with an instance configured that way.
resolver.resolveVariant("figma:AbCdEf/57994:2324", { key: "icon", raw: "false" });
// → { nodeId: "…", name: "State=Enabled (configured instance)" }  — or undefined

// What a reference draws whether or not the code asked for it.
resolver.defaultedContent("figma:AbCdEf/57994:2324");
// → [{ name: "Show icon", setName: "Button" }]

解析器拿走索引 对象而不是一条路,它是一个坚定的文物 呼叫者已经读取了, 可能是从捆绑、缓存或测试中读取 fixture — 从工作目录读取固定文件名的解析器 在一个过程中无法使用两次,或者在没有真正工具包的情况下无法进行测试.

国 际

$ export FIGMA_TOKEN=figd_…

$ design-parity-kit-index dump  --file AbCdEf --depth 8
31 page(s) in AbCdEf
  [1/31] Buttons (11:1833): 42 component(s), 0 hidden-variant example(s), 7 configured instance(s), deepest 6
  …

$ design-parity-kit-index build --file AbCdEf
Wrote figma-kit-index.json: 55 set(s), 1284 variant(s), 6 hidden variant render
alias(es), 43 standalone component(s), 3 specimen node(s), 38 set(s) carrying
component properties, 61 configured instance render handle(s).

$ design-parity-kit-index validate
figma-kit-index.json is a valid kit index.

$ design-parity-kit-index resolve --check   # CI: fail if the committed map drifted
design-map.json is up to date.

两步而不是一步,因为它们失败不同: dump 是昂贵的 整个文件的行走,其输出是可支配的; build 这是便宜的 当设计图仍在变化时, 投影值值会重新运行 . build 无符号的降解——写一个没有属性词汇的索引,以及 这么说.. validate 永远不要接触网络.

词汇

Knob 轴和值 spelling 表格是数据,而不是逻辑,默认 与3型材料包相接。 装入变体的套件 不同的供给覆盖, 每个密钥合并, 因此重命名一个轴 但不表示重复其他30个:

new KitIndexResolver(index, {
  vocabulary: { axes: { density: ["Density", "Compactness"] } },
});

resolve 读取相同的形状从一个 kit-vocabulary.json 索引旁边 ——在出现时自动取出,或以下列方式命名: --vocabulary数字 :

{
  "axes":   { "density": ["Density", "Compactness"] },
  "values": { "cosy": ["Comfortable"] }
}

这个文件是存在的,所以一个目录可以学习一个工具箱的拼写,而不使用 等待这个软件包的发布. 只有 图表 生活在那里——一个规则 关于数值的匹配方式(多字相配、引信轴) 搜索)是逻辑,属于这里可以测试的地方.

文件

figma-kit-index.json 实值 生成 ——再生出它,从不手剪. 这个 对照 schema/kit-index.schema.json 满载, 对于生成的文件来说,它比手写文件更重要:无人 校对 半写索引失败 无法作为解析器 没什么.