Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
243 lines
11 KiB
Plaintext
243 lines
11 KiB
Plaintext
# json-schema-to-typescript [![Build Status][build]](https://github.com/bcherny/json-schema-to-typescript/actions?query=branch%3Amaster+workflow%3ACI) [![npm]](https://www.npmjs.com/package/json-schema-to-typescript) [![mit]](https://opensource.org/licenses/MIT) ![node]
|
|
|
|
[build]: https://img.shields.io/github/actions/workflow/status/bcherny/json-schema-to-typescript/ci.yml?style=flat-square
|
|
[npm]: https://img.shields.io/npm/v/json-schema-to-typescript.svg?style=flat-square
|
|
[mit]: https://img.shields.io/npm/l/json-schema-to-typescript.svg?style=flat-square
|
|
[node]: https://img.shields.io/badge/Node.js-16+-417e37?style=flat-square
|
|
|
|
> Compile JSON Schema to TypeScript typings.
|
|
|
|
## Example
|
|
|
|
Check out the [live demo](https://borischerny.com/json-schema-to-typescript-browser/).
|
|
|
|
Input:
|
|
|
|
```json
|
|
{
|
|
"title": "Example Schema",
|
|
"type": "object",
|
|
"properties": {
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"age": {
|
|
"description": "Age in years",
|
|
"type": "integer",
|
|
"minimum": 0
|
|
},
|
|
"hairColor": {
|
|
"enum": ["black", "brown", "blue"],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": ["firstName", "lastName"]
|
|
}
|
|
```
|
|
|
|
Output:
|
|
|
|
```ts
|
|
export interface ExampleSchema {
|
|
firstName: string;
|
|
lastName: string;
|
|
/**
|
|
* Age in years
|
|
*/
|
|
age?: number;
|
|
hairColor?: "black" | "brown" | "blue";
|
|
}
|
|
```
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
npm install json-schema-to-typescript
|
|
```
|
|
|
|
## Usage
|
|
|
|
json-schema-to-typescript is easy to use via the CLI, or programmatically.
|
|
|
|
### CLI
|
|
|
|
First make the CLI available using one of the following options:
|
|
|
|
```sh
|
|
# install locally, then use `npx json2ts`
|
|
npm install json-schema-to-typescript
|
|
|
|
# or install globally, then use `json2ts`
|
|
npm install json-schema-to-typescript --global
|
|
|
|
# or install to npm cache, then use `npx --package=json-schema-to-typescript json2ts`
|
|
# (you don't need to run an install command first)
|
|
```
|
|
|
|
Then, use the CLI to convert JSON files to TypeScript typings:
|
|
|
|
```sh
|
|
cat foo.json | json2ts > foo.d.ts
|
|
# or
|
|
json2ts foo.json > foo.d.ts
|
|
# or
|
|
json2ts foo.yaml foo.d.ts
|
|
# or
|
|
json2ts --input foo.json --output foo.d.ts
|
|
# or
|
|
json2ts -i foo.json -o foo.d.ts
|
|
# or (quote globs so that your shell doesn't expand them)
|
|
json2ts -i 'schemas/**/*.json'
|
|
# or
|
|
json2ts -i schemas/ -o types/
|
|
```
|
|
|
|
You can pass any of the options described below (including style options) as CLI flags. Boolean values can be set to false using the `no-` prefix.
|
|
|
|
```sh
|
|
# generate code for definitions that aren't referenced
|
|
json2ts -i foo.json -o foo.d.ts --unreachableDefinitions
|
|
# use single quotes and disable trailing semicolons
|
|
json2ts -i foo.json -o foo.d.ts --style.singleQuote --no-style.semi
|
|
```
|
|
|
|
### API
|
|
|
|
To invoke json-schema-to-typescript from your TypeScript or JavaScript program, import it and call `compile` or `compileFromFile`.
|
|
|
|
```js
|
|
import { compile, compileFromFile } from 'json-schema-to-typescript'
|
|
|
|
// compile from file
|
|
compileFromFile('foo.json')
|
|
.then(ts => fs.writeFileSync('foo.d.ts', ts))
|
|
|
|
// or, compile a JS object
|
|
let mySchema = {
|
|
properties: [...]
|
|
}
|
|
compile(mySchema, 'MySchema')
|
|
.then(ts => ...)
|
|
```
|
|
|
|
See [server demo](example) and [browser demo](https://github.com/bcherny/json-schema-to-typescript-browser) for full examples.
|
|
|
|
## Options
|
|
|
|
`compileFromFile` and `compile` accept options as their last argument (all keys are optional):
|
|
|
|
| key | type | default | description |
|
|
|-|-|-|-|
|
|
| additionalProperties | boolean | `true` | Default value for `additionalProperties`, when it is not explicitly set |
|
|
| bannerComment | string | `"/* eslint-disable */\n/**\n* This file was automatically generated by json-schema-to-typescript.\n* DO NOT MODIFY IT BY HAND. Instead, modify the source JSON Schema file,\n* and run json-schema-to-typescript to regenerate this file.\n*/"` | Disclaimer comment prepended to the top of each generated file |
|
|
| customName | `(LinkedJSONSchema, string \| undefined) => string \| undefined` | `undefined` | Custom function to provide a type name for a given schema
|
|
| cwd | string | `process.cwd()` | Root directory for resolving [`$ref`](https://tools.ietf.org/id/draft-pbryan-zyp-json-ref-03.html)s |
|
|
| declareExternallyReferenced | boolean | `true` | Declare external schemas referenced via `$ref`? |
|
|
| enableConstEnums | boolean | `true` | Prepend enums with [`const`](https://www.typescriptlang.org/docs/handbook/enums.html#computed-and-constant-members)? |
|
|
| inferStringEnumKeysFromValues | boolean | `false` | Create enums from JSON enums with eponymous keys |
|
|
| format | boolean | `true` | Format code? Set this to `false` to improve performance. |
|
|
| ignoreMinAndMaxItems | boolean | `false` | Ignore maxItems and minItems for `array` types, preventing tuples being generated. |
|
|
| maxItems | number | `20` | Maximum number of unioned tuples to emit when representing bounded-size array types, before falling back to emitting unbounded arrays. Increase this to improve precision of emitted types, decrease it to improve performance, or set it to `-1` to ignore `maxItems`.
|
|
| strictIndexSignatures | boolean | `false` | Append all index signatures with `\| undefined` so that they are strictly typed. |
|
|
| style | object | `{ bracketSpacing: false, printWidth: 120, semi: true, singleQuote: false, tabWidth: 2, trailingComma: 'none', useTabs: false }` | A [Prettier](https://prettier.io/docs/en/options.html) configuration |
|
|
| unknownAny | boolean | `true` | Use `unknown` instead of `any` where possible |
|
|
| unreachableDefinitions | boolean | `false` | Generates code for `$defs` that aren't referenced by the schema. |
|
|
| $refOptions | object | `{}` | [$RefParser](https://github.com/APIDevTools/json-schema-ref-parser) Options, used when resolving `$ref`s |
|
|
|
|
## Tests
|
|
|
|
```sh
|
|
$ npm test
|
|
```
|
|
|
|
## Features
|
|
|
|
- [x] `title` => `interface`
|
|
- [x] Primitive types:
|
|
- [x] array
|
|
- [x] homogeneous array
|
|
- [x] boolean
|
|
- [x] integer
|
|
- [x] number
|
|
- [x] null
|
|
- [x] object
|
|
- [x] string
|
|
- [x] homogeneous enum
|
|
- [x] heterogeneous enum
|
|
- [x] Non/extensible interfaces
|
|
- [ ] Custom JSON-schema extensions
|
|
- [x] Nested properties
|
|
- [x] Schema definitions
|
|
- [x] [Schema references](http://json-schema.org/latest/json-schema-core.html#rfc.section.7.2.2)
|
|
- [x] Local (filesystem) schema references
|
|
- [x] External (network) schema references
|
|
- [x] Add support for running in browser
|
|
- [x] default interface name
|
|
- [x] infer unnamed interface name from filename
|
|
- [x] `deprecated`
|
|
- [x] `allOf` ("intersection")
|
|
- [x] `anyOf` ("union")
|
|
- [x] `oneOf` (treated like `anyOf`)
|
|
- [x] `maxItems` ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L166))
|
|
- [x] `minItems` ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L165))
|
|
- [x] `additionalProperties` of type
|
|
- [x] `patternProperties` (partial support)
|
|
- [x] [`extends`](https://github.com/json-schema/json-schema/wiki/Extends/014e3cd8692250baad70c361dd81f6119ad0f696)
|
|
- [x] `required` properties on objects ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L130))
|
|
- [ ] `validateRequired` ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L124))
|
|
- [x] literal objects in enum ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L236))
|
|
- [x] referencing schema by id ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L331))
|
|
- [x] custom typescript types via `tsType`
|
|
|
|
## Custom schema properties:
|
|
|
|
- `tsType`: Overrides the type that's generated from the schema. Useful for forcing a type to `any` or when using non-standard JSON schema extensions ([eg](https://github.com/sokra/json-schema-to-typescript/blob/f1f40307cf5efa328522bb1c9ae0b0d9e5f367aa/test/e2e/customType.ts)).
|
|
- `tsEnumNames`: Overrides the names used for the elements in an enum. Can also be used to create string enums ([eg](https://github.com/johnbillion/wp-json-schemas/blob/647440573e4a675f15880c95fcca513fdf7a2077/schemas/properties/post-status-name.json)).
|
|
|
|
## Not expressible in TypeScript:
|
|
|
|
- `dependencies` ([single](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L261), [multiple](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L282))
|
|
- `divisibleBy` ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L185))
|
|
- [`format`](https://github.com/json-schema/json-schema/wiki/Format) ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L209))
|
|
- `multipleOf` ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L186))
|
|
- `maximum` ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L183))
|
|
- `minimum` ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L182))
|
|
- `maxProperties` ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L113))
|
|
- `minProperties` ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L112))
|
|
- `not`/`disallow`
|
|
- `oneOf` ("xor", use `anyOf` instead)
|
|
- `pattern` ([string](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L203), [regex](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L207))
|
|
- `uniqueItems` ([eg](https://github.com/tdegrunt/jsonschema/blob/67c0e27ce9542efde0bf43dc1b2a95dd87df43c3/examples/all.js#L172))
|
|
|
|
## FAQ
|
|
|
|
### JSON-Schema-to-TypeScript is crashing on my giant file. What can I do?
|
|
|
|
Prettier is known to run slowly on really big files. To skip formatting and improve performance, set the `format` option to `false`.
|
|
|
|
## Further Reading
|
|
|
|
- JSON-schema spec: https://tools.ietf.org/html/draft-zyp-json-schema-04
|
|
- JSON-schema wiki: https://github.com/json-schema/json-schema/wiki
|
|
- JSON-schema test suite: https://github.com/json-schema/JSON-Schema-Test-Suite/blob/node
|
|
- TypeScript spec: https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md
|
|
|
|
## Who uses JSON-Schema-to-TypeScript?
|
|
|
|
- [Alibaba](https://github.com/alibaba/lowcode-engine)
|
|
- [Amazon](https://github.com/aws/aws-toolkit-vscode), [AWSLabs](https://github.com/awslabs/cdk8s)
|
|
- [Expo](https://github.com/expo/expo)
|
|
- [FormatJS](https://github.com/formatjs/formatjs)
|
|
- [Microsoft](https://github.com/microsoft/mixed-reality-extension-sdk)
|
|
- [Mozilla](https://github.com/mdn/browser-compat-data)
|
|
- [Nx](https://github.com/nrwl/nx)
|
|
- [RStudio](https://github.com/rstudio/rstudio)
|
|
- [Sourcegraph](https://github.com/sourcegraph/sourcegraph)
|
|
- [Stryker](https://github.com/stryker-mutator/stryker)
|
|
- [Webpack](https://github.com/webpack/webpack)
|
|
- [See more](https://github.com/bcherny/json-schema-to-typescript/network/dependents?package_id=UGFja2FnZS0xNjUxOTM5Mg%3D%3D)
|