vega/ts-json-schema-generator
Ts Json Schema Generator
Ts-json-schema-generator is a command-line tool and Node.js library that automatically generates standard JSON validation schemas directly from TypeScript source files and type definitions. Operating as a static code analyzer and schema compilation engine, it inspects type definitions and interfaces to understand structural data shapes without requiring runtime execution. It uses static program analysis by initializing a virtual compiler instance to resolve complex generic types, imports, and type relationships across source files.
The project translates extracted types into standard validation specifications through an AST-based type inspection and transformation pipeline. It provides extensibility through a formatter plugin system that intercepts the serialization of specific structural types, alongside custom syntax parser extensions that enable the interpretation of non-standard code constructs by plugging custom parsing rules directly into the early code analysis phase.
Users can operate the software via a declarative command-line interface using path glob patterns and configuration flags, or embed the generation routines programmatically within custom scripts and server programs. Additional configuration options allow direct control over compiler settings, custom parsing rules, and specialized schema output formatting.
Features
- Schema Generators from Types - Extracts data structures directly from source code and compiles them into standard validation specifications.
- Schema Compilers - Translates application type definitions into standardized validation documents as a schema compilation engine.
- Schema Transformation Pipelines - Translates internal AST representations into standard validation documents through a modular transformation pipeline.
- Library Wrappers - Runs schema generation routines programmatically inside custom Node.js scripts without relying on command-line wrappers.
- Code Generators - Executes schema generation routines programmatically within custom Node.js scripts and server programs.
- TypeScript Type-to-JSON Schema Generators - Builds standard JSON schema documents automatically from source files and type definitions without manual maintenance.
- Tree Type Inspection - Inspects source code structures directly into semantic tree types without requiring runtime execution.
- Static Type Resolvers - Analyzes type relationships across source files by initializing a virtual compiler instance to resolve complex generic types.
- TypeScript Static Analysis - Performs static analysis on TypeScript type definitions and interfaces to inspect structural data shapes without runtime execution.
- Custom Data Type Providers - Extends the transformation pipeline by registering custom formatters and parsers for specialized data structures.
- Syntax Parser Interceptions - Interprets non-standard code constructs by plugging custom parsing rules directly into the early analysis phase.
- Schema-to-Code CLI Generators - Executes build routines directly from the command line using path glob patterns and configuration flags.
- Custom Parsing Rules - Interprets non-standard code constructs into recognizable types by adding custom parser rules during analysis.
- Custom Type Schema Mappings - Defines custom schema output rules for specific data structures by registering supplementary formatters into the pipeline.
- Plugin System Extensions - Intercepts the serialization of specific structural types through a customizable plugin formatting architecture.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
