Progress with doc and tests

Author: blacelle

CHANGES.md

@@ -12,6 +12,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ## [Unreleased]
 ### Added
 * Added `skipLinesMatching` option to `licenseHeader` to support formats where license header cannot be immediately added to the top of the file (e.g. xml, sh). ([#1441](https://github.com/diffplug/spotless/pull/1441)).
+* Add YAML support through Jackson ([#1478](https://github.com/diffplug/spotless/pull/1478))
 ### Fixed
 * Support `ktlint` 0.48+ new rule disabling syntax ([#1456](https://github.com/diffplug/spotless/pull/1456)) fixes ([#1444](https://github.com/diffplug/spotless/issues/1444))
 

lib/src/main/java/com/diffplug/spotless/yaml/YamlJacksonStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 DiffPlug
+ * Copyright 2021-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -92,8 +92,7 @@ FormatterFunc toFormatter() {
 				// Configure the ObjectMapper
 				// https://github.com/FasterXML/jackson-databind#commonly-used-features
 				{
-					serializationFeatureClass =
-							classLoader.loadClass("com.fasterxml.jackson.databind.SerializationFeature");
+					serializationFeatureClass = classLoader.loadClass("com.fasterxml.jackson.databind.SerializationFeature");
 					enableFeature = objectMapperClass.getMethod("enable", serializationFeatureClass);
 					disableFeature = objectMapperClass.getMethod("disable", serializationFeatureClass);
 				}

plugin-maven/CHANGES.md

@@ -5,6 +5,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ## [Unreleased]
 ### Added
 * Added `skipLinesMatching` option to `licenseHeader` to support formats where license header cannot be immediately added to the top of the file (e.g. xml, sh). ([#1441](https://github.com/diffplug/spotless/pull/1441))
+* Add YAML support through Jackson ([#1478](https://github.com/diffplug/spotless/pull/1478))
 ### Fixed
 * Support `ktlint` 0.48+ new rule disabling syntax ([#1456](https://github.com/diffplug/spotless/pull/1456)) fixes ([#1444](https://github.com/diffplug/spotless/issues/1444))
 ### Changes

plugin-maven/README.md

@@ -59,6 +59,7 @@ user@machine repo % mvn spotless:check
   - [Markdown](#markdown) ([flexmark](#flexmark))
   - [Typescript](#typescript) ([tsfmt](#tsfmt), [prettier](#prettier))
   - [JSON](#json)
+  - [YAML](#yaml)
   - Multiple languages
     - [Prettier](#prettier) ([plugins](#prettier-plugins), [npm detection](#npm-detection), [`.npmrc` detection](#npmrc-detection))
     - [eclipse web tools platform](#eclipse-web-tools-platform)
@@ -712,7 +713,7 @@ For details, see the [npm detection](#npm-detection) and [`.npmrc` detection](#n
 
 ## JSON
 
-- `com.diffplug.spotless.maven.json.Json` [code](https://github.com/diffplug/spotless/blob/main/plugin-maven/src/main/java/com/diffplug/spotless/maven/json/json.java)
+- `com.diffplug.spotless.maven.json.Json` [code](https://github.com/diffplug/spotless/blob/main/plugin-maven/src/main/java/com/diffplug/spotless/maven/json/Json.java)
 
 ```xml
 <configuration>
@@ -759,6 +760,42 @@ for details.
 
 <a name="applying-prettier-to-javascript--flow--typescript--css--scss--less--jsx--graphql--yaml--etc"></a>
 
+
+## YAML
+
+- `com.diffplug.spotless.maven.FormatterFactory.addStepFactory(FormatterStepFactory)` [code](https://github.com/diffplug/spotless/blob/main/plugin-maven/src/main/java/com/diffplug/spotless/maven/yaml/Yaml.java)
+
+```xml
+<configuration>
+  <yaml>
+    <includes>   <!-- These are the default includes -->
+      <include>**/*.yaml</include>
+      <include>**/*.yml</include>
+    </includes>
+
+    <jackson />    <!-- has its own section below -->
+  </yaml>
+</configuration>
+```
+
+### jackson
+
+Uses Jackson and YAMLFactory to pretty print objects:
+
+```xml
+<jackson>
+  <version>2.13.4</version>    <!-- optional: The version of 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml' to be used -->
+  <enabledFeatures>    <!-- optional: Customize the set of enabled features -->
+    <enabledFeature>INDENT_OUTPUT<enabledFeature/>
+  </enabledFeatures>
+  <disabledFeatures>    <!-- optional: Customize the set of disabled features -->
+    <disabledFeature>DEFAULT_HAS_TO_DISABLED_FEATURE<disabledFeature/>
+  </disabledFeatures>
+</jackson>
+```
+
+<a name="applying-prettier-to-javascript--flow--typescript--css--scss--less--jsx--graphql--yaml--etc"></a>
+
 ## Prettier
 
 [homepage](https://prettier.io/). [changelog](https://github.com/prettier/prettier/blob/master/CHANGELOG.md). [official plugins](https://prettier.io/docs/en/plugins.html#official-plugins). [community plugins](https://prettier.io/docs/en/plugins.html#community-plugins). Prettier is a formatter that can format almost every anything - JavaScript, JSX, Angular, Vue, Flow, TypeScript, CSS, Less, SCSS, HTML, JSON, GraphQL, Markdown (including GFM and MDX), and YAML.  It can format even more [using plugins](https://prettier.io/docs/en/plugins.html) (PHP, Ruby, Swift, XML, Apex, Elm, Java (!!), Kotlin, pgSQL, .properties, solidity, svelte, toml, shellscript, ...).

plugin-maven/src/main/java/com/diffplug/spotless/maven/yaml/JacksonYaml.java

@@ -31,7 +31,7 @@ public class JacksonYaml implements FormatterStepFactory {
 	private String version = YamlJacksonStep.defaultVersion();
 
 	@Parameter
-	private String[] enabledFeatures = new String[] { "INDENT_OUTPUT" };
+	private String[] enabledFeatures = new String[]{"INDENT_OUTPUT"};
 
 	@Parameter
 	private String[] disabledFeatures = new String[0];

plugin-maven/src/main/java/com/diffplug/spotless/maven/yaml/Yaml.java

@@ -15,9 +15,9 @@
  */
 package com.diffplug.spotless.maven.yaml;
 
-import java.util.Collections;
 import java.util.Set;
 
+import com.diffplug.common.collect.Sets;
 import com.diffplug.spotless.maven.FormatterFactory;
 
 /**
@@ -26,7 +26,7 @@
 public class Yaml extends FormatterFactory {
 	@Override
 	public Set<String> defaultIncludes() {
-		return Collections.emptySet();
+		return Sets.newHashSet("**/*.yaml", "**/*.yml");
 	}
 
 	@Override

plugin-maven/src/test/java/com/diffplug/spotless/maven/MavenIntegrationHarness.java

@@ -160,6 +160,10 @@ protected void writePomWithJsonSteps(String... steps) throws IOException {
 		writePom(groupWithSteps("json", including("**/*.json"), steps));
 	}
 
+	protected void writePomWithYamlSteps(String... steps) throws IOException {
+		writePom(groupWithSteps("yaml", steps));
+	}
+
 	protected void writePom(String... configuration) throws IOException {
 		writePom(null, configuration, null);
 	}

plugin-maven/src/test/java/com/diffplug/spotless/maven/yaml/YamlTest.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2023 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.spotless.maven.yaml;
+
+import org.junit.jupiter.api.Test;
+
+import com.diffplug.spotless.maven.MavenIntegrationHarness;
+
+public class YamlTest extends MavenIntegrationHarness {
+	@Test
+	public void testFormatJson_WithSimple_defaultConfig() throws Exception {
+		writePomWithJsonSteps("<yaml><jackson/></yaml>");
+
+		setFile("yaml_test.json").toResource("yaml/separator_comments.yaml");
+		mavenRunner().withArguments("spotless:apply").runNoError().error();
+		assertFile("yaml_test.json").sameAsResource("yaml/separator_comments.clean.yaml");
+	}
+}