Merge v14.0.4 (+ readme updates)

.github/workflows/ci.yml

@@ -9,18 +9,19 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [12.x, 14.x, 16.x, 17.x, 18.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

@@ -13,5 +13,4 @@ node_modules
 *.map
 dist/
 dist_tests/
-package-lock.json
 yarn-error.log

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 *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).
 
+## 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

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/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 json-schema-to-typescript
-
-# Or, using NPM:
-npm install json-schema-to-typescript --save
+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'
 
@@ -84,7 +133,8 @@ See [server demo](example) and [browser demo](https://github.com/bcherny/json-sc
 | 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 JSONSchema file,\n* and run json-schema-to-typescript to regenerate this file.\n*/"` | Disclaimer comment prepended to the top of each generated file |
+| 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)? |
@@ -95,40 +145,14 @@ See [server demo](example) and [browser demo](https://github.com/bcherny/json-sc
 | 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/BigstickCarpet/json-schema-ref-parser) Options, used when resolving `$ref`s |
-## CLI
-
-A CLI utility is provided with this package.
+| $refOptions | object | `{}` | [$RefParser](https://github.com/APIDevTools/json-schema-ref-parser) Options, used when resolving `$ref`s |
 
-```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/
-```
-
-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`