swagger-api/swagger-codegen

[All] Use .swagger-codegen-ignore instead of writeOptional

Open

#3,100 opened on Jun 9, 2016

View on GitHub
 (1 comment) (1 reaction) (0 assignees)HTML (5,474 forks)batch import
Enhancement: Generalhelp wanted

Repository metrics

Stars
 (12,701 stars)
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

Research direction
Investigate existing .swagger codegen ignore support and compare with writeOptional logic. Identify where writeOptional is used and propose changes to use the ignore file instead.
Tech stack
java
Domain
build system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70