JSPM

  • Created
  • Published
  • Downloads 82
  • Score
    100M100P100Q101070F
  • License MIT

CLI tool for generating JSON Schema and FormSpec from TypeScript classes

Package Exports

  • @formspec/cli

Readme

@formspec/cli

CLI for generating schemas and canonical IR from TypeScript source files.

Install

pnpm add -D @formspec/cli

The package installs a formspec binary.

Commands

Generate Schemas

formspec generate ./src/forms.ts UserForm -o ./generated

generate also accepts the legacy analyze alias for backwards compatibility.

Generate From Chain DSL Exports

formspec generate ./src/forms.ts -o ./generated

Emit Canonical IR

formspec generate ./src/forms.ts UserForm --emit-ir -o ./generated

Validate Only

formspec generate ./src/forms.ts UserForm --validate-only

Dry Run

formspec generate ./src/forms.ts UserForm --dry-run -o ./generated

Use An Explicit Compiled JS Entry

formspec generate ./src/forms.ts --compiled ./dist/forms.js -o ./generated

Notes

  • Static analysis covers classes, interfaces, and type aliases using the TypeScript compiler directly.
  • Chain DSL export generation requires compiled JavaScript that the CLI can load.
  • --compiled / -c overrides the auto-detected compiled JavaScript path for chain DSL loading.
  • --validate-only exercises the same validation path used by schema generation.
  • --emit-ir writes canonical IR as <name>.ir.json alongside generated schema files.

License

This package is part of the FormSpec monorepo and is released under the MIT License. See LICENSE for details.