From-scratch rewrite of the JSON Schema-based TypeScript Code Generation code originally implemented for Docs.json.ts
I felt I could do better.
- type discovery, data generation, and import/export management were spread over separate areas of the codebase in the original Docs.json.ts implementation (as a consequence of it being developed iteratively as needed).
- candidate classes now manage both type conversion and data conversion.
- import/export management is now largely driven by the
$reftype support.- Yes,
$reftechnically lies about it's internals, but attempting to retain the overall interface of the candidate classes while having$refbe fully honest about it's internals gave me a headache.
- Yes,
Taking a JSON Schema with corresponding JSON & generating TypeScript bindings for said data.
Docs.json.ts is intended to work with JSON files that contain data that wasn't serialised with JSON.
Templated Strings in TypeScript also allow one to be less verbose in how one represents known values, e.g. typing something as that passes the regex ^foo.*(?:bar|baz)$ as more specific than just string but less verbose (i.e. foo${string}${'bar'|'baz'}) than 10s/100s/1000s of exact values.
npm install --save-dev @signpostmarv/json-schema-typescript-codegen
- Node >= 24, for
RegExp.escape()- this allows the pattern support in the rewrite to be considerably more flexible than the original pattern support in Docs.json.ts.
- Node >= 23, for running TS files without needing to run a compile step.
- Currently distributed as a pure typescript package
- Inherently tied to Ajv due to the requirement for their custom keywords implementation.
- Does not currently have a complete implementation of standard JSON keywords
