V15

.eslintrc.json

@@ -1,5 +1,5 @@
 {
-  "extends": ["prettier/@typescript-eslint", "plugin:prettier/recommended"],
+  "extends": ["prettier", "plugin:prettier/recommended"],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 2020,

.github/workflows/ci.yml

@@ -5,22 +5,23 @@ on: [push, pull_request]
 jobs:
   build:
     runs-on: ubuntu-latest
-    
+
     strategy:
       fail-fast: false
       matrix:
-        node-version: [10.x, 12.x, 13.x]
+        node-version: [16.x, 17.x, 18.x, 19.x, 20.x, 21.x]
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
+        cache: 'npm'
     - name: Install dependencies
-      run: yarn install --ignore-engines --verbose 
+      run: npm ci
     - name: Run tests
-      run: yarn test
+      run: npm test
       env:
         CI: true

.gitignore

@@ -1,10 +1,16 @@
 .DS_Store
 .idea/
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
 npm-debug.log
 node_modules
 *.js
 *.map
 dist/
 dist_tests/
-package-lock.json
 yarn-error.log

.nvmrc

@@ -1 +1 @@
-6.3.0
+16

.prettierrc

@@ -5,7 +5,7 @@
   "printWidth": 120,
   "semi": false,
   "singleQuote": true,
-  "trailingComma": "none",
+  "trailingComma": "all",
   "useTabs": false,
   "arrowParens": "avoid"
 }

CHANGELOG.md

@@ -2,6 +2,61 @@
 
 *Note: This is a partial changelog, covering significant & breaking changes. For a full list of changes, please consult the [commit log](https://github.com/bcherny/json-schema-to-typescript/commits).
 
+## 15.0.0
+
+- 62cc052 Fixed bug where intersection schemas didn't generate complete types. Improved output readability for intersection types (#603)
+
+## 14.1.0
+
+- 3e2e1e9 Added `inferStringEnumKeysFromValues` option (#578)
+
+## 14.0.5
+
+- b7fee29 Added .yaml support for CLI (#598)
+
+## 14.0.2
+
+- 9ec0c70 Added .yaml support (#577)
+
+## 14.0.1
+
+- 2f29f19 Added `customName` option
+
+## 14.0.0
+
+- 967eb13 Require Node v16+
+
+## 13.1.0
+
+- f797848 Feat: Add support for `deprecated` keyword
+
+## 13.0.1
+
+- b13a6f2 Bugfix: Boolean CLI flags were not respected (#524)
+
+## 13.0.0
+
+- 05b0103 Bugfix: Parse boolean schemas as schemas, rather than as literals (#515)
+- 8f973d1 Bugfix: Fix edge case where emitted names were corrupted when using `strictIndexSignature` (#423)
+
+## 12.0.0
+
+- b73e1c7 Bugfix: Parse enums as literals, rather than as schemas (#508)
+
+## 11.0.0
+
+This is a major release with lots of bugfixes, some of which may change emitted types.
+
+- 2ca6e50 Bugfix: Fix crash that may happen when emitting types for cyclical schemas (#323, #376)
+- 8fa728e Bugfix: Fix tests on Windows, make snapshot ordering consistent
+- b78a616 Bugfix: Make `compile()` non-mutating (#370, #443)
+- a89ffe1 Bugfix: Add maximum size heuristic for tuple types (#438)
+- 6fbcbc8 Bugfix: Improve performance & stability issue caused by JSON serialization (#422)
+- 7aa353d Feat: Add support for `$id` (#436)
+- 59747b1 Feat: Add support for specifying a default for `additionalProperties` (#335)
+- 966cca5 Cleanup: Drop support for Node 10
+
+
 ## 10.1.0
 
 - ec78099 Feat: Add support for JSON Schema `const` and `$defs` keywords (#263)

LICENCE.md

@@ -0,0 +1,7 @@
+Copyright 2022 Boris Cherny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,14 +1,18 @@
-# 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)
+# 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/workflow/status/bcherny/json-schema-to-typescript/CI/master?style=flat-square
+[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
+> 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",
@@ -36,6 +40,7 @@ Input:
 ```
 
 Output:
+
 ```ts
 export interface ExampleSchema {
   firstName: string;
@@ -51,15 +56,59 @@ export interface ExampleSchema {
 ## Installation
 
 ```sh
-# Using Yarn:
-yarn add @takeshape/json-schema-to-typescript
-
-# Or, using NPM:
-npm install @takeshape/json-schema-to-typescript --save
+npm install @takeshape/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'
 
@@ -83,50 +132,28 @@ See [server demo](example) and [browser demo](https://github.com/bcherny/json-sc
 
 | key | type | default | description |
 |-|-|-|-|
-| bannerComment | string | `"/* tslint:disable */\n/**\n* This file was automatically generated by json-schema-to-typescript.\n* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,\n* and run json-schema-to-typescript to regenerate this file.\n*/"` | Disclaimer comment prepended to the top of each generated file |
+| 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 `definitions` that aren't referenced by the schema. |
-| strictIndexSignatures | boolean | `false` | Append all index signatures with `\| undefined` so that they are strictly typed. |
-| $refOptions | object | `{}` | [$RefParser](https://github.com/BigstickCarpet/json-schema-ref-parser) Options, used when resolving `$ref`s |
-## CLI
-
-A CLI utility is provided with this package.
-
-```sh
-cat foo.json | json2ts > foo.d.ts
-# or
-json2ts foo.json > foo.d.ts
-# or
-json2ts foo.json 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/
-```
+| 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 |
 
-You can pass any of the options described above (including style options) as CLI flags. Boolean values can be set to false using the `no-` prefix.
+## Tests
 
 ```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
+$ npm test
 ```
 
-## Tests
-
-`npm test`
-
 ## Features
 
 - [x] `title` => `interface`
@@ -151,6 +178,7 @@ json2ts -i foo.json -o foo.d.ts --style.singleQuote --no-style.semi
 - [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`)
@@ -200,9 +228,14 @@ Prettier is known to run slowly on really big files. To skip formatting and impr
 
 ## Who uses JSON-Schema-to-TypeScript?
 
-- [AWS](https://github.com/aws/aws-toolkit-vscode), [AWSLabs](https://github.com/awslabs/cdk8s)
+- [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)

example/index.ts

@@ -1,5 +1,5 @@
-import { writeFileSync } from 'fs'
-import { compileFromFile } from 'json-schema-to-typescript'
+import {writeFileSync} from 'fs'
+import {compileFromFile} from 'json-schema-to-typescript'
 
 async function generate() {
   writeFileSync('person.d.ts', await compileFromFile('person.json'))

example/person.d.ts

@@ -1,17 +1,17 @@
-/* tslint:disable */
+/* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
  * and run json-schema-to-typescript to regenerate this file.
  */
 
 export interface Person {
-  firstName: string;
-  lastName: string;
+  firstName: string
+  lastName: string
   /**
    * Age in years
    */
-  age?: number;
-  hairColor?: "black" | "brown" | "blue";
-  [k: string]: unknown;
+  age?: number
+  hairColor?: 'black' | 'brown' | 'blue'
+  [k: string]: unknown
 }