光谱键
生成了遗留输出 .
@adobe/spectrum-tokens来源于packages/design-data并保留给现有的 npm 消费者.schemas/财务报告和审定财务报表naming-exceptions.json生成副本(来源:design-data-spec/schemas财务报告和审定财务报表design-data/naming-exceptions.json) (中文(简体) ). 不要在这个软件包上新建工具;见.ai/rules/legacy-tokens.md。 。 。 .
设计令牌主要是用于存储设计决定并被以某种方式分配的名-值对,产品可以跨设计工具和编码语言. 这些值类型被表示为数据,包括间隔,颜色,打字,对象样式,动画等. 这些可以代表由设计定义的任何东西:以颜色为RGB值,以不透明为数字,以动画易用功能为Bezier坐标. 它们被用来代替硬码值,以确保所有产品体验的灵活性和统一性.
设计符被直接整合到我们的组件库,UI工具包和Spectrum XD插件中. 它们涵盖了平台尺度,色彩主题,组件状态等各种选项. 我们还向团队提供各种标志性类型,如果他们没有使用Spectrum组件库,可以直接在产品内使用.
开始
跟着单曲 设置指南。 。 。 .
设计 数据验证
月球任务运行 Rust design-data CLI 反对 src/ 财务报告和审定财务报表 schemas/数字 :
moon run tokens:validateDesignData- JSON Schema (Layer 1) + 目录规则 (Layer 2)moon run tokens:verifyDesignDataSnapshot- 与上文相同,与snapshots/validation-snapshot.json(更新时间:design-data migrate snapshot当产出发生变化时)
从有 Rust 可用的 repo 根也可以运行 cargo run -p design-data-cli --manifest-path sdk/Cargo.toml -- validate ./packages/tokens/src --schema-path ./packages/tokens/schemas。 。 。 .
从上次发布时生成 Diff
这个 pnpm generateDiffResult 脚本将构建工程并比较 dist 目录,带有Spectrum Tokens的最后发行版本。 它将生成一个报告,其中包含添加的令牌,被删除的令牌,有值变化的令牌,以及有潜在名称变化的令牌. 脚本无法保证正确的名称更改;它比较了新的指使和被删除的指使,看是否有相同的值,很可能是指使名称更改.
版本
这个项目使用 语义版本( semver)它还利用 常规武器委员会 财务报告和审定财务报表 语义释放 使用 GitHub 动作实现发布进程的自动化.
主要、次要和补丁标准
补丁
x.x.n+1的释放用于错误修正和补丁.
- 错误修正
- 类型
- 错误
示例: 符号名称从 detail-margin-top-mulitplier 改为 detail-margin-top-multiplier 修补拼写错误.
次要
x.n+1.0 发布是用于新的符和特征.
- 添加新符号
- 故意更改一个值
- 在适用的情况下添加折旧元数据和别名的新令牌
少校
n+1.0.0 释放用于打破变化.
- 删除令牌
- 更改符号值类型( 例如, 从颜色到维度; 任何会打破预想特定数据类型的解析器)
折旧
计划更改代号
名称被更改的托肯会先被标记为被贬值,而用新名称创建出一新符;被贬值的符后会成为新符的别名. 最后,被贬损的道具最终会被取出,如果有足够的时间通知各小组,很可能在下个大发布会中被取出. 所需时间尚待确定.
用于折旧跟踪的控件属性
deprecated(boolean):将一个符号标记为已贬值deprecated_comment(字符串):提供上下文说明为何该符被贬值和移徙指导renamed(字符串):对于 1:1 个符号替换,指定应该使用的新符号名称
当一个符号重新命名时 :
- 设定
deprecated: true在旧的标志上 - 添加
renamed: "new-token-name"指定替换 - 更新
deprecated_comment必要时提供额外背景 - 旧的代号
value通常应为新符号的别名
释放
所有承诺合并或推向 main 分支将作为稳定版本与 latest 标签在 国家预防机制所有承诺合并或推进 next,或 next-major 将按分支中的承诺类型(突破性更改、特性、错误修复)更新版本编号,并将其与 next 标签.
详情可参见此 示例工作流程。 。 。 .
Spectrum Tokens 11.x.x和 12.x.x.x
从开始 @adobe/spectrum-tokens v12.0.0,本项目使用更高效的代币列表. 此前在v11.x.x中,每个可能的组合组件选项都被用来定义符号,导致一个不必要的大量符号列表. 然而,在从旧系统向较新的系统迁移组件的工作正在进行中,v12.0.0和今后的版本将在 latest 标签。 要安装,请使用脚本 :
pnpm add @adobe/spectrum-tokens
或者说
npm install --save @adobe/spectrum-tokens
如果您需要使用更古老、更完整的成套代币, 并同时发布 v12.x.x , 而此迁移正在开发中, 您可以使用 @adobe/spectrum-tokens-depreacated 软件包,这是存档的 @adobe/[email protected]。 。 。 .
脚本类型和 $schema
托肯斯现在有了 $schema 与定义类型有关的属性 schemas/token-types/ 目录。 即使是这些被作为正常发行的一部分而发行的,也不应该被认为是正式的API. 计划进行调整,在设计工具和工作流程中进一步整合数据。 理想的情况是,设计者能够编写出新的信使和管理所有数据的种类.