Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): update README with --no-index-files option #7

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,13 @@ Usage: brij dto [options] <string> <string>
Output TypeScript artifacts based on json-schema definitions in OAS files

Arguments:
string source directory with OAS files
string output directory for generated TypeScript files
source <string> source directory with OAS or JSON schema files
output <string> output directory for generated TypeScript files

Options:
--schemas <string> JSON path to the section in the OAS with the JSON schemas, e.g. '#/definitions'
--remove-circular whether to remove circular references from schemas and treat them as generic objects, rather than fail to generate specs with circular references
--no-index-files skip generation of index.ts files that auto-export all exports in each file in each directory
-h, --help display help for command
```

Expand Down