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 (12,701 stars) (5,474 forks)batch import
Enhancement: Generalhelp wanted

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

Tech stack
java
Domain
toolingbuild 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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of swagger codegenfamiliarity with code generation templates
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
This issue proposes replacing the hardcoded 'writeOptional' mechanism with a '.swagger codegen ignore' file, similar to .gitignore, to allow users to exclude files from regeneration. The change involves modifying the code generation logic to read a .swagger codegen ignore file and skip listed files. Relevant files include the code generator classes (e.g., DefaultGenerator.java) and the sample generation scripts. The goal is to improve configurability without altering template logic.