uip vss 生成

"uip vss generate" 的语法和选项，可根据 Data Fabric 架构生成 TypeScript 文件，以便在垂直解决方案代码中使用。

uip vss generate produces a TypeScript vss.gen.ts file from a Data Fabric schema (data_fabric_schema.json) or a vss.json config. It resolves choice sets into TypeScript unions and emits entity types the solution code can import. Run it after editing the entity schema or pulling a new schema export from uip df.

大纲

uip vss generate [options]

选项

标记	描述
-s, --schema <path>	Path to a schema file — either data_fabric_schema.json or vss.json. The source is inferred from the filename. When omitted, resolution falls back to the order below.
-t, --target-path <targetPath>	Directory to resolve the default schema path from, and to write vss.gen.ts into. Defaults to the current directory.

When --schema is omitted, resolution checks, in order: <target-path>/data_fabric_schema.json, then <target-path>/vss.json, then <target-path>/client/data_fabric_schema.json, then <target-path>/client/vss.json (the client/ subdirectory is where a scaffolded app's schema typically lives). If none of the four exist, the command fails and lists all four checked paths.

示例

# Generate using the schema at <target>/data_fabric_schema.json
uip vss generate

# Custom schema path and target directory
uip vss generate \
    --schema ./schemas/data_fabric_schema.json \
    --target-path ./src/generated

数据形状（--输出 json）

{
  "Code": "TypesGenerated",
  "Data": {
    "Path": "/Users/alice/my-app/vss.gen.ts"
  }
}

相关内容

• uip df实体— 创作和检查generate使用的架构。
• uip vss init — produce the vss.json that generate can read as a schema source.

另请参阅

• 垂直解决方案工具概述
• 全局选项
• 退出代码