Skip to content

Commit 0b92daa

Browse files
committed
docs(README): tags usage in example
1 parent 30113fe commit 0b92daa

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,16 @@ This command will do the same but it will split **all of the tags to separate AP
7070
},
7171
```
7272

73+
**Recommended:**
74+
75+
- use a "tag" (`-t all`) option to generate all (or list of specific) services separately
76+
77+
```
78+
"scripts": {
79+
"generate-api-client": "api-client-generator -s ./swagger.yaml -o ./output-folder -t all"
80+
},
81+
```
82+
7383
- then just run
7484

7585
`npm run generate-api-client`
@@ -78,17 +88,16 @@ This command will do the same but it will split **all of the tags to separate AP
7888

7989
# Options
8090

81-
| Option | Description |
82-
| ------------------------- | ---------------------------------------------------------------------------------------------------- |
83-
| `-h`/`--help` | print help and exit |
84-
| `-s`/`--source` | path to the swagger file (YAML or JSON) |
85-
| `-o`/`--output` | path where the generated files should be emitted |
86-
| `-C`/`--commit` | `git commit` generated changes \* |
87-
| `-v`/`--verbose` | supply stack traces with outputted error messages |
88-
| `-t`/`--splitPathTags` | generate services and models only for the specified tags. Use `,` as the separator for multiple tags |
89-
| | use `all` to emit all as a service per tag |
90-
| `-m`/`--skipModule` | skip creating the index file with module export |
91-
| `-p`/`--noPrettierIgnore` | omit prettier ignore comment in the header of each file |
91+
| Option | Description |
92+
| ---------------------- | ---------------------------------------------------------------------------------------------------- |
93+
| `-h`/`--help` | print help and exit |
94+
| `-s`/`--source` | path to the swagger file (YAML or JSON) |
95+
| `-o`/`--output` | path where the generated files should be emitted |
96+
| `-C`/`--commit` | `git commit` generated changes \* |
97+
| `-v`/`--verbose` | supply stack traces with outputted error messages |
98+
| `-t`/`--splitPathTags` | generate services and models only for the specified tags. Use `,` as the separator for multiple tags |
99+
| | use `all` to emit all as a service per tag |
100+
| `-m`/`--skipModule` | skip creating the index file with module export |
92101

93102
<small>\* The author of the commit will be `api-client-generator <[email protected]>`.
94103
If there are any staged changes in your repository, the generator will halt pre-generation with an error to prevent including your changes in the automatic commit.\*</small>

0 commit comments

Comments
 (0)