spring-projects / spring-projects/spring-boot

Add support for the configurationFileFormat option in the Spring CLI when it is available

Open
#49,960 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: pending-design-work type: enhancement
Dominant language
Java
Stars
81.5k
Forks
42.7k
Avg merge
2d 4h
Merged PRs (30d)
65

Description

spring init --list shows configurationFileFormat as an option to choose between properties or yaml however the cli does not recognize that as a valid option. See example below.

# Truncated example from spring init --list
Parameters
+-------------------------+------------------------------------------+------------------+
| Id                      | Description                              | Default value    |
+-------------------------+------------------------------------------+------------------+
| artifactId              | project coordinates (infer archive name) | demo             |
| bootVersion             | spring boot version                      | 4.0.5            |
| configurationFileFormat | configuration file format                | properties       |
| description             | project description                      |                  |
| groupId                 | project coordinates                      | com.example      |
| javaVersion             | language level                           | 17               |
| language                | programming language                     | java             |
| name                    | project name (infer application name)    |                  |
| packageName             | root package                             | com.example.demo |
| packaging               | project packaging                        | jar              |
| type                    | project type                             | gradle-project   |
| version                 | project version                          | 0.0.1-SNAPSHOT   |
+-------------------------+------------------------------------------+------------------+

coder@debian-13:~$ spring --version

spring init \
    --groupId=org.example \
    --artifactId=exmple-project \
    --javaVersion=25 \
    --type=maven-project \
    --configurationFileFormat=yaml
Spring CLI v4.0.5
configurationFileFormat is not a recognized option
coder@debian-13:~$ 

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

Start by reproducing the shown spring init command and compare it with the options reported by spring init --list. Trace where CLI options are recognized and verify that configurationFileFormat=yaml is accepted and produces the requested configuration file format.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring-boot
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.