eslint: extract base properties

to a common base class

Author: simschla

plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/Prettier.java

@@ -23,12 +23,12 @@
 
 import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.maven.FormatterStepConfig;
-import com.diffplug.spotless.maven.FormatterStepFactory;
+import com.diffplug.spotless.maven.npm.AbstractNpmFormatterStepFactory;
 import com.diffplug.spotless.npm.NpmPathResolver;
 import com.diffplug.spotless.npm.PrettierConfig;
 import com.diffplug.spotless.npm.PrettierFormatterStep;
 
-public class Prettier implements FormatterStepFactory {
+public class Prettier extends AbstractNpmFormatterStepFactory {
 
 	public static final String ERROR_MESSAGE_ONLY_ONE_CONFIG = "must specify exactly one prettierVersion, devDependencies or devDependencyProperties";
 
@@ -47,12 +47,6 @@ public class Prettier implements FormatterStepFactory {
 	@Parameter
 	private String configFile;
 
-	@Parameter
-	private String npmExecutable;
-
-	@Parameter
-	private String npmrc;
-
 	@Override
 	public FormatterStep newFormatterStep(FormatterStepConfig stepConfig) {
 
@@ -70,10 +64,6 @@ public FormatterStep newFormatterStep(FormatterStepConfig stepConfig) {
 			this.devDependencies = dependencyPropertiesAsMap();
 		}
 
-		File npm = npmExecutable != null ? stepConfig.getFileLocator().locateFile(npmExecutable) : null;
-
-		File npmrcFile = npmrc != null ? stepConfig.getFileLocator().locateFile(npmrc) : null;
-
 		// process config file or inline config
 		File configFileHandler;
 		if (this.configFile != null) {
@@ -103,10 +93,10 @@ public FormatterStep newFormatterStep(FormatterStepConfig stepConfig) {
 		}
 
 		// create the format step
+		File baseDir = baseDir(stepConfig);
+		File buildDir = buildDir(stepConfig);
 		PrettierConfig prettierConfig = new PrettierConfig(configFileHandler, configInline);
-		File buildDir = stepConfig.getFileLocator().getBuildDir();
-		File baseDir = stepConfig.getFileLocator().getBaseDir();
-		NpmPathResolver npmPathResolver = new NpmPathResolver(npm, npmrcFile, baseDir);
+		NpmPathResolver npmPathResolver = npmPathResolver(stepConfig);
 		return PrettierFormatterStep.create(devDependencies, stepConfig.getProvisioner(), baseDir, buildDir, npmPathResolver, prettierConfig);
 	}
 

plugin-maven/src/main/java/com/diffplug/spotless/maven/npm/AbstractNpmFormatterStepFactory.java

@@ -0,0 +1,55 @@
+/*
+ * 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.
+ * 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.npm;
+
+import java.io.File;
+
+import org.apache.maven.plugins.annotations.Parameter;
+
+import com.diffplug.spotless.maven.FormatterStepConfig;
+import com.diffplug.spotless.maven.FormatterStepFactory;
+import com.diffplug.spotless.npm.NpmPathResolver;
+
+public abstract class AbstractNpmFormatterStepFactory implements FormatterStepFactory {
+
+	@Parameter
+	private String npmExecutable;
+
+	@Parameter
+	private String npmrc;
+
+	protected File npm(FormatterStepConfig stepConfig) {
+		File npm = npmExecutable != null ? stepConfig.getFileLocator().locateFile(npmExecutable) : null;
+		return npm;
+	}
+
+	protected File npmrc(FormatterStepConfig stepConfig) {
+		File npmrc = this.npmrc != null ? stepConfig.getFileLocator().locateFile(this.npmrc) : null;
+		return npmrc;
+	}
+
+	protected File buildDir(FormatterStepConfig stepConfig) {
+		return stepConfig.getFileLocator().getBuildDir();
+	}
+
+	protected File baseDir(FormatterStepConfig stepConfig) {
+		return stepConfig.getFileLocator().getBaseDir();
+	}
+
+	protected NpmPathResolver npmPathResolver(FormatterStepConfig stepConfig) {
+		return new NpmPathResolver(npm(stepConfig), npmrc(stepConfig), baseDir(stepConfig));
+	}
+}

plugin-maven/src/main/java/com/diffplug/spotless/maven/typescript/Tsfmt.java

@@ -23,13 +23,13 @@
 
 import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.maven.FormatterStepConfig;
-import com.diffplug.spotless.maven.FormatterStepFactory;
+import com.diffplug.spotless.maven.npm.AbstractNpmFormatterStepFactory;
 import com.diffplug.spotless.npm.NpmPathResolver;
 import com.diffplug.spotless.npm.TsConfigFileType;
 import com.diffplug.spotless.npm.TsFmtFormatterStep;
 import com.diffplug.spotless.npm.TypedTsFmtConfigFile;
 
-public class Tsfmt implements FormatterStepFactory {
+public class Tsfmt extends AbstractNpmFormatterStepFactory {
 
 	@Parameter
 	private String tslintFile;
@@ -52,12 +52,6 @@ public class Tsfmt implements FormatterStepFactory {
 	@Parameter
 	private String tslintVersion;
 
-	@Parameter
-	private String npmExecutable;
-
-	@Parameter
-	private String npmrc;
-
 	@Parameter
 	private Map<String, String> config;
 
@@ -74,10 +68,6 @@ public FormatterStep newFormatterStep(FormatterStepConfig stepConfig) {
 			devDependencies.put("tslint", tslintVersion);
 		}
 
-		File npm = npmExecutable != null ? stepConfig.getFileLocator().locateFile(npmExecutable) : null;
-
-		File npmrcFile = npmrc != null ? stepConfig.getFileLocator().locateFile(npmrc) : null;
-
 		TypedTsFmtConfigFile configFile;
 		Map<String, Object> configInline;
 		// check that there is only 1 config file or inline config
@@ -119,9 +109,9 @@ public FormatterStep newFormatterStep(FormatterStepConfig stepConfig) {
 			throw onlyOneConfig();
 		}
 
-		File buildDir = stepConfig.getFileLocator().getBuildDir();
-		File baseDir = stepConfig.getFileLocator().getBaseDir();
-		NpmPathResolver npmPathResolver = new NpmPathResolver(npm, npmrcFile, baseDir);
+		File buildDir = buildDir(stepConfig);
+		File baseDir = baseDir(stepConfig);
+		NpmPathResolver npmPathResolver = npmPathResolver(stepConfig);
 		return TsFmtFormatterStep.create(devDependencies, stepConfig.getProvisioner(), baseDir, buildDir, npmPathResolver, configFile, configInline);
 	}