From 2a688ddf8d6a2b56d023a7ab5377230e343d463b Mon Sep 17 00:00:00 2001 From: Arthur Fiorette Date: Thu, 23 May 2024 15:48:01 -0300 Subject: [PATCH] fix files --- README.md | 36 +++++++++++++++++++--------------- oclif.manifest.json | 47 ++++++++++----------------------------------- package.json | 2 +- 3 files changed, 31 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index d7de742a..718cca18 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,19 @@ Extended version of [https://github.com/xiag-ag/typescript-to-json-schema](https --- -- [Inspiration](#inspiration) -- [CLI Usage](#cli-usage) - - [Options](#options) -- [`tjsg autocomplete [SHELL]`](#tjsg-autocomplete-shell) -- [`tjsg generate`](#tjsg-generate) -- [`tjsg help [COMMAND]`](#tjsg-help-command) -- [Current state](#current-state) -- [Contributors](#contributors) -- [Programmatic Usage](#programmatic-usage) - - [Custom formatting](#custom-formatting) - - [Custom parsing](#custom-parsing) -- [Run locally](#run-locally) -- [Publish](#publish) +- [Inspiration](#inspiration) +- [CLI Usage](#cli-usage) + - [Options](#options) +- [`tjsg autocomplete [SHELL]`](#tjsg-autocomplete-shell) +- [`tjsg generate`](#tjsg-generate) +- [`tjsg help [COMMAND]`](#tjsg-help-command) +- [Current state](#current-state) +- [Contributors](#contributors) +- [Programmatic Usage](#programmatic-usage) + - [Custom formatting](#custom-formatting) + - [Custom parsing](#custom-parsing) +- [Run locally](#run-locally) +- [Publish](#publish)
@@ -37,6 +37,7 @@ Inspired by [`YousefED/typescript-json-schema`](https://github.com/YousefED/type ## CLI Usage + ```sh-session $ npm install -g ts-json-schema-generator $ tjsg COMMAND @@ -48,6 +49,7 @@ USAGE $ tjsg COMMAND ... ``` + Note that different platforms (e.g. Windows) may use different path separators so you may have to adjust the command above. @@ -59,9 +61,10 @@ Also note that you need to quote paths with `*` as otherwise the shell will expa ### Options -* [`tjsg autocomplete [SHELL]`](#tjsg-autocomplete-shell) -* [`tjsg generate [PATH]`](#tjsg-generate-path) -* [`tjsg help [COMMAND]`](#tjsg-help-command) + +- [`tjsg autocomplete [SHELL]`](#tjsg-autocomplete-shell) +- [`tjsg generate [PATH]`](#tjsg-generate-path) +- [`tjsg help [COMMAND]`](#tjsg-help-command) ## `tjsg autocomplete [SHELL]` @@ -163,6 +166,7 @@ DESCRIPTION ``` _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.22/src/commands/help.ts)_ +
diff --git a/oclif.manifest.json b/oclif.manifest.json index 58f22837..bde85ff2 100644 --- a/oclif.manifest.json +++ b/oclif.manifest.json @@ -32,9 +32,7 @@ "type": "boolean" }, "id": { - "aliases": [ - "schema-id" - ], + "aliases": ["schema-id"], "char": "i", "description": "$id for generated schema", "name": "id", @@ -43,9 +41,7 @@ "type": "option" }, "tsconfig": { - "aliases": [ - "project" - ], + "aliases": ["project"], "char": "p", "description": "Your tsconfig.json to load entry files and compilation settings", "name": "tsconfig", @@ -60,28 +56,18 @@ "default": "export", "hasDynamicHelp": false, "multiple": false, - "options": [ - "all", - "none", - "export" - ], + "options": ["all", "none", "export"], "type": "option" }, "jsdoc": { - "aliases": [ - "jsDoc" - ], + "aliases": ["jsDoc"], "char": "j", "description": "Read JsDoc annotations", "name": "jsdoc", "default": "extended", "hasDynamicHelp": false, "multiple": false, - "options": [ - "none", - "basic", - "extended" - ], + "options": ["none", "basic", "extended"], "type": "option" }, "markdown-description": { @@ -126,11 +112,7 @@ "default": "comment", "hasDynamicHelp": false, "multiple": false, - "options": [ - "fail", - "comment", - "hide" - ], + "options": ["fail", "comment", "hide"], "type": "option" }, "minify": { @@ -148,9 +130,7 @@ "type": "option" }, "extra-tags": { - "aliases": [ - "validation-keywords" - ], + "aliases": ["validation-keywords"], "description": "Provide additional validation keywords to include", "name": "extra-tags", "default": [], @@ -164,10 +144,7 @@ "default": "json-schema", "hasDynamicHelp": false, "multiple": false, - "options": [ - "json-schema", - "open-api" - ], + "options": ["json-schema", "open-api"], "type": "option" } }, @@ -180,12 +157,8 @@ "strict": true, "enableJsonFlag": false, "isESM": true, - "relativePath": [ - "dist", - "commands", - "generate.js" - ] + "relativePath": ["dist", "commands", "generate.js"] } }, "version": "2.0.0" -} \ No newline at end of file +} diff --git a/package.json b/package.json index 78774ebc..f1f44914 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ ], "scripts": { "build": "npm run build:cjs && npm run build:esm", - "postbuild": "oclif manifest && oclif readme", + "postbuild": "oclif manifest && oclif readme && prettier --write README.md oclif.manifest.json", "build:cjs": "tsc -p tsconfig.cjs.json", "build:esm": "tsc -p tsconfig.json", "debug": "tsx --inspect-brk ts-json-schema-generator.ts",