Skip to content

Commit

Permalink
fix files
Browse files Browse the repository at this point in the history
  • Loading branch information
arthurfiorette committed May 23, 2024
1 parent 2c81902 commit 2a688dd
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 54 deletions.
36 changes: 20 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<br />

Expand All @@ -37,6 +37,7 @@ Inspired by [`YousefED/typescript-json-schema`](https://github.com/YousefED/type
## CLI Usage

<!-- usage -->

```sh-session
$ npm install -g ts-json-schema-generator
$ tjsg COMMAND
Expand All @@ -48,6 +49,7 @@ USAGE
$ tjsg COMMAND
...
```

<!-- usagestop -->

Note that different platforms (e.g. Windows) may use different path separators so you may have to adjust the command above.
Expand All @@ -59,9 +61,10 @@ Also note that you need to quote paths with `*` as otherwise the shell will expa
### Options

<!-- commands -->
* [`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]`

Expand Down Expand Up @@ -163,6 +166,7 @@ DESCRIPTION
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.22/src/commands/help.ts)_

<!-- commandsstop -->

<br />
Expand Down
47 changes: 10 additions & 37 deletions oclif.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@
"type": "boolean"
},
"id": {
"aliases": [
"schema-id"
],
"aliases": ["schema-id"],
"char": "i",
"description": "$id for generated schema",
"name": "id",
Expand All @@ -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",
Expand All @@ -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": {
Expand Down Expand Up @@ -126,11 +112,7 @@
"default": "comment",
"hasDynamicHelp": false,
"multiple": false,
"options": [
"fail",
"comment",
"hide"
],
"options": ["fail", "comment", "hide"],
"type": "option"
},
"minify": {
Expand All @@ -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": [],
Expand All @@ -164,10 +144,7 @@
"default": "json-schema",
"hasDynamicHelp": false,
"multiple": false,
"options": [
"json-schema",
"open-api"
],
"options": ["json-schema", "open-api"],
"type": "option"
}
},
Expand All @@ -180,12 +157,8 @@
"strict": true,
"enableJsonFlag": false,
"isESM": true,
"relativePath": [
"dist",
"commands",
"generate.js"
]
"relativePath": ["dist", "commands", "generate.js"]
}
},
"version": "2.0.0"
}
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 2a688dd

Please sign in to comment.