Merge branch 'main' into config_cache

Author: nedtwigg

CHANGES.md

@@ -11,6 +11,17 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 
 ## [Unreleased]
 
+## [2.36.0] - 2023-02-27
+### Added
+* `gradlew equoIde` opens a repeatable clean Spotless dev environment. ([#1523](https://github.com/diffplug/spotless/pull/1523))
+* `cleanthat` added `includeDraft` option, to include draft mutators from composite mutators. ([#1574](https://github.com/diffplug/spotless/pull/1574))
+* `npm`-based formatters now support caching of `node_modules` directory ([#1590](https://github.com/diffplug/spotless/pull/1590))
+### Fixed
+* `JacksonJsonFormatterFunc` handles json files with an Array as root. ([#1585](https://github.com/diffplug/spotless/pull/1585))
+### Changes
+* Bump default `cleanthat` version to latest `2.1` -> `2.6` ([#1569](https://github.com/diffplug/spotless/pull/1569) and [#1574](https://github.com/diffplug/spotless/pull/1574))
+* Reduce logging-noise created by `npm`-based formatters ([#1590](https://github.com/diffplug/spotless/pull/1590) fixes [#1582](https://github.com/diffplug/spotless/issues/1582))
+
 ## [2.35.0] - 2023-02-10
 ### Added
 * CleanThat Java Refactorer. ([#1560](https://github.com/diffplug/spotless/pull/1560))

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to Spotless
 
-Pull requests are welcome, preferably against `main`.  Feel free to develop spotless any way you like.
+Pull requests are welcome, preferably against `main`.  Feel free to develop spotless any way you like, but if you like Eclipse and Gradle Buildship then [`gradlew equoIde` will install an IDE and set it up for you](https://github.com/equodev/equo-ide).
 
 ## How Spotless works
 

build.gradle

@@ -1,3 +1,17 @@
+plugins {
+	// https://github.com/equodev/equo-ide/blob/main/plugin-gradle/CHANGELOG.md
+	id 'dev.equo.ide'                          version '0.16.0'
+}
+equoIde {
+	branding().title('Spotless').icon(file('_images/spotless_logo.png'))
+	welcome().openUrl('https://github.com/diffplug/spotless/blob/main/CONTRIBUTING.md')
+	gradleBuildship()
+}
+
+repositories {
+	mavenCentral()
+}
+
 apply from: rootProject.file('gradle/java-publish.gradle')
 apply from: rootProject.file('gradle/changelog.gradle')
 allprojects {

lib/build.gradle

@@ -56,6 +56,8 @@ tasks.named("check").configure {
 
 dependencies {
 	compileOnly 'org.slf4j:slf4j-api:2.0.0'
+	testCommonImplementation 'org.slf4j:slf4j-api:2.0.0'
+
 	// zero runtime reqs is a hard requirements for spotless-lib
 	// if you need a dep, put it in lib-extra
 	testCommonImplementation "org.junit.jupiter:junit-jupiter:$VER_JUNIT"

lib/src/jackson/java/com/diffplug/spotless/glue/json/AJacksonFormatterFunc.java

@@ -16,7 +16,6 @@
 package com.diffplug.spotless.glue.json;
 
 import java.io.IOException;
-import java.util.Map;
 
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -49,7 +48,7 @@ public String apply(String input) throws Exception {
 	protected String format(ObjectMapper objectMapper, String input) throws IllegalArgumentException, IOException {
 		try {
 			// ObjectNode is not compatible with SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS
-			Map objectNode = objectMapper.readValue(input, Map.class);
+			Object objectNode = objectMapper.readValue(input, inferType(input));
 			String output = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(objectNode);
 
 			return output;
@@ -58,6 +57,13 @@ protected String format(ObjectMapper objectMapper, String input) throws IllegalA
 		}
 	}
 
+	/**
+	 *
+	 * @param input
+	 * @return the {@link Class} into which the String has to be deserialized
+	 */
+	protected abstract Class<?> inferType(String input);
+
 	/**
 	 * @return a {@link JsonFactory}. May be overridden to handle alternative formats.
 	 * @see <a href="https://github.com/FasterXML/jackson-dataformats-text">jackson-dataformats-text</a>

lib/src/jackson/java/com/diffplug/spotless/glue/json/JacksonJsonFormatterFunc.java

@@ -15,6 +15,9 @@
  */
 package com.diffplug.spotless.glue.json;
 
+import java.util.Collection;
+import java.util.Map;
+
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.core.JsonFactoryBuilder;
 import com.fasterxml.jackson.core.JsonGenerator;
@@ -37,6 +40,15 @@ public JacksonJsonFormatterFunc(JacksonJsonConfig jacksonConfig) {
 		this.jacksonConfig = jacksonConfig;
 	}
 
+	@Override
+	protected Class<?> inferType(String input) {
+		if (input.trim().startsWith("[")) {
+			return Collection.class;
+		} else {
+			return Map.class;
+		}
+	}
+
 	/**
 	 * @return a {@link JsonFactory}. May be overridden to handle alternative formats.
 	 * @see <a href="https://github.com/FasterXML/jackson-dataformats-text">jackson-dataformats-text</a>

lib/src/jackson/java/com/diffplug/spotless/glue/yaml/JacksonYamlFormatterFunc.java

@@ -58,13 +58,18 @@ protected JsonFactory makeJsonFactory() {
 		return yamlFactoryBuilder.build();
 	}
 
+	@Override
+	protected Class<?> inferType(String input) {
+		return JsonNode.class;
+	}
+
 	@Override
 	protected String format(ObjectMapper objectMapper, String input) throws IllegalArgumentException, IOException {
 		try {
 			// https://stackoverflow.com/questions/25222327/deserialize-pojos-from-multiple-yaml-documents-in-a-single-file-in-jackson
 			// https://github.com/FasterXML/jackson-dataformats-text/issues/66#issuecomment-375328648
 			JsonParser yamlParser = objectMapper.getFactory().createParser(input);
-			List<JsonNode> documents = objectMapper.readValues(yamlParser, JsonNode.class).readAll();
+			List<?> documents = objectMapper.readValues(yamlParser, inferType(input)).readAll();
 
 			// https://github.com/FasterXML/jackson-dataformats-text/issues/66#issuecomment-554265055
 			// https://github.com/FasterXML/jackson-dataformats-text/issues/66#issuecomment-554265055

lib/src/main/java/com/diffplug/spotless/json/package-info.java

@@ -1,6 +1,6 @@
 @ParametersAreNonnullByDefault
 @ReturnValuesAreNonnullByDefault
-package com.diffplug.spotless.extra.json.java;
+package com.diffplug.spotless.json;
 
 import javax.annotation.ParametersAreNonnullByDefault;
 

lib/src/main/java/com/diffplug/spotless/npm/EslintFormatterStep.java

@@ -15,7 +15,6 @@
  */
 package com.diffplug.spotless.npm;
 
-import static com.diffplug.spotless.LazyArgLogger.lazy;
 import static java.util.Objects.requireNonNull;
 
 import java.io.File;
@@ -71,13 +70,13 @@ public static Map<String, String> defaultDevDependenciesWithEslint(String versio
 		return Collections.singletonMap("eslint", version);
 	}
 
-	public static FormatterStep create(Map<String, String> devDependencies, Provisioner provisioner, File projectDir, File buildDir, NpmPathResolver npmPathResolver, EslintConfig eslintConfig) {
+	public static FormatterStep create(Map<String, String> devDependencies, Provisioner provisioner, File projectDir, File buildDir, File cacheDir, NpmPathResolver npmPathResolver, EslintConfig eslintConfig) {
 		requireNonNull(devDependencies);
 		requireNonNull(provisioner);
 		requireNonNull(projectDir);
 		requireNonNull(buildDir);
 		return FormatterStep.createLazy(NAME,
-				() -> new State(NAME, devDependencies, projectDir, buildDir, npmPathResolver, eslintConfig),
+				() -> new State(NAME, devDependencies, projectDir, buildDir, cacheDir, npmPathResolver, eslintConfig),
 				State::createFormatterFunc);
 	}
 
@@ -89,20 +88,20 @@ private static class State extends NpmFormatterStepStateBase implements Serializ
 		@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
 		private transient EslintConfig eslintConfigInUse;
 
-		State(String stepName, Map<String, String> devDependencies, File projectDir, File buildDir, NpmPathResolver npmPathResolver, EslintConfig eslintConfig) throws IOException {
+		State(String stepName, Map<String, String> devDependencies, File projectDir, File buildDir, File cacheDir, NpmPathResolver npmPathResolver, EslintConfig eslintConfig) throws IOException {
 			super(stepName,
 					new NpmConfig(
 							replaceDevDependencies(
 									NpmResourceHelper.readUtf8StringFromClasspath(EslintFormatterStep.class, "/com/diffplug/spotless/npm/eslint-package.json"),
 									new TreeMap<>(devDependencies)),
-							"eslint",
 							NpmResourceHelper.readUtf8StringFromClasspath(EslintFormatterStep.class,
 									"/com/diffplug/spotless/npm/common-serve.js",
 									"/com/diffplug/spotless/npm/eslint-serve.js"),
 							npmPathResolver.resolveNpmrcContent()),
 					new NpmFormatterStepLocations(
 							projectDir,
 							buildDir,
+							cacheDir,
 							npmPathResolver::resolveNpmExecutable,
 							npmPathResolver::resolveNodeExecutable));
 			this.origEslintConfig = requireNonNull(eslintConfig.verify());
@@ -116,7 +115,7 @@ protected void prepareNodeServerLayout() throws IOException {
 				// If any config files are provided, we need to make sure they are at the same location as the node modules
 				// as eslint will try to resolve plugin/config names relatively to the config file location and some
 				// eslint configs contain relative paths to additional config files (such as tsconfig.json e.g.)
-				logger.info("Copying config file <{}> to <{}> and using the copy", origEslintConfig.getEslintConfigPath(), nodeServerLayout.nodeModulesDir());
+				logger.debug("Copying config file <{}> to <{}> and using the copy", origEslintConfig.getEslintConfigPath(), nodeServerLayout.nodeModulesDir());
 				File configFileCopy = NpmResourceHelper.copyFileToDir(origEslintConfig.getEslintConfigPath(), nodeServerLayout.nodeModulesDir());
 				this.eslintConfigInUse = this.origEslintConfig.withEslintConfigPath(configFileCopy).verify();
 			}
@@ -162,8 +161,6 @@ public EslintFilePathPassingFormatterFunc(File projectDir, File nodeModulesDir,
 
 		@Override
 		public String applyWithFile(String unix, File file) throws Exception {
-			logger.info("formatting String '{}[...]' in file '{}'", lazy(() -> unix.substring(0, Math.min(50, unix.length()))), file);
-
 			Map<FormatOption, Object> eslintCallOptions = new HashMap<>();
 			setConfigToCallOptions(eslintCallOptions);
 			setFilePathToCallOptions(eslintCallOptions, file);

lib/src/main/java/com/diffplug/spotless/npm/NodeApp.java

@@ -0,0 +1,88 @@
+/*
+ * 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.npm;
+
+import java.util.Objects;
+
+import javax.annotation.Nonnull;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class NodeApp {
+
+	private static final Logger logger = LoggerFactory.getLogger(NodeApp.class);
+
+	private static final TimedLogger timedLogger = TimedLogger.forLogger(logger);
+
+	@Nonnull
+	protected final NodeServerLayout nodeServerLayout;
+
+	@Nonnull
+	protected final NpmConfig npmConfig;
+
+	@Nonnull
+	protected final NpmProcessFactory npmProcessFactory;
+
+	@Nonnull
+	protected final NpmFormatterStepLocations formatterStepLocations;
+
+	public NodeApp(@Nonnull NodeServerLayout nodeServerLayout, @Nonnull NpmConfig npmConfig, @Nonnull NpmFormatterStepLocations formatterStepLocations) {
+		this.nodeServerLayout = Objects.requireNonNull(nodeServerLayout);
+		this.npmConfig = Objects.requireNonNull(npmConfig);
+		this.npmProcessFactory = processFactory(formatterStepLocations);
+		this.formatterStepLocations = Objects.requireNonNull(formatterStepLocations);
+	}
+
+	private static NpmProcessFactory processFactory(NpmFormatterStepLocations formatterStepLocations) {
+		if (formatterStepLocations.cacheDir() != null) {
+			logger.info("Caching npm install results in {}.", formatterStepLocations.cacheDir());
+			return NodeModulesCachingNpmProcessFactory.create(formatterStepLocations.cacheDir());
+		}
+		logger.debug("Not caching npm install results.");
+		return StandardNpmProcessFactory.INSTANCE;
+	}
+
+	boolean needsNpmInstall() {
+		return !this.nodeServerLayout.isNodeModulesPrepared();
+	}
+
+	boolean needsPrepareNodeAppLayout() {
+		return !this.nodeServerLayout.isLayoutPrepared();
+	}
+
+	void prepareNodeAppLayout() {
+		timedLogger.withInfo("Preparing {} for npm step {}.", this.nodeServerLayout, getClass().getName()).run(() -> {
+			NpmResourceHelper.assertDirectoryExists(nodeServerLayout.nodeModulesDir());
+			NpmResourceHelper.writeUtf8StringToFile(nodeServerLayout.packageJsonFile(), this.npmConfig.getPackageJsonContent());
+			if (this.npmConfig.getServeScriptContent() != null) {
+				NpmResourceHelper.writeUtf8StringToFile(nodeServerLayout.serveJsFile(), this.npmConfig.getServeScriptContent());
+			} else {
+				NpmResourceHelper.deleteFileIfExists(nodeServerLayout.serveJsFile());
+			}
+			if (this.npmConfig.getNpmrcContent() != null) {
+				NpmResourceHelper.writeUtf8StringToFile(nodeServerLayout.npmrcFile(), this.npmConfig.getNpmrcContent());
+			} else {
+				NpmResourceHelper.deleteFileIfExists(nodeServerLayout.npmrcFile());
+			}
+		});
+	}
+
+	void npmInstall() {
+		timedLogger.withInfo("Installing npm dependencies for {} with {}.", this.nodeServerLayout, this.npmProcessFactory.describe())
+				.run(() -> npmProcessFactory.createNpmInstallProcess(nodeServerLayout, formatterStepLocations).waitFor());
+	}
+}