eslint: add unit tests, cleanup code

Author: simschla

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

@@ -18,12 +18,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.Serializable;
-import java.util.Collections;
-import java.util.Map;
-import java.util.Optional;
-import java.util.TreeMap;
 
-import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
 import com.diffplug.spotless.FileSignature;
@@ -44,23 +39,20 @@ public class EslintConfig implements Serializable {
 
 	private final String eslintConfigJs;
 
-	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
-	private final transient Map<File, Optional<String>> additionalConfigFiles; // key: source-file, value: target-remapping path relative to package.json (if needed)
-
-	private final FileSignature additionalConfigFilesSignature;
-
-	public EslintConfig(@Nullable File eslintConfigPath, @Nullable String eslintConfigJs, Map<File, Optional<String>> additionalConfigFiles) {
+	public EslintConfig(@Nullable File eslintConfigPath, @Nullable String eslintConfigJs) {
 		try {
 			this.eslintConfigPath = eslintConfigPath;
 			this.eslintConfigPathSignature = eslintConfigPath != null ? FileSignature.signAsList(this.eslintConfigPath) : FileSignature.signAsList();
 			this.eslintConfigJs = eslintConfigJs;
-			this.additionalConfigFiles = additionalConfigFiles != null ? new TreeMap<>(additionalConfigFiles) : Collections.emptyMap();
-			this.additionalConfigFilesSignature = FileSignature.signAsList(this.additionalConfigFiles.keySet().toArray(new File[0]));
 		} catch (IOException e) {
 			throw ThrowingEx.asRuntime(e);
 		}
 	}
 
+	public EslintConfig withEslintConfigPath(@Nullable File eslintConfigPath) {
+		return new EslintConfig(eslintConfigPath, this.eslintConfigJs);
+	}
+
 	@Nullable
 	public File getEslintConfigPath() {
 		return eslintConfigPath;
@@ -70,9 +62,4 @@ public File getEslintConfigPath() {
 	public String getEslintConfigJs() {
 		return eslintConfigJs;
 	}
-
-	@Nonnull
-	public Map<File, Optional<String>> getAdditionalConfigFiles() {
-		return additionalConfigFiles;
-	}
 }

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

@@ -25,7 +25,6 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Objects;
-import java.util.Optional;
 import java.util.TreeMap;
 
 import javax.annotation.Nonnull;
@@ -152,17 +151,7 @@ private EslintConfig localCopyFiles(EslintConfig orig) {
 			// eslint configs contain relative paths to additional config files (such as tsconfig.json e.g.)
 			FormattedPrinter.SYSOUT.print("Copying config file <%s> to <%s> and using the copy", orig.getEslintConfigPath(), nodeModulesDir);
 			File configFileCopy = NpmResourceHelper.copyFileToDir(orig.getEslintConfigPath(), nodeModulesDir);
-
-			for (Map.Entry<File, Optional<String>> additionalConfigFile : orig.getAdditionalConfigFiles().entrySet()) {
-				FormattedPrinter.SYSOUT.print("Copying additional config file <%s> to <%s> at subpath <%s> and using the copy", additionalConfigFile.getKey(), nodeModulesDir, additionalConfigFile.getValue());
-
-				if (additionalConfigFile.getValue().isPresent()) {
-					NpmResourceHelper.copyFileToDirAtSubpath(additionalConfigFile.getKey(), nodeModulesDir, additionalConfigFile.getValue().get());
-				} else {
-					NpmResourceHelper.copyFileToDir(additionalConfigFile.getKey(), nodeModulesDir);
-				}
-			}
-			return new EslintConfig(configFileCopy, orig.getEslintConfigJs(), orig.getAdditionalConfigFiles());
+			return orig.withEslintConfigPath(configFileCopy);
 		}
 
 		@Override
@@ -226,8 +215,12 @@ private void setConfigToCallOptions(Map<FormatOption, Object> eslintCallOptions)
 			}
 			eslintCallOptions.put(FormatOption.NODE_MODULES_DIR, nodeModulesDir.getAbsolutePath());
 
-			// TODO (simschla, 09.12.22): maybe only add this if there is a typescript config active? (TBD: how to detect)
-			eslintCallOptions.put(FormatOption.TS_CONFIG_ROOT_DIR, nodeModulesDir.toPath().relativize(projectDir.toPath()).toString());
+			if (eslintConfig instanceof EslintTypescriptConfig) {
+				// if we are a ts config, see if we need to use specific paths or use default projectDir
+				File tsConfigFilePath = ((EslintTypescriptConfig) eslintConfig).getTypescriptConfigPath();
+				File tsConfigRootDir = tsConfigFilePath != null ? tsConfigFilePath.getParentFile() : projectDir;
+				eslintCallOptions.put(FormatOption.TS_CONFIG_ROOT_DIR, nodeModulesDir.getAbsoluteFile().toPath().relativize(tsConfigRootDir.getAbsoluteFile().toPath()).toString());
+			}
 		}
 	}
 }

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

@@ -0,0 +1,41 @@
+package com.diffplug.spotless.npm;
+
+import com.diffplug.spotless.FileSignature;
+import com.diffplug.spotless.ThrowingEx;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+import javax.annotation.Nullable;
+
+import java.io.File;
+import java.io.IOException;
+
+public class EslintTypescriptConfig extends EslintConfig {
+
+	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
+	@Nullable
+	private final transient File typescriptConfigPath;
+
+	@SuppressWarnings("unused")
+	private final FileSignature typescriptConfigPathSignature;
+
+	public EslintTypescriptConfig(@Nullable File eslintConfigPath, @Nullable String eslintConfigJs, @Nullable File typescriptConfigPath) {
+		super(eslintConfigPath, eslintConfigJs);
+		try {
+			this.typescriptConfigPath = typescriptConfigPath;
+			this.typescriptConfigPathSignature = typescriptConfigPath != null ? FileSignature.signAsList(this.typescriptConfigPath) : FileSignature.signAsList();
+		} catch (IOException e) {
+			throw ThrowingEx.asRuntime(e);
+		}
+	}
+
+	@Override
+	public EslintConfig withEslintConfigPath(@Nullable File eslintConfigPath) {
+		return new EslintTypescriptConfig(eslintConfigPath, this.getEslintConfigJs(), this.typescriptConfigPath);
+	}
+
+	@Nullable
+	public File getTypescriptConfigPath() {
+		return typescriptConfigPath;
+	}
+}

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/FormatExtension.java

@@ -621,8 +621,6 @@ public class EslintFormatExtension extends NpmStepConfig<EslintFormatExtension>
 		@Nullable
 		String configJs = null;
 
-		List<AdditionalEslintConfig> additionalConfigs = new ArrayList<>();
-
 		public EslintFormatExtension(Map<String, String> devDependencies) {
 			this.devDependencies.putAll(requireNonNull(devDependencies));
 		}
@@ -645,10 +643,6 @@ public EslintFormatExtension configFile(Object configFilePath) {
 			return this;
 		}
 
-		protected void additionalConfigFilePath(Object sourceFile, String relativeTargetPath) {
-			this.additionalConfigs.add(new AdditionalEslintConfig(sourceFile, relativeTargetPath));
-		}
-
 		public FormatterStep createStep() {
 			final Project project = getProject();
 
@@ -661,28 +655,8 @@ public FormatterStep createStep() {
 					eslintConfig());
 		}
 
-		private EslintConfig eslintConfig() {
-			return new EslintConfig(configFilePath != null ? getProject().file(configFilePath) : null, configJs, additionalConfigs());
-		}
-
-		private Map<File, Optional<String>> additionalConfigs() {
-			// convert additionalConfigs to a map explicitly allowing null values
-
-			return additionalConfigs.stream()
-					.collect(Collectors.toMap(
-							config -> getProject().file(config.configFilePath),
-							config -> Optional.ofNullable(config.relativeTargetPath)));
-		}
-	}
-
-	private static class AdditionalEslintConfig {
-		final Object configFilePath;
-
-		final String relativeTargetPath;
-
-		AdditionalEslintConfig(Object configFilePath, String relativeTargetPath) {
-			this.configFilePath = configFilePath;
-			this.relativeTargetPath = relativeTargetPath;
+		protected EslintConfig eslintConfig() {
+			return new EslintConfig(configFilePath != null ? getProject().file(configFilePath) : null, configJs);
 		}
 	}
 

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/TypescriptExtension.java

@@ -27,6 +27,10 @@
 import javax.annotation.Nullable;
 import javax.inject.Inject;
 
+import com.diffplug.spotless.npm.EslintConfig;
+
+import com.diffplug.spotless.npm.EslintTypescriptConfig;
+
 import org.gradle.api.Project;
 
 import com.diffplug.spotless.FormatterStep;
@@ -193,6 +197,9 @@ public TypescriptEslintFormatExtension eslint(Map<String, String> devDependencie
 
 	public class TypescriptEslintFormatExtension extends EslintFormatExtension {
 
+		@Nullable
+		Object typescriptConfigFilePath = null;
+
 		public TypescriptEslintFormatExtension(Map<String, String> devDependencies) {
 			super(devDependencies);
 		}
@@ -224,14 +231,16 @@ public TypescriptEslintFormatExtension styleGuide(String styleGuide) {
 		}
 
 		public TypescriptEslintFormatExtension tsconfigFile(Object path) {
-			return tsconfigFile(path, null);
-		}
-
-		public TypescriptEslintFormatExtension tsconfigFile(Object path, String remapping) {
-			additionalConfigFilePath(path, remapping);
+			this.typescriptConfigFilePath = requireNonNull(path);
 			replaceStep(createStep());
 			return this;
 		}
+
+		@Override
+		protected EslintConfig eslintConfig() {
+			EslintConfig config = super.eslintConfig();
+			return new EslintTypescriptConfig(config.getEslintConfigPath(), config.getEslintConfigJs(), typescriptConfigFilePath != null ? getProject().file(typescriptConfigFilePath) : null);
+		}
 	}
 
 	@Override

testlib/src/main/java/com/diffplug/spotless/ResourceHarness.java

@@ -27,6 +27,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Optional;
 import java.util.function.Consumer;
 import java.util.function.UnaryOperator;
 
@@ -86,11 +87,20 @@ protected void replace(String path, String toReplace, String replaceWith) throws
 
 	/** Returns the contents of the given file from the src/test/resources directory. */
 	protected static String getTestResource(String filename) {
-		URL url = ResourceHarness.class.getResource("/" + filename);
-		if (url == null) {
-			throw new IllegalArgumentException("No such resource " + filename);
+		Optional<URL> resourceUrl = getTestResourceUrl(filename);
+		if (resourceUrl.isPresent()) {
+			return ThrowingEx.get(() -> LineEnding.toUnix(Resources.toString(resourceUrl.get(), StandardCharsets.UTF_8)));
 		}
-		return ThrowingEx.get(() -> LineEnding.toUnix(Resources.toString(url, StandardCharsets.UTF_8)));
+		throw new IllegalArgumentException("No such resource " + filename);
+	}
+
+	protected static boolean existsTestResource(String filename) {
+		return getTestResourceUrl(filename).isPresent();
+	}
+
+	private static Optional<URL> getTestResourceUrl(String filename) {
+		URL url = ResourceHarness.class.getResource("/" + filename);
+		return Optional.ofNullable(url);
 	}
 
 	/** Returns Files (in a temporary folder) which has the contents of the given file from the src/test/resources directory. */