Polish "Add support for YAML configuration file format"

See gh-1682

Author: mhalbritter

initializr-docs/src/main/asciidoc/configuration-guide.adoc

@@ -286,7 +286,7 @@ will have values. In the rest of this section, we will configure those basic set
 Most of the settings are configured via `application.properties` using the `initializr`
 namespace. Because the configuration is highly hierarchical, we recommend using the yaml
 format that is more readable for such structure. If you agree, go ahead and create an
-`application.yml` in `src/main/resources`.
+`application.yaml` in `src/main/resources`.
 ====
 
 

initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/properties/ApplicationProperties.java

@@ -69,7 +69,7 @@ public void add(String key, String value) {
 		add(key, (Object) value);
 	}
 
-	void writeTo(PrintWriter writer) {
+	void writeProperties(PrintWriter writer) {
 		for (Map.Entry<String, Object> entry : this.properties.entrySet()) {
 			writer.printf("%s=%s%n", entry.getKey(), entry.getValue());
 		}

initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/properties/ApplicationPropertiesContributor.java

@@ -51,7 +51,7 @@ public void contribute(Path projectRoot) throws IOException {
 		}
 		try (PrintWriter writer = new PrintWriter(Files.newOutputStream(output, StandardOpenOption.APPEND), false,
 				StandardCharsets.UTF_8)) {
-			this.properties.writeTo(writer);
+			this.properties.writeProperties(writer);
 		}
 	}
 

initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/properties/ApplicationYamlPropertiesContributor.java

@@ -26,14 +26,14 @@
 import io.spring.initializr.generator.project.contributor.ProjectContributor;
 
 /**
- * A {@link ProjectContributor} that contributes a {@code application.yml} file to a
+ * A {@link ProjectContributor} that contributes a {@code application.yaml} file to a
  * project.
  *
  * @author Sijun Yang
  */
 public class ApplicationYamlPropertiesContributor implements ProjectContributor {
 
-	private static final String FILE = "src/main/resources/application.yml";
+	private static final String FILE = "src/main/resources/application.yaml";
 
 	private final ApplicationProperties properties;
 

initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/ProjectGeneratorIntegrationTests.java

@@ -94,7 +94,7 @@ void yaml() {
 					"test/demo-app/mvnw", "test/demo-app/mvnw.cmd",
 					"test/demo-app/.mvn/wrapper/maven-wrapper.properties",
 					"test/demo-app/src/main/java/com/example/demo/DemoApplication.java",
-					"test/demo-app/src/main/resources/application.yml",
+					"test/demo-app/src/main/resources/application.yaml",
 					"test/demo-app/src/test/java/com/example/demo/DemoApplicationTests.java", "test/demo-app/HELP.md");
 	}
 

initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/properties/ApplicationPropertiesComplianceTests.java

@@ -49,7 +49,7 @@ class ApplicationPropertiesComplianceTests extends AbstractComplianceTests {
 	static Stream<Arguments> parameters() {
 		return Stream.of(
 				Arguments.arguments(ConfigurationFileFormat.forId(PropertiesFormat.ID), "application.properties"),
-				Arguments.arguments(ConfigurationFileFormat.forId(YamlFormat.ID), "application.yml"));
+				Arguments.arguments(ConfigurationFileFormat.forId(YamlFormat.ID), "application.yaml"));
 	}
 
 	@ParameterizedTest

initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/properties/ApplicationPropertiesTests.java

@@ -35,31 +35,31 @@ class ApplicationPropertiesTests {
 	void stringProperty() {
 		ApplicationProperties properties = new ApplicationProperties();
 		properties.add("test", "string");
-		String written = write(properties);
+		String written = writeProperties(properties);
 		assertThat(written).isEqualToIgnoringNewLines("test=string");
 	}
 
 	@Test
 	void longProperty() {
 		ApplicationProperties properties = new ApplicationProperties();
 		properties.add("test", 1);
-		String written = write(properties);
+		String written = writeProperties(properties);
 		assertThat(written).isEqualToIgnoringNewLines("test=1");
 	}
 
 	@Test
 	void doubleProperty() {
 		ApplicationProperties properties = new ApplicationProperties();
 		properties.add("test", 0.1);
-		String written = write(properties);
+		String written = writeProperties(properties);
 		assertThat(written).isEqualToIgnoringNewLines("test=0.1");
 	}
 
 	@Test
 	void booleanProperty() {
 		ApplicationProperties properties = new ApplicationProperties();
 		properties.add("test", false);
-		String written = write(properties);
+		String written = writeProperties(properties);
 		assertThat(written).isEqualToIgnoringNewLines("test=false");
 	}
 
@@ -81,14 +81,24 @@ void writeYaml() {
 		properties.add("app.config.debug", true);
 		properties.add("db.connection.timeout", 30);
 		String written = writeYaml(properties);
-		assertThat(written).contains("name: testapp", "port: 8080", "app:\n  config:\n    debug: true\n  version: 1.0",
-				"db:\n  host: localhost\n  connection:\n    timeout: 30");
+		assertThat(written).isEqualToNormalizingNewlines("""
+				app:
+				  config:
+				    debug: true
+				  version: 1.0
+				port: 8080
+				name: testapp
+				db:
+				  host: localhost
+				  connection:
+				    timeout: 30
+				""");
 	}
 
-	private String write(ApplicationProperties properties) {
+	private String writeProperties(ApplicationProperties properties) {
 		StringWriter stringWriter = new StringWriter();
 		try (PrintWriter writer = new PrintWriter(stringWriter)) {
-			properties.writeTo(writer);
+			properties.writeProperties(writer);
 		}
 		return stringWriter.toString();
 	}

initializr-generator-spring/src/test/resources/project/properties/yaml/application.yml.gen renamed to initializr-generator-spring/src/test/resources/project/properties/yaml/application.yaml.gen

@@ -58,7 +58,7 @@ On further request, you won't see this log entry as the content is cached.
 There are no expiration set, so the available versions won't change until you restart the service.
 
 === Basic Metadata
-The configuration in `application.yml` is very simple with a single `web` dependency that brings `spring-boot-starter-web`.
+The configuration in `application.yaml` is very simple with a single `web` dependency that brings `spring-boot-starter-web`.
 The default `groupId` for generated projects has been customized to `org.acme`.
 
 You can experiment by adding more dependencies or other elements that drive how projects are generated.

initializr-service-sample/README.adoc

@@ -52,3 +52,10 @@ initializr:
         format: project
       default: false
       action: /starter.zip
+  configuration-file-formats:
+    - name: Properties
+      id: properties
+      default: true
+    - name: YAML
+      id: yaml
+      default: false