thim81 / thim81/openapi-format
Suggestion: Prettier like parameters to allow for easy script usage
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 177
- Forks
- 29
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 1
Description
Hi,
first of all, thanks for your tool that helps keeping API definitions and commits clean. ❤️
prettier has a CLI that makes it really easy to use it in scripts, e.g. in CI:
--writereplaces the input files- it accepts (multiple) paths/glob patterns
--checkmakes it fail if something changed
That might be a nice addition to openapi-format, too, although you can work arround the first two with find . -name '*.yaml' -exec yarn run openapi-format {} -o {} \;.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating and running the existing yarn run openapi-format CLI entry point and its argument handling. Compare it with the linked Prettier CLI behavior for --write, multiple paths or glob patterns, and --check; done means these script-oriented options work for OpenAPI files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100