SuperAPI AI 工具集

metadata-schema-generator

数据与分析

查看项目

更新于 10-16 01:31

技能介绍

用途:为设计系统组件生成机器可读的 JSON 元数据模式。人类文档服务人,元数据服务机器——TypeScript 接口只说明组件接受哪些 props,无法说明何时使用、哪些组合被禁止、可放置在何处、须遵守何种无障碍契约,本技能填补这一层知识。

主要能力:从源码提取 props 层(名称、类型、required、默认值、描述、枚举值与逐值语义);添加语义层,包括行为规则(状态、过渡、约束)、组合规则(合法父/子、禁止嵌套、slot 契约、常见组合)与无障碍契约(role、条件 aria、键盘、焦点、读屏播报);可选业务上下文层(默认关闭);以及禁止的 prop 组合,附原因与严重级别(error/warning/info)。每个行为、组合、无障碍块及禁止组合均带 provenance:source、docs 或 proposed,不得把 proposed 当作系统实际策略。

使用方式:配置读取 .ds-ops-config.yml 的 system.framework、system.component_paths、integrations.*、metadata.schema_version、metadata.output_directory、metadata.include_business_context。可自动拉取 Figma MCP、Storybook;React+TypeScript 用 react-docgen-typescript,Vue 用 vue-component-meta,Web Components 用 Custom Elements Manifest(npx custom-elements-manifest analyze),其他情况手工读取。输出到 .ai/metadata/,含 schema.json、各组件 .metadata.json 与 manifest.json。

限制:使用前须确认 frontmatter 引用的路径存在,缺失通常因安装器扁平化丢失 knowledge-notes/,需按 1-INSTALL.md 重装并运行 verify-install.sh。无组件源码时无法从描述提取,须先运行 codebase-index;若无消费者(AGENTS.md、MCP 服务器、lint 集成),建议先做 agent-instructions。业务上下文仅在用户或团队文档提供数据时加入,不得从名称推断业务功能、指标或流量。详细行为规则、约束与禁止组合须来自团队文档或用户,否则标为 proposed。