奥罗CLI

奥罗设计系统的CLI工具. 它运行本地的dev服务器,同步repo配置,构建组件和docs,并驱动部分放出管道.

发表于 @aurodesignsystem/auro-cli。 。 。 .

安装

npm install @aurodesignsystem/auro-cli

或运行单项命令而不安装:

npx --package=@aurodesignsystem/auro-cli auro <command>

图标

运行 auro <command> --help 用于任何命令上的选项。 默认在存在的地方显示 .

看着

发展

Repo 维护

释放管道 (CI运行这些)

全文参考

发展

auro dev

为组件运行 Dev 服务器。 先建后服务.

• -s, --serve: 启动服务器.
• -p, --port <number>: 服务器端口.
• -o, --open: 服务器打开后打开浏览器.
• -w, --watch:在变化中重建.
• -m, --module-paths [paths...]: 到节点模块文件夹的路径.
• --skip-docs: 跳过 doc 生成( 默认: 关闭) .
• -r, --readme-template <url>: README 模板的 URL.
• --wca-input [files...]: 用于分析 API 文件的源文件.
• --wca-output [files...]: API 文件的输出文件.

auro build

构建一个组件.

• -m, --module-paths [paths...]: 到节点模块文件夹的路径.
• -w, --watch:在变化中重建.
• --skip-docs: 跳过 doc 生成( 默认: 关闭) .
• -r, --readme-template <url>: README 模板的 URL.
• --wca-input [files...]: 用于分析 API 文件的源文件.
• --wca-output [files...]: API 文件的输出文件.

auro docs

从自定义元素表单生成 API 文档 .

• -c, --cem: 生成自定义元素表单( 默认: 关闭) .
• -a, --api: 创建 api.md 从 CEM( 默认: 关闭) .
• -w, --watch: 更改时重建文件( 默认: 关闭) .
• -r, --readme-template <url>: README 模板的 URL.
• --skip-readme:跳过 README.md 处理(默认:关闭).
• -s, --serve: 启动服务器.
• -p, --port <number>: 服务器端口.
• -o, --open: 服务器打开后打开浏览器.

文档生成

auro build 财务报告和审定财务报表 auro docs 生成 README.md 编辑 demo/*.md 页面来源 docs/partials/ 财务报告和审定财务报表 docs/pages/。如果任何文件文件失败,则其余文件仍然生成。 然后命令退出非零并列出每个失败的文件. Docs 文件失败时 :

• 包含的文件 FILE 或者说 CODE 缺少,包括嵌入;
• (单位:千美元) {{ … }} 占位符留在它的正文中(代码被忽略)。 这包括一个拼错的模板变量,例如 {{ nmae }}。 。 。 .

代码片断(栅栏块, <pre> 财务报告和审定财务报表 <code> 元素、内置代码和 CODE 包括) 保留 {{ … }} 表达式,除了模板变量和帮助器,所以Vue、Angular 和 Handlebars 示例不会通过任何修改,包括 Handlebars 块、注释、部分和 三重结构({{#each}}, (中文(简体) ), {{!-- --}}, (中文(简体) ), {{> header}}, (中文(简体) ), {{{ raw }}}) (中文(简体) ). 两种片段表达法仍然被填入:

• 自行创建模板变量: {{ name }}, (中文(简体) ), {{ Name }}, (中文(简体) ), {{ namespace }}, (中文(简体) ), {{ Namespace }}, (中文(简体) ), {{ Version }}, (中文(简体) ), {{ dtVersion }}, (中文(简体) ), {{ wcssVersion }}, (中文(简体) ), {{ monorepoName }}· ;
• 模板助手,其参数为模板变量或引用字符串: {{ capitalize name }}, (中文(简体) ), {{ withAuroNamespace "button" }}, (中文(简体) ), {{ packageName }}。 。 。 .

其他的,比如说 {{ name.length }} 或者说 {{ name | uppercase }},保留为正文。 要保留模板可变文字,请将其写入 \{{ name }}。 。 。 .

在监视模式下,报告docs失败,但不会阻止监视器或dev服务器. auro docs --watch 修复文件时重建. auro dev 财务报告和审定财务报表 auro build --watch 在下一个源变化上重新生成文件.

升级在 auro- cli v4 之前创建的组件: v4 README 模板包含这些文件, 因此创建它们, 甚至为空, 或者构建失败 :

• docs/partials/customRegistration.md
• apiExamples/custom.html

auro test

在组件库中运行 Web 测试运行程序.

• -w, --watch: 监视模式.
• -c, --coverage-report:生成覆盖报告.
• -o, --open:在浏览器中打开覆盖报告.
• -f, --files <glob>: 测试文件 glob 模式.

auro test --coverage-report --open

Repo 维护

auro sync

拉动 .github/ 从auro-templates来配置,并重写这个repo的复制.

• -r, --ref <branch/tag/commit>: git ref 从( 默认 : main) (中文(简体) ).
• -t, --template <name>: 要使用的模板( 默认 ): default) (中文(简体) ).

抬头: 验证模板后, 全部删除 .github/ 文件夹并重建它。 任何当地 .github/ 不在模板中的文件已丢失。 它不会做分枝,所以改变你现在的分枝上的土地。 在你愿意改变的分行上运行.

auro migrate

由 id 运行一个代码风格的迁移脚本.

• -i, --id <string> (需要):迁移去跑.
• -m, --multi-gitter:运行在多吉特配置中的每一回波.

auro agent

互动. 以依赖顺序在 Auro 组件之间运行迁移 。 它促使迁移身份和从哪部分开始。 需要安装多吉特 。 (工作正在进行)

auro ado

从 GitHub 上创建 Azure DevOps 工作项目 .

• -g, --gh-issue <issue>: GitHub 问题要使用.

释放管道

中情局负责这些 你通常不会用手操作它们。 气动中的工作流程都叫它们.

auro rc-workflow

剪切发布-扫描分支并打开RC拉取请求. 奔跑的推向德夫。 没有选择.

见 奥罗团队 GitFlow 关于小组如何规划和跟踪ADO的发布,以及 人工发布候选人程序 用于手动运行RC步骤.

auro pr-release

设置 PR 预览版本 package.json,从 npm 登记册中计算。 不发表.

• -n, --namespace <namespace>: 包名空间( 默认 ): @aurodesignsystem-dev) (中文(简体) ).
• -p, --pr-number <number>: PR 编号( 默认 : 0) (中文(简体) ).

这个版本是 0.0.0-pr<PR#>.<n>时 <n> 是 npm 上的下个自由递增.

auro check-commits (别名) auro cc(中文(简体) )

读取repo承诺,按常规承诺类型对每个承诺进行分类,并报告结果.

• -l, --set-label: 以最高优先级的承诺类型标记PR.
• -d, --debug: 打印详细承诺信息.
• -r, --release-notes:从承诺中生成释放注释.

auro api-diff <baseRef> [headRef]

操作最小的版本将代码从 baseRef 改为 headRef (默认) HEAD(a) 要求和检查承诺至少应如此。 一个版本的号码是对消费者的承诺,所以 fix: 承诺删除公共属性 不应该作为补丁载运.

• --json把结果写成JSON.
• --enforce: 当承诺声明一个比代码要求的更小的突起( 默认: 关闭, 所以检查可以只运行报告) 时, 退出 1 .
• --no-rebuild: 比较承诺 custom-elements.json 文档而不是重建它们。 更快,但只有 与承诺文件一样好, 和许多重置者 不执行清单.
• --manifest <path>: 从 repo 根显示路径( 默认 ): customElements 内 package.json,则 custom-elements.json) (中文(简体) ).
• --install-command <cmd>: 在每个重建的检出中安装依赖性( 默认 ): npm ci --no-audit --no-fund) (中文(简体) ).
• --build-command <cmd>: 在每次重建的检出中写出清单( 默认 ): npm run build) (中文(简体) ).

auro api-diff origin/dev

所有东西都从两位裁判的合并基数中进行比较,所以只有公关自己的变化和承诺数.

需要的凸起. Auro 发布版本规则 列出每个规则,并举出例子。 简言之,"通货单"是合同:AI工具和其他自动化构建页面来自它,所出版的TypeScript类型出自同名JSDoc. 所以任何改变都算数 无论运行时的行为是否改变 测试是之前有效的标记是否仍然有效。 要求的起落是这些变化中最高的:

只有公共API数。 成员在名单上被过滤 privacy 字段,而不是名称前缀。 由私人或 @internal 财产不算 格式差异不计数:引文样式, 'a', 'b' 对 'a' | 'b', 类似 {'md'},并且属性名称大小写(HTML属性名称是大小写不敏感).

该清单在临时工作树上重建,默认为 npm ci 财务报告和审定财务报表 npm run build,每个都有自己的依附关系,所以比较的是实际出船的舱单. 当PR升级为auro-cli或CEM分析器时,较新的版本可以以不同方式来写出表单,尽管组件的代码没有改变合同. 这些变化计数,但基数也是用头部的版本来构建的,所以每个变化都被标记为来自代码或从升级中来(cause 在JSON, 和摘要的说明。 重建仅当 test/, (中文(简体) ), .github/ 或者说 docs/ 换了 如果头部不建立,则检查出错(故障关闭). 如果基地不建设,则检查使用基地承诺的明细表,或者跳过API比较,然后在 warnings (失败打开):公关不应该被它没有被打破的基地所封锁.

被揭发了. 在未发生的承诺中,最高的冲击是: @semantic-release/commit-analyzer 与 repo 的自发布配置( 通常是) @aurodesignsystem/auro-config/releaserc,包括其习惯规则: refactor, (中文(简体) ), style 财务报告和审定财务报表 docs(README) 释放补丁). 分析器是从雷波自己装的 node_modules,因此,检查读取 完全按照释放意愿。 运行 npm ci 在 repo 中第一个: 分析器未安装时的检查出错。 如果repo的释放配置无法解决,则使用共享规则并 warnings 这么说的 PR标题从不计数,因为合并承诺不影响版本.

成果.

• fail:承诺声明少于代码要求. 重写承诺fix: → feat:,或添加 ! (单位:千美元) BREAKING CHANGE: 页脚.
• warn:不要求释放,但承诺宣布释放(例如a) fix: 只接触测试.
• pass: 否则。 允许声明超过要求,因为行为可以打破而不改变API.

JSON开始 required 财务报告和审定财务报表 reasons,然后是 declared, (中文(简体) ), outcome,单行 summary 对于 PR 注释,参考文献,每次更改并用其凸起来承诺,所使用的释放配置,以及任何 warnings数字 :

{
  "required": "major",
  "reasons": ["Removed attribute `ondark` from `<auro-button>`"],
  "declared": "patch",
  "outcome": "fail",
  "summary": "Commits declare `fix` (patch). Code requires major: removed attribute `ondark` from `<auro-button>`."
}

退出代码 : 0 当分析时, 1 与 --enforce 当结果是 fail, (中文(简体) ), 2 当分析无法进行时(一个未知的参考文献,一个不会建造的头,或者没有安装在回波中的承诺分析器).

AI 助理语境

auro context

打印一个AI已准备好的上下文文档,描述Auro设计系统,其组件,以及使用模式. 被设计为被管道接入或粘入AI编码助理(Claude,Cursor,Copilot等)以在Auro上为它们提供素材.

构成部分参考表从每个构成部分的《自定义要点说明》得到丰富,因此说明保持不变。 将当前项目安装的组件改为: node_modules (匹配您已安装的版本); 其他的都是取自 unpkg 。 被整理的内置列表是任何无法解决的组件的倒置. 生成文档后,任何未被安装在最新发布的版本上的组件都会被报告为stderr(因此它从未污染文档本身).

• -o, --output <file>:将上下文文档写入文件而不是 stdout(例如). AURO_CONTEXT.md) (中文(简体) ).
• --offline:跳过网络取来——只从本地安装的出货单上丰富,倒回内置的表格(也跳过过时的放出检查).

打印上下文到终端 :

auro context

为您的 AI 工具将上下文写入文件 :

auro context --output AURO_CONTEXT.md

auro cem

汇总自定义元素表单( E)custom-elements.json),每个被公布的Auro组件组成一个文件. 每个组件的出品单都取自最新发布的unpkg版本;尚未发布出品单的组件被跳出. 用于向IDEs,Docs工具,以及AI助手提供完整,机器可读组件API索引.

选项

• -o, --output <file> 写入汇总运算表的路径( 默认 : custom-elements.aggregate.json) (中文(简体) ).

实例

生成汇总列表 :

auro cem

写到特定的路径 :

auro cem --output dist/custom-elements.aggregate.json

auro component <name>

从Auro组件的 API ——属性,属性/方法,插槽,事件,和 CSS 部件中查找一个单独的 Auro 组件的 API —— 属性,属性/方法,插槽,事件,和 CSS 部件—— 从它的 Custom Eument Manification 中查找. 对在工具使用回路中呼叫CLI的人类和AI编码助理有用来避免猜测API.

如果组件安装于当前项目的 node_modules,它的列表是局部读取的,所以API与你实际拥有的版本相匹配——成功行显示 (local vX.Y.Z)。否则它会从 unpkg (shown as (unpkg)) (中文(简体) ). 通过一个明确的 --tag/ 版本总是从 unpkg 获取该版本.

选项

• -t, --tag <version> npm dist-tag 或查看版本( 默认值 : latest;强制取出 unpkg .
• --json 输出原始的列表声明为 JSON 而不是格式化文本 .

实例

查找一个组件( 名称已规范化, 因此所有这些工作 ) :

auro component button
auro component auro-button
auro component @aurodesignsystem/auro-button

查看一个特定的版本或正格 :

auro component auro-button --tag beta
auro component auro-button --tag 11.0.0

获得机器可读输出 :

auro component auro-button --json