OpenAPITools / OpenAPITools/openapi-generator

[REQ] Build tool configuration parameter

Open
#13,418 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
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.

Projects, which generate code required compilation may generate multiple build tool files.
For example java generator may generate maven and gradle projects. This usually make some mess as only one of those build tools will be used in generated project.

Describe the solution you'd like

Add nullable parameter buildTool in DefaultGenerator which may have default value per generator.

buildTool should be a feature of cli so i can choose between gradle, maven, sbt or any other tool specified in feature to generate only one type of project.

buildTool can be null for generators doesn't require tools, ex. javascript.

config example:

generatorName: jax-rs
inputSpec: openapi.yaml
outputDir: resteasy-project
library: resteasy
buildTool: gradle

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The request names DefaultGenerator and the CLI feature/configuration path as entry points; start by tracing how generator-specific defaults and CLI parameters are handled. Define how gradle, maven, sbt, or a null value select generated build files, including the Java and JavaScript cases. Done means a configuration can select one build tool without generating the others.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.