@stripe/formspec-cli
v0.1.0-alpha.72
Published
CLI tool for generating JSON Schema and FormSpec from TypeScript classes
Maintainers
Readme
@stripe/formspec-cli
CLI for generating schemas and canonical IR from TypeScript source files.
Install
pnpm add -D @stripe/formspec-cliThe package installs a formspec binary.
Commands
Generate schemas
formspec generate ./src/forms.ts UserForm -o ./generatedgenerate also accepts the legacy analyze alias for backwards compatibility.
Generate from Chain DSL exports
formspec generate ./src/forms.ts -o ./generatedEmit canonical IR
formspec generate ./src/forms.ts UserForm --emit-ir -o ./generatedValidate only
formspec generate ./src/forms.ts UserForm --validate-onlyDry run
formspec generate ./src/forms.ts UserForm --dry-run -o ./generatedUse an explicit compiled JS entry
formspec generate ./src/forms.ts --compiled ./dist/forms.js -o ./generatedNotes
- 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/-coverrides the auto-detected compiled JavaScript path for chain DSL loading.--validate-onlyexercises the same validation path used by schema generation.--emit-irwrites canonical IR as<name>.ir.jsonalongside generated schema files.
License
This package is part of the FormSpec monorepo and is released under the MIT License. See LICENSE for details.
