iter: d15 CLI 包补清单 + 文档组件数纠正

This commit is contained in:
ui-arch-bot
2026-10-23 16:57:22 +08:00
parent d3fc754b33
commit 1c03c8113a
8 changed files with 149 additions and 4 deletions
+37 -1
View File
@@ -1,6 +1,6 @@
# @ui-arch 组件库 Agent 文档(无图形版)
> 自动生成于 2026-10-23T08:56:29.143Z,数据源:各包 ua.manifest.json,勿手改。人类版文档站:apps/docs/index.html。
> 自动生成于 2026-10-23T08:57:12.133Z,数据源:各包 ua.manifest.json,勿手改。人类版文档站:apps/docs/index.html。
> 组件 = 普通函数,传 props 返回 DOM;状态用 signal 双向绑定:读 signal() 写 signal(v)。
## 快速上手
@@ -38,6 +38,14 @@
4. 调用组件:const el = textField({ value: name }),把 el 挂到你的容器或配合 h() 组合
5. 读写状态:name() 读、name('张三') 写,界面自动同步,无需手动操作 DOM
### @ui-arch/cli
1. 装好依赖后先跑 npm run check 确认基线全绿(build → style → typecheck → smoke → index → verify)
2. 查组件:ua list 看全量,ua info <包名> 看单包 api 与约定
3. 改完清单跑 npm run docs:同时刷新人类文档站与 llms-full.txt(Agent 首选喂料)
4. 提交前 npm run check:style 查注释规范,verify 查清单 ↔ 文档 ↔ 演示锚点是否一致
5. 在 ~/.workbuddy/mcp.json 注册 ua mcp 后,Agent 可直接调 list_components / get_component / search_components
## @ui-arch/ui(skin-dom)v0.1.0
27 个 DOM 组件,统一用法:组件是普通函数,传入 props 返回 DOM 节点;需要状态时先创建 signal 再双向绑定。引入 CSS:import '@ui-arch/ui/ui.css'(内部已消费 tokens)。
@@ -820,6 +828,34 @@ import '@ui-arch/tokens/tokens.css'; then use var(--ua-color-accent) etc. in any
---
## @ui-arch/cli(tooling)v0.1.0
工程层工具包(private,不发布)。所有 Agent 与人都通过它读取组件库:清单驱动索引、文档、MCP 三件套,外加 style / verify 两道门禁。
API 速览:
- ua index:扫描 packages/ 两层目录的 ua.manifest.json,生成 .ua/index.json 与 llms.txt
- ua list:列出注册表内所有包与组件数
- ua info <name>:查看单个包的清单详情(api / 约定 / 文档步骤)
- ua docs:生成人类文档站 apps/docs/index.html + demo.html 与 Agent 全量文档 llms-full.txt
- ua style:注释规范门禁(导出必须 /*** ***/、接口字段行尾注释、行注释中文),违规退出码 1
- ua verify:清单一致性门禁(id 唯一 / exports 对应 / props 必带 n t d / steps≥3 / demo 锚点存在)
- ua mcp:零依赖 stdio MCP server,暴露 list_components / get_component / search_components
一行用法:
```
node packages/tools/cli/bin/ua.js <index|list|info <name>|docs|style|verify|mcp>;仓库内等价于 npm run index / docs / style / verify
```
约定:
- 零依赖:只用 node 标准库,Node >= 18
- 清单是单一来源:代码注释、文档站、llms-full.txt、MCP 全部从 ua.manifest.json 派生
- 门禁只增不改:新增校验必须能被人手复现,报错要指出文件与字段
---
## 设计令牌(--ua-*)
- --ua-color-bg: #ffffff(暗色 #101216)