Tsfmt Maven Plugin for Spotless

CHANGES.md

@@ -10,6 +10,8 @@ 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]
+### Added
+* Tsfmt Maven Plugin ([#548](https://github.com/diffplug/spotless/pull/548))
 ### Fixed
 * Javadoc for the `ext/eclipse-*` projects.
 * Replace the deprecated `compile` with `implementation` for the `ext/eclipse-*` projects.

README.md

@@ -47,7 +47,7 @@ extra('java.EclipseFormatterStep')               +'{{yes}}       | {{yes}}
 lib('kotlin.KtLintStep')                         +'{{yes}}       | {{yes}}      | {{no}}  |',
 lib('markdown.FreshMarkStep')                    +'{{yes}}       | {{no}}       | {{no}}  |',
 lib('npm.PrettierFormatterStep')                 +'{{yes}}       | {{no}}       | {{no}}  |',
-lib('npm.TsFmtFormatterStep')                    +'{{yes}}       | {{no}}       | {{no}}  |',
+lib('npm.TsFmtFormatterStep')                    +'{{yes}}       | {{yes}}       | {{no}}  |',
 lib('scala.ScalaFmtStep')                        +'{{yes}}       | {{yes}}       | {{no}}  |',
 lib('sql.DBeaverSQLFormatterStep')               +'{{yes}}       | {{no}}       | {{no}}  |',
 extra('wtp.EclipseWtpFormatterStep')             +'{{yes}}       | {{yes}}      | {{no}}  |',
@@ -74,7 +74,7 @@ extra('wtp.EclipseWtpFormatterStep')             +'{{yes}}       | {{yes}}
 | [`kotlin.KtLintStep`](lib/src/main/java/com/diffplug/spotless/kotlin/KtLintStep.java) | :+1:       | :+1:      | :white_large_square:  |
 | [`markdown.FreshMarkStep`](lib/src/main/java/com/diffplug/spotless/markdown/FreshMarkStep.java) | :+1:       | :white_large_square:       | :white_large_square:  |
 | [`npm.PrettierFormatterStep`](lib/src/main/java/com/diffplug/spotless/npm/PrettierFormatterStep.java) | :+1:       | :white_large_square:       | :white_large_square:  |
-| [`npm.TsFmtFormatterStep`](lib/src/main/java/com/diffplug/spotless/npm/TsFmtFormatterStep.java) | :+1:       | :white_large_square:       | :white_large_square:  |
+| [`npm.TsFmtFormatterStep`](lib/src/main/java/com/diffplug/spotless/npm/TsFmtFormatterStep.java) | :+1:       | :+1:       | :white_large_square:  |
 | [`scala.ScalaFmtStep`](lib/src/main/java/com/diffplug/spotless/scala/ScalaFmtStep.java) | :+1:       | :+1:       | :white_large_square:  |
 | [`sql.DBeaverSQLFormatterStep`](lib/src/main/java/com/diffplug/spotless/sql/DBeaverSQLFormatterStep.java) | :+1:       | :white_large_square:       | :white_large_square:  |
 | [`wtp.EclipseWtpFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/wtp/EclipseWtpFormatterStep.java) | :+1:       | :+1:      | :white_large_square:  |

plugin-maven/CHANGES.md

@@ -3,6 +3,8 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+### Added
+* Tsfmt Maven Plugin ([#548](https://github.com/diffplug/spotless/pull/548))
 ### Fixed
 * Eclipse-WTP formatter (web tools platform, not java) handles some character encodings incorrectly on OS with non-unicode default file encoding [#545](https://github.com/diffplug/spotless/issues/545). Fixed for Eclipse-WTP formatter Eclipse version 4.13.0 (default version).
 

plugin-maven/README.md

@@ -193,6 +193,56 @@ By default, all files matching `src/main/cpp/**/*.<ext>` and `src/test/cpp/**/*.
 ```
 Use the Eclipse to define the *Code Style preferences* (see [Eclipse documentation](https://www.eclipse.org/documentation/)). Within the preferences *Edit...* dialog, you can export your configuration as XML file, which can be used as a configuration `<file>`. If no `<file>` is provided, the CDT default configuration is used.
 
+<a name="typescript"></a>
+
+## Applying to Typescript source
+
+```xml
+<configuration>
+  <typescript>
+     <tsfmt>
+       <!-- optionally define which files will be formatted. -->
+       <includes>
+         <include>src/**/*.ts</include> <!-- default value if nothing is specified -->
+       </includes>
+       <!-- must specify exactly one of the following "{foo}File" or "config" elements -->
+       <tslintFile>${basedir}/path/to/repo/tslint.json</tslintFile>
+       <tsfmtFile>${basedir}/path/to/repo/tsfmt.json</tsfmtFile>
+       <tsconfigFile>${basedir}/path/to/repo/tsconfig.json</tsconfigFile>
+       <vscodeFile>${basedir}/path/to/repo/vscode.json</vscodeFile>
+       <config>
+         <indentSize>1</indentSize>
+         <convertTabsToSpaces>true</convertTabsToSpaces>
+       </config>
+       <!-- optionally configure following versions to use, shown values are defaults-->
+       <typescriptFormatterVersion>7.2.2</typescriptFormatterVersion>
+       <typescriptVersion>3.3.3</typescriptVersion>
+       <tslintVersion>5.12.1</tslintVersion>
+     </tsfmt>
+  </typescript>
+</configuration>
+```
+
+Supported config file types are `tsconfigFile`, `tslintFile`, `vscodeFile` and `tsfmtFile`. They are corresponding to the respective
+[tsfmt-parameters](https://github.com/vvakame/typescript-formatter/blob/7764258ad42ac65071399840d1b8701868510ca7/lib/index.ts#L27L34).  See [tsfmt's default config settings](https://github.com/vvakame/typescript-formatter/blob/7764258ad42ac65071399840d1b8701868510ca7/lib/utils.ts#L11L32) for what is available.
+
+*Please note:*
+The auto-discovery of config files (up the file tree) will not work when using tsfmt within spotless,
+  hence you are required to provide resolvable file paths for config files.
+
+### Prerequisite: tsfmt requires a working NodeJS version
+
+tsfmt is based on NodeJS, so to use it, a working NodeJS installation (especially npm) is required on the host running spotless.
+Spotless will try to auto-discover an npm installation. If that is not working for you, it is possible to directly configure the npm binary to use.
+
+```xml
+<configuration><typescript><tsfmt>
+  ...
+  <npmExecutable>/usr/bin/npm</npmExecutable>
+```
+
+Spotless uses npm to install necessary packages locally. It runs tsfmt using [J2V8](https://github.com/eclipsesource/J2V8) internally after that.
+
 <a name="format"></a>
 
 ## Applying to custom sources

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

@@ -45,6 +45,7 @@
 import com.diffplug.spotless.maven.java.Java;
 import com.diffplug.spotless.maven.kotlin.Kotlin;
 import com.diffplug.spotless.maven.scala.Scala;
+import com.diffplug.spotless.maven.typescript.Typescript;
 
 public abstract class AbstractSpotlessMojo extends AbstractMojo {
 
@@ -98,6 +99,9 @@ public abstract class AbstractSpotlessMojo extends AbstractMojo {
 	@Parameter
 	private Cpp cpp;
 
+	@Parameter
+	private Typescript typescript;
+
 	/** The CSS extension is discontinued. */
 	@Parameter
 	@Deprecated
@@ -179,7 +183,7 @@ private FileLocator getFileLocator() {
 	}
 
 	private List<FormatterFactory> getFormatterFactories() {
-		return Stream.concat(formats.stream(), Stream.of(java, scala, kotlin, cpp, css, xml))
+		return Stream.concat(formats.stream(), Stream.of(java, scala, kotlin, cpp, typescript, css, xml))
 				.filter(Objects::nonNull)
 				.collect(toList());
 	}

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

@@ -0,0 +1,105 @@
+/*
+ * Copyright 2016 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.typescript;
+
+import java.io.File;
+import java.util.Map;
+
+import org.apache.maven.plugins.annotations.Parameter;
+
+import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.maven.FormatterStepConfig;
+import com.diffplug.spotless.maven.FormatterStepFactory;
+import com.diffplug.spotless.npm.TsConfigFileType;
+import com.diffplug.spotless.npm.TsFmtFormatterStep;
+import com.diffplug.spotless.npm.TypedTsFmtConfigFile;
+
+public class Tsfmt implements FormatterStepFactory {
+
+	@Parameter
+	private String tslintFile;
+
+	@Parameter
+	private String tsconfigFile;
+
+	@Parameter
+	private String vscodeFile;
+
+	@Parameter
+	private String tsfmtFile;
+
+	@Parameter
+	private String typescriptFormatterVersion;
+
+	@Parameter
+	private String typescriptVersion;
+
+	@Parameter
+	private String tslintVersion;
+
+	@Parameter
+	private String npmExecutable;
+
+	@Parameter
+	private Map<String, Object> config;
+
+	@Parameter(defaultValue = "${project.build.directory}", required = true, readonly = true)
+	private File buildDir;
+
+	@Override
+	public FormatterStep newFormatterStep(FormatterStepConfig stepConfig) {
+
+		Map<String, String> devDependencies = TsFmtFormatterStep.defaultDevDependencies();
+		if (typescriptFormatterVersion != null) {
+			devDependencies.put("typescript-formatter", typescriptFormatterVersion);
+		}
+		if (typescriptVersion != null) {
+			devDependencies.put("typescript", typescriptVersion);
+		}
+		if (tslintVersion != null) {
+			devDependencies.put("tslint", tslintVersion);
+		}
+
+		File npm = npmExecutable != null ? stepConfig.getFileLocator().locateFile(npmExecutable) : null;
+
+		TypedTsFmtConfigFile configFile = null;
+
+		// check that there is only 1 config file or inline config
+		if (this.tsconfigFile != null
+				^ this.tsfmtFile != null
+				^ this.tslintFile != null
+				^ this.vscodeFile != null) {
+			if (this.tsconfigFile != null) {
+				configFile = new TypedTsFmtConfigFile(TsConfigFileType.TSCONFIG, stepConfig.getFileLocator().locateFile(tsconfigFile));
+			} else if (this.tsfmtFile != null) {
+				configFile = new TypedTsFmtConfigFile(TsConfigFileType.TSFMT, stepConfig.getFileLocator().locateFile(tsfmtFile));
+			} else if (this.tslintFile != null) {
+				configFile = new TypedTsFmtConfigFile(TsConfigFileType.TSLINT, stepConfig.getFileLocator().locateFile(tslintFile));
+			} else if (this.vscodeFile != null) {
+				configFile = new TypedTsFmtConfigFile(TsConfigFileType.VSCODE, stepConfig.getFileLocator().locateFile(vscodeFile));
+			}
+		} else {
+			if (config == null) {
+				throw new IllegalArgumentException("must specify exactly one configFile or config");
+			}
+		}
+
+		if (buildDir == null) {
+			buildDir = new File(".");
+		}
+		return TsFmtFormatterStep.create(devDependencies, stepConfig.getProvisioner(), buildDir, npm, configFile, config);
+	}
+}

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

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2016 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.typescript;
+
+import java.util.Set;
+
+import com.diffplug.common.collect.ImmutableSet;
+import com.diffplug.spotless.maven.FormatterFactory;
+
+/**
+ * A {@link FormatterFactory} implementation that corresponds to {@code <typescript>...</typescript>} configuration element.
+ * <p>
+ * It defines a formatter for typescript source files.
+ */
+public class Typescript extends FormatterFactory {
+
+	private static final Set<String> DEFAULT_INCLUDES = ImmutableSet.of("src/**/*.ts");
+
+	private static final String LICENSE_HEADER_DELIMITER = null;
+
+	@Override
+	public Set<String> defaultIncludes() {
+		return DEFAULT_INCLUDES;
+	}
+
+	@Override
+	public String licenseHeaderDelimiter() {
+		return LICENSE_HEADER_DELIMITER;
+	}
+
+	public void addTsfmt(Tsfmt tsfmt) {
+		addStepFactory(tsfmt);
+	}
+
+}

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

@@ -118,6 +118,10 @@ protected void writePomWithCssSteps(String... steps) throws IOException {
 		writePom(groupWithSteps("css", steps));
 	}
 
+	protected void writePomWithTypescriptSteps(String... steps) throws IOException {
+		writePom(groupWithSteps("typescript", steps));
+	}
+
 	protected void writePom(String... configuration) throws IOException {
 		writePom(null, configuration);
 	}