Skip to main content

TypeScript to Schema CLI Usage

Use this CLI to turn TypeScript model definitions into JSON Schema files for validation and publishing.

Running​

To install and run the CLI locally use the following commands:

npm install @twin.org/ts-to-schema -g
ts-to-schema

or run directly using NPX:

npx "@twin.org/ts-to-schema"

Help​

⚙️  TWIN TypeScript To Schema v0.0.3-next.15

Usage: ts-to-schema

Arguments:
  config         Path to the JSON configuration file.
  output-folder  The folder to write the schema files.

Options:
  -V, --version  output the version number
  --lang <lang>  The language to display the output in. (default: "en")
  -h, --help     display help for command

Example Config​

{
  "baseUrl": "https://schema.twindev.org/my-namespace/",
  "sourceFiles": ["./dist/types/*.d.ts"],
  "types": ["MyType1", "MyType2"],
  "suppressPackageWarnings": ["jose"]
}