# simple-tjscli > Create JSONSchema from typescript interface using creation engine Latest version **1.2.0** (published 2022-10-13) · MIT license · 0 weekly downloads ## Install ```sh npm install simple-tjscli pnpm add simple-tjscli yarn add simple-tjscli bun add simple-tjscli ``` Provides the command `tjscli`. ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.2.0 | | Published | 2022-10-13 | | First published | 2020-04-06 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 30 | | Unpacked size | 393.6 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 8 | | Author | ByungJoon Lee | | Maintainers | jooni | ## Links - npm: https://www.npmjs.com/package/simple-tjscli - Repository: https://github.com/imjuni/tjscli - Homepage: https://github.com/imjuni/tjscli#readme - Issues: https://github.com/imjuni/tjscli/issues - npm.io page: https://npm.io/package/simple-tjscli ## Dependencies (30) - [ora](https://npm.io/package/ora.md) ^5.4.1 - [pino](https://npm.io/package/pino.md) ^8.6.1 - [rxjs](https://npm.io/package/rxjs.md) ^7.5.7 - [uuid](https://npm.io/package/uuid.md) ^9.0.0 - [chalk](https://npm.io/package/chalk.md) ^4.1.2 - [tslib](https://npm.io/package/tslib.md) ^2.4.0 - [yargs](https://npm.io/package/yargs.md) ^17.5.1 - [colors](https://npm.io/package/colors.md) ^1.4.0 - [mathjs](https://npm.io/package/mathjs.md) ^11.3.0 - [consola](https://npm.io/package/consola.md) ^2.15.3 - [find-up](https://npm.io/package/find-up.md) ^5.0.0 - [fuse.js](https://npm.io/package/fuse.js.md) ^6.6.2 - [chokidar](https://npm.io/package/chokidar.md) ^3.5.3 - [inquirer](https://npm.io/package/inquirer.md) ^8.2.4 - [minimist](https://npm.io/package/minimist.md) ^1.2.7 - [prettier](https://npm.io/package/prettier.md) ^2.7.1 - [ts-morph](https://npm.io/package/ts-morph.md) ^16.0.0 - [fast-glob](https://npm.io/package/fast-glob.md) ^3.2.12 - [my-easy-fp](https://npm.io/package/my-easy-fp.md) ^0.16.0 - [my-node-fp](https://npm.io/package/my-node-fp.md) ^0.8.1 - [typescript](https://npm.io/package/typescript.md) ^4.7.4 - [json-schema](https://npm.io/package/json-schema.md) ^0.4.0 - [pino-pretty](https://npm.io/package/pino-pretty.md) ^9.1.1 - [jsonc-parser](https://npm.io/package/jsonc-parser.md) ^3.0.0 - [my-only-either](https://npm.io/package/my-only-either.md) ^1.1.2 - [object-traversal](https://npm.io/package/object-traversal.md) ^1.0.1 - [fast-safe-stringify](https://npm.io/package/fast-safe-stringify.md) ^2.1.1 - [typescript-json-schema](https://npm.io/package/typescript-json-schema.md) ^0.54.0 - [ts-json-schema-generator](https://npm.io/package/ts-json-schema-generator.md) ^1.1.2 - [inquirer-autocomplete-prompt](https://npm.io/package/inquirer-autocomplete-prompt.md) ^2.0.0 ## Recent versions - 1.2.0 (latest) — 2022-10-13 - 1.1.0-beta (beta) — 2022-07-19 - 1.1.2 — 2022-07-21 - 1.1.1 — 2022-07-19 - 1.1.0-beta01 — 2022-07-19 - 1.0.9 — 2022-07-11 - 1.0.8 — 2022-07-04 - 1.0.6 — 2022-07-03 - 1.0.4 — 2022-07-03 - 1.0.3 — 2022-07-03 - 1.0.2 — 2022-07-01 - 1.0.1 — 2022-06-30 - 1.0.0 — 2022-06-30 - 1.0.0-beta2 — 2022-06-30 - 1.0.0-beta — 2022-06-30 - … 22 more at https://npm.io/package/simple-tjscli/versions ## README # simple-tjscli [![Download Status](https://img.shields.io/npm/dw/simple-tjscli.svg)](https://npmcharts.com/compare/simple-tjscli?minimal=true) [![Github Star](https://img.shields.io/github/stars/imjuni/simple-tjscli.svg?style=popout)](https://github.com/imjuni/simple-tjscli) [![Github Issues](https://img.shields.io/github/issues-raw/imjuni/simple-tjscli.svg)](https://github.com/imjuni/simple-tjscli/issues) [![NPM version](https://img.shields.io/npm/v/simple-tjscli.svg)](https://www.npmjs.com/package/simple-tjscli) [![License](https://img.shields.io/npm/l/simple-tjscli.svg)](https://github.com/imjuni/simple-tjscli/blob/master/LICENSE) [![simple-tjscli](https://circleci.com/gh/imjuni/simple-tjscli.svg?style=shield)](https://app.circleci.com/pipelines/github/imjuni/simple-tjscli?branch=master) simple-tjscli is interactive cli tool for JSONSchema generation from TypeScript interface. simple-tjscli using two generator that [YousefED/typescript-json-schema](https://github.com/YousefED/typescript-json-schema) and [vega/ts-json-schema-generator](https://github.com/vega/ts-json-schema-generator). You can select one tool after generate JSONSchema from TypeScript interface. ## Only One Time 🙆 TypeScript interface convert to JSON schema. ```ts export interface Song { /** * song name * @minLength 2 * @maxLength 256 * */ name: string; /** * song length represent using second unit * @type integer * @maximum 1200 * */ seconds: string; } ``` JSON schema generate from interface below, ```json { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "name": { "type": "string", "description": "song name", "minLength": 2, "maxLength": 256 }, "seconds": { "type": "string", "description": "song length represent using second unit", "maximum": 1200 } }, "required": ["name", "seconds"] } ``` Also You can create TypeScript variable like that(apply TypeScript template), ```ts import { JSONSchema7 } from 'json-schema'; const Song = { $schema: 'http://json-schema.org/draft-07/schema#', type: 'object', properties: { name: { type: 'string', description: 'song name', minLength: 2, maxLength: 256 }, seconds: { type: 'string', description: 'song length represent using second unit', maximum: 1200 }, }, required: ['name', 'seconds'], }; export default Song; ``` Yes, simple-tjscli on counter part of [json-schema-to-ts](https://www.npmjs.com/package/json-schema-to-ts). ## fastify.js If you use [fastify.js](https://www.fastify.io), simple-tjscli is a good parter to management of schemas. simple-tjscli generate definitions for addSchema function. So you define TypeScript interface after generate validation and [@fastify/swagger](https://github.com/fastify/fastify-swagger). Yes, simple-tjscli is a one of option like [fluent-json-schema](https://github.com/fastify/fluent-json-schema), [typebox](https://github.com/sinclairzx81/typebox), [json-schema-to-ts](https://github.com/ThomasAribart/json-schema-to-ts) ```mermaid graph LR A[TypeScript
interface] -->|simple-tjscli| B[JSON schema] B -->|route| C[fastify.js] C -->|ajv| D[validateion
Request/Response
DTO] C -->|"@"fastify/swagger| E[Swagger.io
Documentation] ``` Only One conversion ## Install ```bash npm install simple-tjscli --save-dev ``` ## Usage See below example. ```bash # interfactive mode $ npx tjscli tsj -i # Pass file and type $ npx tjscli tsj -f hello.ts -t IPrompt # Watch mode $ npx tjscli tsj-w --watch [watching directory] ``` Most case, interactive mode or watch mode satisfy your need. tjscli ask to you that interface file to convert JSONSchema. ## Example Project [maeum](https://github.com/imjuni/maeum) is example project. maeum using simple-tjscli and fast-maker. ```bash # Clone the boilerplate: git clone --depth=1 \ https://github.com/imjuni/maeum \ your-project-name cd your-project-name npm install # run simple-tjscli watch mode npm run tjs-w ``` ## Options | name | shortcut | type | generator | desc. | | ---------------------- | -------- | :-------------------------------: | :-------: | :------------------------------------------------------------------------------------------------- | | --cwd | -w | string | tsj, tjs | working directory | | --config | -c | string | tsj, tjs | configuration file path. [example](https://github.com/imjuni/tjscli/blob/master/example/.tjsclirc) | | --project | -p | string | tsj, tjs | tsconfig.json file path | | --files | -f | string[] | tsj, tjs | target file | | --types | -t | string[] | tsj, tjs | target type | | --sync | -s | boolean | tsj, tjs | sync mode, schema have same directory structure in input file | | --interactive | -i | boolean | tsj, tjs | interactive mode, ask input file and type | | --noBanner | -b | boolean | tsj, tjs | no banner in generated schema | | --output | -o | string | tsj, tjs | output directory | | --outputType | -u | enum('json', 'ts') | tsj, tjs | output schema type | | --extName | -e | string | tsj, tjs | output file extension | | --prefix | -x | string | tsj, tjs | output file name prefix, ex> JSC -> JSC_IMajor.ts | | --overwrite | | string | tsj, tjs | If already exists schema file, overwrite schema | | --template | | string | tsj, tjs | template string for output typescript file | | --templatePath | | string | tsj, tjs | template file path for output typescript file | | --verbose | -v | boolean | tsj, tjs | verbose message | | --watch | | string | tsj | only work in watch mode. watch directory | | --debounceTime | | number | tsj | only work in watch mode. watch file debounceTime. default 1000ms | | --seperateDefinitions | | boolean | tsj | create definitions.ts file using definitions value in generated json-schema | | --skipTypeCheck | | boolean | tsj | ts-json-schema-generator option | | --topRef | | boolean | tsj | ts-json-schema-generator option | | --expose | | enum('all', 'none', 'export') | tsj | ts-json-schema-generator option | | --jsDoc | | enum('none', 'extended', 'basic') | tsj | ts-json-schema-generator option | | --extraTags | | string[] | tsj | ts-json-schema-generator option | | --additionalProperties | | boolean | tsj | ts-json-schema-generator option | ## Programming Interface | function | desc. | | -------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | generateJSONSchemaUsingTSJ | generate json-schema using [vega/ts-json-schema-generator](https://github.com/vega/ts-json-schema-generator) | | generateJSONSchemaUsingTJS | generate json-schema using [YousefED/typescript-json-schema](https://github.com/YousefED/typescript-json-schema) | | watchJSONSchemaUsingTSJ | watch for generate json-schema using [vega/ts-json-schema-generator](https://github.com/vega/ts-json-schema-generator) | --- _Source: https://npm.io/package/simple-tjscli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._