chore: update README with new CLI options for configuration and linting & add NOTICE #66

Merged
blas merged 5 commits from feat/update-docu into main 2026-03-27 14:11:30 +00:00
2 changed files with 62 additions and 0 deletions

50
NOTICE Normal file
View File

@@ -0,0 +1,50 @@
OpenAPI Clean Architecture Generator
Copyright (c) 2026 Blas Santomé Ocampo
Outdated
Review

2024 por la cara

2024 por la cara

Me gustaba el numero

Me gustaba el numero
This product includes software developed by third parties.
All third-party packages listed below are distributed under the MIT License.
---
chalk v4.1.2
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
License: MIT
https://github.com/chalk/chalk
---
commander v11.1.0
Copyright (c) TJ Holowaychuk <tj@vision-media.ca>
License: MIT
https://github.com/tj/commander.js
---
fs-extra v11.3.4
Copyright (c) JP Richardson <jprichardson@gmail.com>
License: MIT
https://github.com/jprichardson/node-fs-extra
---
js-yaml v4.1.1
Copyright (c) Vladimir Zapparov <dervus.grim@gmail.com>
Copyright (c) Aleksey V Zapparov <ixti@member.fsf.org>
Copyright (c) Vitaly Puzrin <vitaly@rcdesign.ru>
Copyright (c) Martin Grenfell <martin.grenfell@gmail.com>
License: MIT
https://github.com/nodeca/js-yaml
---
mustache v4.2.0
Copyright (c) mustache.js Authors (http://github.com/janl/mustache.js)
License: MIT
https://github.com/janl/mustache.js
---
prompts v2.4.2
Copyright (c) Terkel Gjervig
License: MIT
https://github.com/terkelg/prompts

View File

@@ -76,7 +76,10 @@ Options:
-o, --output <dir> Output directory [default: ./src/app]
-t, --templates <dir> Custom templates directory [default: ./templates]
-s, --select-endpoints Interactively select tags and endpoints to generate
-c, --config <file> Use a JSON configuration file (skips interactive prompts)
--init-config [file] Generate a JSON configuration file instead of generating code
--skip-install Skip dependency installation
--skip-lint Skip post-generation linting and formatting
--dry-run Simulate without writing files
-h, --help Show help
```
@@ -96,6 +99,15 @@ generate-clean-arch -i api.yaml -t ./my-templates
# Dry run (no files written)
generate-clean-arch -i swagger.yaml --dry-run
# Skip linting after generation
generate-clean-arch -i swagger.yaml --skip-lint
# Generate a config file to reuse later
generate-clean-arch --init-config generation-config.json
# Run using a config file (no interactive prompts)
generate-clean-arch -c generation-config.json
# Full example with all options
generate-clean-arch -i ./docs/api.yaml -o ./frontend/src/app -t ./custom-templates
```