Support Rome as a formatter (#1663)

Author: nedtwigg

CHANGES.md

@@ -10,13 +10,13 @@ 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]
-### Changes
-* Bump default sortpom version to latest `3.0.0` -> `3.2.1`. ([#1675](https://github.com/diffplug/spotless/pull/1675))
-
 ### Added
 * `Jvm.Support` now accepts `-SNAPSHOT` versions, treated as the non`-SNAPSHOT`. ([#1583](https://github.com/diffplug/spotless/issues/1583))
+* Support Rome as a formatter for JavaScript and TypeScript code. Adds a new `rome` step to `javascript` and `typescript` formatter configurations. ([#1663](https://github.com/diffplug/spotless/pull/1663))
 ### Fixed
 * When P2 download fails, indicate the responsible formatter. ([#1698](https://github.com/diffplug/spotless/issues/1698))
+### Changes
+* Bump default sortpom version to latest `3.0.0` -> `3.2.1`. ([#1675](https://github.com/diffplug/spotless/pull/1675))
 
 ## [2.38.0] - 2023-04-06
 ### Added

README.md

@@ -99,6 +99,7 @@ lib('npm.PrettierFormatterStep')                 +'{{yes}}       | {{yes}}
 lib('npm.TsFmtFormatterStep')                    +'{{yes}}       | {{yes}}      | {{no}}       | {{no}}  |',
 lib('pom.SortPomStep')                           +'{{no}}        | {{yes}}      | {{no}}       | {{no}}  |',
 lib('python.BlackStep')                          +'{{yes}}       | {{no}}       | {{no}}       | {{no}}  |',
+lib('rome.RomeStep')                             +'{{yes}}       | {{yes}}      | {{no}}       | {{no}}  |',
 lib('scala.ScalaFmtStep')                        +'{{yes}}       | {{yes}}      | {{yes}}      | {{no}}  |',
 lib('sql.DBeaverSQLFormatterStep')               +'{{yes}}       | {{yes}}      | {{yes}}      | {{no}}  |',
 extra('wtp.EclipseWtpFormatterStep')             +'{{yes}}       | {{yes}}      | {{no}}       | {{no}}  |',
@@ -148,6 +149,7 @@ lib('yaml.JacksonYamlStep')                      +'{{yes}}       | {{yes}}
 | [`npm.TsFmtFormatterStep`](lib/src/main/java/com/diffplug/spotless/npm/TsFmtFormatterStep.java) | :+1:       | :+1:      | :white_large_square:       | :white_large_square:  |
 | [`pom.SortPomStep`](lib/src/main/java/com/diffplug/spotless/pom/SortPomStep.java) | :white_large_square:        | :+1:      | :white_large_square:       | :white_large_square:  |
 | [`python.BlackStep`](lib/src/main/java/com/diffplug/spotless/python/BlackStep.java) | :+1:       | :white_large_square:       | :white_large_square:       | :white_large_square:  |
+| [`rome.RomeStep`](lib/src/main/java/com/diffplug/spotless/rome/RomeStep.java) | :+1:       | :+1:      | :white_large_square:       | :white_large_square:  |
 | [`scala.ScalaFmtStep`](lib/src/main/java/com/diffplug/spotless/scala/ScalaFmtStep.java) | :+1:       | :+1:      | :+1:      | :white_large_square:  |
 | [`sql.DBeaverSQLFormatterStep`](lib/src/main/java/com/diffplug/spotless/sql/DBeaverSQLFormatterStep.java) | :+1:       | :+1:      | :+1:      | :white_large_square:  |
 | [`wtp.EclipseWtpFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/wtp/EclipseWtpFormatterStep.java) | :+1:       | :+1:      | :white_large_square:       | :white_large_square:  |

lib/src/main/java/com/diffplug/spotless/rome/Architecture.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2016-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.rome;
+
+/**
+ * Enumeration of possible computer architectures.
+ */
+enum Architecture {
+	/** The arm64 architecture */
+	ARM64,
+	/** Either x64 or x64_32 architecture */
+	X64;
+
+	/**
+	 * Attempts to guess the architecture of the environment running the JVM.
+	 *
+	 * @return The best guess for the architecture.
+	 */
+	public static Architecture guess() {
+		var arch = System.getProperty("os.arch");
+		var version = System.getProperty("os.version");
+
+		if (arch == null || arch.isBlank()) {
+			throw new IllegalStateException("No OS information is available, specify the Rome executable manually");
+		}
+
+		var msg = "Unsupported architecture " + arch + "/" + version
+				+ ", specify the path to the Rome executable manually";
+
+		if (arch.equals("ppc64le")) {
+			throw new IllegalStateException(msg);
+		}
+		if (arch.equals("aarch64")) {
+			throw new IllegalStateException(msg);
+		}
+		if (arch.equals("s390x")) {
+			throw new IllegalStateException(msg);
+		}
+		if (arch.equals("ppc64")) {
+			throw new IllegalStateException(msg);
+		}
+		if (arch.equals("ppc")) {
+			throw new IllegalStateException(msg);
+		}
+		if (arch.equals("arm")) {
+			if (version.contains("v7")) {
+				throw new IllegalStateException(msg);
+			}
+			return ARM64;
+		}
+		if (arch.contains("64")) {
+			return X64;
+		}
+		throw new IllegalStateException(msg);
+	}
+}

lib/src/main/java/com/diffplug/spotless/rome/OS.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2016-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.rome;
+
+import java.util.Locale;
+
+/**
+ * Enumeration of possible computer operation systems.
+ */
+enum OS {
+	/** Any derivate of a Linux operation system. */
+	LINUX,
+	/** The Macintosh operating system/ */
+	MAC_OS,
+	/** The Microsoft Windows operating system. */
+	WINDOWS,;
+
+	/**
+	 * Attempts to guess the OS of the environment running the JVM.
+	 *
+	 * @return The best guess for the architecture.
+	 * @throws IllegalStateException When the OS is either unsupported or no
+	 *                               information about the OS could be retrieved.
+	 */
+	public static OS guess() {
+		var osName = System.getProperty("os.name");
+		if (osName == null || osName.isBlank()) {
+			throw new IllegalStateException("No OS information is available, specify the Rome executable manually");
+		}
+		var osNameUpper = osName.toUpperCase(Locale.ROOT);
+		if (osNameUpper.contains("SUNOS") || osName.contains("AIX")) {
+			throw new IllegalStateException(
+					"Unsupported OS " + osName + ", specify the path to the Rome executable manually");
+		}
+		if (osNameUpper.contains("WINDOWS")) {
+			return OS.WINDOWS;
+		} else if (osNameUpper.contains("MAC")) {
+			return OS.MAC_OS;
+		} else {
+			return OS.LINUX;
+		}
+	}
+}

lib/src/main/java/com/diffplug/spotless/rome/Platform.java

@@ -0,0 +1,91 @@
+/*
+ * Copyright 2016-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.rome;
+
+/**
+ * Represents a platform where code is run, consisting of an operating system
+ * and an architecture.
+ */
+class Platform {
+	/**
+	 * Attempts to guess the platform of the hosting environment running the JVM
+	 * machine.
+	 *
+	 * @return The best guess for the current OS and architecture.
+	 * @throws IllegalStateException When no OS information is available, or when
+	 *                               the OS or architecture is unsupported.
+	 */
+	public static Platform guess() {
+		var os = OS.guess();
+		var architecture = Architecture.guess();
+		return new Platform(os, architecture);
+	}
+
+	private final Architecture architecture;
+
+	private final OS os;
+
+	/**
+	 * Creates a new Platform descriptor for the given OS and architecture.
+	 *
+	 * @param os           Operating system of the platform.
+	 * @param architecture Architecture of the platform.
+	 */
+	public Platform(OS os, Architecture architecture) {
+		this.os = os;
+		this.architecture = architecture;
+	}
+
+	/**
+	 * @return The architecture of this platform.
+	 */
+	public Architecture getArchitecture() {
+		return architecture;
+	}
+
+	/**
+	 * @return The operating system of this platform.
+	 */
+	public OS getOs() {
+		return os;
+	}
+
+	/**
+	 * @return Whether the operating system is Linux.
+	 */
+	public boolean isLinux() {
+		return os == OS.LINUX;
+	}
+
+	/**
+	 * @return Whether the operating system is Mac.
+	 */
+	public boolean isMac() {
+		return os == OS.MAC_OS;
+	}
+
+	/**
+	 * @return Whether the operating system is Windows.
+	 */
+	public boolean isWindows() {
+		return os == OS.WINDOWS;
+	}
+
+	@Override
+	public String toString() {
+		return String.format("Platform[os=%s,architecture=%s]", os, architecture);
+	}
+}