@ts-to-json-schema/esbuild-plugin

ESBuild plugin for TypeScript to JSON Schema

Installation

1npm install --save-dev typescript esbuild @ts-to-json-schema/esbuild-plugin @ts-to-json-schema/transform

Configuration

1const esbuild = require('esbuild');
2const { tsToJsonSchemaPlugin } = require('@ts-to-json-schema/esbuild-plugin');
3
4esbuild.build({
5  entryPoints: ['src/index.ts'],
6  bundle: true,
7  outfile: 'dist/index.js',
8  plugins: [
9    tsToJsonSchemaPlugin() // Add here
10  ],
11}).catch(() => process.exit(1));

Options

tsConfigFile

You can specify the path to the TypeScript configuration file.

1tsToJsonSchemaPlugin({
2  tsConfigFile: 'tsconfig.other.json' // Default: 'tsconfig.json'
3})

tsx

You can enable parsing of TSX files.

1tsToJsonSchemaPlugin({
2  tsx: true // Default: false
3})