OpenAPITools / OpenAPITools/openapi-generator
[REQ] coding style across the various modules (not generated code) would be easier to maintain if it was consistent
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
when reading code-gen code the styles are somewhat mixed. this is easily addressable with IntelliJ's (and probably Eclipse's and VS-Code's) code-style feature. the format appears to be very close to IntelliJ's default style with a few modifications for multiple annotations on a single line.
Describe the solution you'd like
generate and apply a consistent code-style across the various codegen modules' code to make it easier for developers to maintain it.
Describe alternatives you've considered
continue to deal with inconsistent code style.
Additional context
applying this would be a one-time large event (as all the changes will be whitespace) and then a minor annoyance going forward.
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
Review the various codegen modules and compare their formatting with IntelliJ's default style, including the noted handling of multiple annotations on one line. Apply one consistent style across the non-generated code and verify that the resulting changes are limited to whitespace and formatting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- developer-experience, tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100