swagger-api / swagger-api/swagger-codegen
ReadMe.md files should specify which options were set during code generation
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
When I generate code from my .yaml file, I have no record of which options I specified in the generator. If I'm experimenting with different code generation options, it's easy to lose track of which options I used to generate which projects.
Command line used for generation
This is for all languages and all generators.
Suggest a fix/enhancement
When the generators create the README.md file, it would be helpful if you specified which options were set in the generator. This would make it much easier to experiment with different options. It would also be helpful with debugging the code-generation process if somebody breaks something by changing an option. This shouldn't be hard to do, and it would be useful for all languages.
Options that require text input, and that are left blank, can probably be excluded. Unchecked options can also be excluded.
Contributor guide
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 the generator code that creates README.md and trace how generation options are collected across language generators. Check how blank text and unchecked options are represented, then define coverage for all generators; done means generated README.md files record selected options while omitting blank and unchecked entries.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100