uip vss génération

Syntaxe et options pour `uip vss generated`, qui produit un fichier TypeScript à partir d'un schéma Data Fabric à utiliser dans le code de solution verticale.

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.

Synthèse

uip vss generate [options]

Options

Drapeau	Description
-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.

Exemples

# 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

Format des données (--sortie json)

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

Associé

• entités dfuip : créez et inspectez le schéma utilisé par generate .
• uip vss init — produce the vss.json that generate can read as a schema source.

Voir également

• Présentation de l’outil de solutions verticales
• Options globales
• Codes de sortie