swagger-api / swagger-api/swagger-codegen
[All] Use .swagger-codegen-ignore instead of writeOptional
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
I think .swagger-codegen-ignore is better since it can be configured by the end user whereas writeOptional files are hard-coded in the codegen.
For instance, when generating the petstore samples, you want to overwrite the pom.xml but it doesn't occur unless you rm the file first.
It would be better to pre-configure in the templates the .swagger-codegen-ignore to ignore pom.xml, build.gradle, etc...
The only writeOptional file would then be .swagger-codegen-ignore
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 tracing writeOptional and the template definitions used when generating the petstore samples; inspect how .swagger-codegen-ignore, pom.xml, and build.gradle are emitted. Compare the current overwrite behavior with the proposed ignore configuration, and confirm the affected templates produce the expected files without requiring manual removal.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100