Merge branch 'main' into announce-intellij-plugin

Author: nedtwigg

.editorconfig

@@ -16,3 +16,6 @@ indent_size = 2
 # Doc: https://youtrack.jetbrains.com/issue/IDEA-170643#focus=streamItem-27-3708697.0-0
 ij_java_imports_layout = java.**,|,javax.**,|,org.**,|,com.**,|,com.diffplug.**,|,*
 ij_java_use_single_class_imports = true
+
+[*.xml.mustache]
+indent_style = space

CHANGES.md

@@ -10,6 +10,12 @@ This document is intended for Spotless developers.
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+
+## [2.21.2] - 2022-01-07
+### Fixed
+* Update IndentStep to allow leading space on multiline comments ([#1072](https://github.com/diffplug/spotless/pull/1072)).
+
+## [2.21.1] - 2022-01-06
 ### Changed
 * Bumped default DiKTat from `0.4.0` to `1.0.1`. This is a breaking change for DiKTat users on the default version, because some rules were renamed/changed. Check [DiKTat changelog](https://github.com/analysis-dev/diktat/releases) for details.
 

PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,5 @@
+Please **DO NOT FORCE PUSH**. Don't worry about messy history, it's easier to do code review if we can tell what happened after the review, and force pushing breaks that.
+
 Please make sure that your [PR allows edits from maintainers](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/).  Sometimes its faster for us to just fix something than it is to describe how to fix it.
 
 ![Allow edits from maintainers](https://help.github.com/assets/images/help/pull_requests/allow-maintainers-to-make-edits-sidebar-checkbox.png)

lib/src/main/java/com/diffplug/spotless/generic/IndentStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 DiffPlug
+ * Copyright 2016-2022 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -100,6 +100,9 @@ String format(String raw) {
 					++contentStart;
 				}
 
+				// detect potential multi-line comments
+				boolean mightBeMultiLineComment = (contentStart < raw.length()) && (raw.charAt(contentStart) == '*');
+
 				// add the leading space in a canonical way
 				if (numSpaces > 0) {
 					switch (state.type) {
@@ -112,6 +115,9 @@ String format(String raw) {
 						for (int i = 0; i < numSpaces / state.numSpacesPerTab; ++i) {
 							builder.append('\t');
 						}
+						if (mightBeMultiLineComment && (numSpaces % state.numSpacesPerTab == 1)) {
+							builder.append(' ');
+						}
 						break;
 					default:
 						throw new IllegalArgumentException("Unexpected enum " + state.type);

plugin-gradle/CHANGES.md

@@ -6,6 +6,11 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ### Added
 * 🎉🎉🎉 [**IntelliJ plugin**](https://plugins.jetbrains.com/plugin/18321-spotless-gradle) thanks to [@ragurney](https://github.com/ragurney) 🎉🎉🎉
 
+## [6.1.2] - 2022-01-07
+### Fixed
+* Update IndentStep to allow leading space on multiline comments ([#1072](https://github.com/diffplug/spotless/pull/1072)).
+
+## [6.1.1] - 2022-01-06
 ### Fixed
 * If the `base` plugin has already been applied, then there is no need for configuration of the `clean` task to trigger configuration of the Spotless tasks ([#1068](https://github.com/diffplug/spotless/pull/1068)).
 ### Changed

plugin-gradle/README.md

@@ -3,6 +3,18 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+
+## [2.19.2] - 2022-01-10
+### Fixed
+* Enabling the upToDateChecking with the plugin configured inside pluginManagement, with an additional dependency and running under Maven 3.6.3 leads to a java.io.NotSerializableException. ([#1074](https://github.com/diffplug/spotless/pull/1074)).
+
+## [2.19.1] - 2022-01-07
+### Fixed
+* Update IndentStep to allow leading space on multiline comments ([#1072](https://github.com/diffplug/spotless/pull/1072)).
+
+## [2.19.0] - 2022-01-06
+### Added
+* Support custom index files for incremental up-to-date checking ([#1055](https://github.com/diffplug/spotless/pull/1055)).
 ### Fixed
 * Remove Java files from default Maven Groovy formatting ([#1051](https://github.com/diffplug/spotless/pull/1051)).
   * Before this release, the default target of groovy was

plugin-maven/CHANGES.md

@@ -12,8 +12,8 @@ output = [
   ].join('\n');
 -->
 [![Maven central](https://img.shields.io/badge/mavencentral-com.diffplug.spotless%3Aspotless--maven--plugin-blue.svg)](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.diffplug.spotless%22%20AND%20a%3A%22spotless-maven-plugin%22)
-[![Javadoc](https://img.shields.io/badge/javadoc-yes-blue.svg)](https://javadoc.io/doc/com.diffplug.spotless/spotless-maven-plugin/2.18.0/index.html)
-[![Changelog](https://img.shields.io/badge/changelog-2.18.0-brightgreen.svg)](CHANGES.md)
+[![Javadoc](https://img.shields.io/badge/javadoc-yes-blue.svg)](https://javadoc.io/doc/com.diffplug.spotless/spotless-maven-plugin/2.19.2/index.html)
+[![Changelog](https://img.shields.io/badge/changelog-2.19.2-brightgreen.svg)](CHANGES.md)
 
 [![Circle CI](https://circleci.com/gh/diffplug/spotless/tree/main.svg?style=shield)](https://circleci.com/gh/diffplug/spotless/tree/main)
 [![Live chat](https://img.shields.io/badge/gitter-chat-brightgreen.svg)](https://gitter.im/diffplug/spotless)
@@ -181,9 +181,8 @@ any other maven phase (i.e. compile) then it can be configured as below;
     <importOrder /> <!-- standard import order -->
     <importOrder>  <!-- or a custom ordering -->
       <wildcardsLast>false</wildcardsLast> <!-- Optional, default false. Sort wildcard import after specific imports -->
-      <order>java,javax,org,com,com.diffplug,</order>  <!-- or use <file>${project.basedir}/eclipse.importorder</file> -->
-      <!-- You probably want an empty string at the end - all of the
-           imports you didn't specify explicitly will go there. -->
+      <order>java,javax,org,com,com.diffplug,,\\#com.diffplug,\\#</order>  <!-- or use <file>${project.basedir}/eclipse.importorder</file> -->
+      <!-- you can use an empty string for all the imports you didn't specify explicitly, and '\\#` prefix for static imports. -->
     </importOrder>
 
     <removeUnusedImports /> <!-- self-explanatory -->
@@ -250,10 +249,8 @@ This is a workaround to a [pending issue](https://github.com/diffplug/spotless/i
 
     <importOrder /> <!-- standard import order -->
     <importOrder>  <!-- or a custom ordering -->
-      <order>java,javax,org,com,com.diffplug,</order>  <!-- or use <file>
-/eclipse.importorder</file> -->
-      <!-- You probably want an empty string at the end - all of the
-           imports you didn't specify explicitly will go there. -->
+      <order>java,javax,org,com,com.diffplug,,\\#com.diffplug,\\#</order>  <!-- or use <file>${project.basedir}/eclipse.importorder</file> -->
+      <!-- you can use an empty string for all the imports you didn't specify explicitly, and '\\#` prefix for static imports -->
     </importOrder>
 
     <greclipse />          <!-- has its own section below -->
@@ -936,6 +933,7 @@ enable incremental up-to-date checking with the following configuration:
 <configuration>
   <upToDateChecking>
     <enabled>true</enabled>
+    <indexFile>${project.basedir}/custom-index-file</indexFile> <!-- optional, default is ${project.build.directory}/spotless-index -->
   </upToDateChecking>
   <!-- ... define formats ... -->
 </configuration>
@@ -946,7 +944,7 @@ The index file contains source file paths and corresponding last modified timest
 It allows Spotless to skip already formatted files that have not changed.
 
 **Note:** the index file is located in the `target` directory. Executing `mvn clean` will delete
-the index file, and Spotless will need to check/format all the source files.
+the index file, and Spotless will need to check/format all the source files. You can override the default index file location with the `indexFile` configuration parameter.
 
 Spotless will remove the index file when up-to-date checking is explicitly turned off with the
 following configuration:
@@ -955,6 +953,7 @@ following configuration:
 <configuration>
   <upToDateChecking>
     <enabled>false</enabled>
+    <indexFile>${project.basedir}/custom-index-file</indexFile> <!-- optional, default is ${project.build.directory}/spotless-index -->
   </upToDateChecking>
   <!-- ... define formats ... -->
 </configuration>

plugin-maven/README.md

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 DiffPlug
+ * Copyright 2016-2022 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -71,7 +72,7 @@
 import com.diffplug.spotless.maven.typescript.Typescript;
 
 public abstract class AbstractSpotlessMojo extends AbstractMojo {
-
+	private static final String DEFAULT_INDEX_FILE_NAME = "spotless-index";
 	private static final String DEFAULT_ENCODING = "UTF-8";
 	private static final String DEFAULT_LINE_ENDINGS = "GIT_ATTRIBUTES";
 	static final String GOAL_CHECK = "check";
@@ -324,10 +325,15 @@ private List<FormatterStepFactory> getFormatterStepFactories() {
 	}
 
 	private UpToDateChecker createUpToDateChecker(Iterable<Formatter> formatters) {
+		Path indexFile = upToDateChecking == null ? null : upToDateChecking.getIndexFile();
+		if (indexFile == null) {
+			Path targetDir = project.getBasedir().toPath().resolve(project.getBuild().getDirectory());
+			indexFile = targetDir.resolve(DEFAULT_INDEX_FILE_NAME);
+		}
 		if (upToDateChecking != null && upToDateChecking.isEnabled()) {
 			getLog().info("Up-to-date checking enabled");
-			return UpToDateChecker.forProject(project, formatters, getLog());
+			return UpToDateChecker.forProject(project, indexFile, formatters, getLog());
 		}
-		return UpToDateChecker.noop(project, getLog());
+		return UpToDateChecker.noop(project, indexFile, getLog());
 	}
 }

plugin-maven/src/main/java/com/diffplug/spotless/maven/AbstractSpotlessMojo.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 DiffPlug
+ * Copyright 2021-2022 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,18 +20,17 @@
 import org.apache.maven.project.MavenProject;
 
 class FileIndexConfig {
-
-	private static final String INDEX_FILE_NAME = "spotless-index";
-
 	private final MavenProject project;
 	private final PluginFingerprint pluginFingerprint;
+	private final Path indexFile;
 
-	FileIndexConfig(MavenProject project) {
-		this(project, PluginFingerprint.empty());
+	FileIndexConfig(MavenProject project, Path indexFile) {
+		this(project, indexFile, PluginFingerprint.empty());
 	}
 
-	FileIndexConfig(MavenProject project, PluginFingerprint pluginFingerprint) {
+	FileIndexConfig(MavenProject project, Path indexFile, PluginFingerprint pluginFingerprint) {
 		this.project = project;
+		this.indexFile = indexFile;
 		this.pluginFingerprint = pluginFingerprint;
 	}
 
@@ -40,8 +39,7 @@ Path getProjectDir() {
 	}
 
 	Path getIndexFile() {
-		Path targetDir = getProjectDir().resolve(project.getBuild().getDirectory());
-		return targetDir.resolve(INDEX_FILE_NAME);
+		return indexFile;
 	}
 
 	PluginFingerprint getPluginFingerprint() {