Updates for the Rome -> Biome transition (#1817 fixes #1804)

Author: nedtwigg

CHANGES.md

@@ -13,6 +13,10 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ### Added
 * Support Ktlint 1.0.0 ([#1808](https://github.com/diffplug/spotless/pull/1808)).
 
+* Add support for biome. The Rome project [was renamed to Biome](https://biomejs.dev/blog/annoucing-biome/).
+  The configuration is still the same, but you should switch to the new `biome` tag / function and adjust
+  the version accordingly. ([#1804](https://github.com/diffplug/spotless/issues/1804)).
+
 ### Fixed
 * Added support for plugins when using Prettier version `3.0.0` and newer. ([#1802](https://github.com/diffplug/spotless/pull/1802))
 

README.md

@@ -101,7 +101,7 @@ lib('npm.TsFmtFormatterStep')                    +'{{yes}}       | {{yes}}
 lib('pom.SortPomStepStep')                       +'{{no}}        | {{yes}}      | {{no}}       | {{no}}  |',
 lib('protobuf.BufStep')                          +'{{yes}}       | {{no}}       | {{no}}       | {{no}}  |',
 lib('python.BlackStep')                          +'{{yes}}       | {{no}}       | {{no}}       | {{no}}  |',
-lib('rome.RomeStep')                             +'{{yes}}       | {{yes}}      | {{no}}       | {{no}}  |',
+lib('biome.BiomeStep')                           +'{{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}}  |',
@@ -153,7 +153,7 @@ lib('yaml.JacksonYamlStep')                      +'{{yes}}       | {{yes}}
 | [`pom.SortPomStepStep`](lib/src/main/java/com/diffplug/spotless/pom/SortPomStepStep.java) | :white_large_square:        | :+1:      | :white_large_square:       | :white_large_square:  |
 | [`protobuf.BufStep`](lib/src/main/java/com/diffplug/spotless/protobuf/BufStep.java) | :+1:       | :white_large_square:       | :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:  |
+| [`biome.BiomeStep`](lib/src/main/java/com/diffplug/spotless/biome/BiomeStep.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/BiomeFlavor.java

@@ -0,0 +1,95 @@
+/*
+ * 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.rome;
+
+/**
+ * The flavor of Biome to use. Exists for compatibility reason, may be removed
+ * shortly.
+ * <p>
+ * Will be removed once the old Rome project is not supported anymore.
+ */
+public enum BiomeFlavor {
+	/** The new forked Biome project. */
+	BIOME("biome", "1.2.0", "biome.json", "biome-%s-%s-%s",
+			"https://github.com/biomejs/biome/releases/download/cli%%2Fv%s/biome-%s"),
+
+	/**
+	 * The old deprecated Rome project.
+	 *
+	 * @deprecated Will be removed once the old Rome project is not supported
+	 *             anymore.
+	 */
+	@Deprecated
+	ROME("rome", "12.0.0", "rome.json", "rome-%s-%s-%s",
+			"https://github.com/rome/tools/releases/download/cli%%2Fv%s/rome-%s");
+
+	private final String configName;
+	private final String defaultVersion;
+	private final String downloadFilePattern;
+	private final String shortName;
+	private final String urlPattern;
+
+	BiomeFlavor(String shortName, String defaultVersion, String configName, String downloadFilePattern,
+			String urlPattern) {
+		this.shortName = shortName;
+		this.defaultVersion = defaultVersion;
+		this.configName = configName;
+		this.downloadFilePattern = downloadFilePattern;
+		this.urlPattern = urlPattern;
+	}
+
+	/**
+	 * @return The name of the default config file.
+	 */
+	public String configName() {
+		return configName;
+	}
+
+	/**
+	 * @return Default version to use when no version was set explicitly.
+	 */
+	public String defaultVersion() {
+		return defaultVersion;
+	}
+
+	/**
+	 * @return The pattern for {@link String#format(String, Object...)
+	 *         String.format()} for the file name of a Biome executable for a
+	 *         certain version and architecure. The first parameter is the platform,
+	 *         the second is the OS, the third is the architecture.
+	 */
+	public String getDownloadFilePattern() {
+		return downloadFilePattern;
+	}
+
+	/**
+	 * @return The pattern for {@link String#format(String, Object...)
+	 *         String.format()} for the URL where the executables can be downloaded.
+	 *         The first parameter is the version, the second parameter is the OS /
+	 *         platform.
+	 */
+	public String getUrlPattern() {
+		return urlPattern;
+	}
+
+	/**
+	 * @return The short name of this flavor, i.e. <code>rome</code> or
+	 *         <code>biome</code>.
+	 */
+	public String shortName() {
+		return shortName;
+	}
+}

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

@@ -38,8 +38,8 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * Downloader for the Rome executable:
- * <a href="https://github.com/rome/tools">https://github.com/rome/tools</a>.
+ * Downloader for the Biome executable:
+ * <a href="https://github.com/biomejs/biome">https://github.com/biomejs/biome</a>.
  */
 final class RomeExecutableDownloader {
 	private static final Logger logger = LoggerFactory.getLogger(RomeExecutableDownloader.class);
@@ -51,15 +51,7 @@ final class RomeExecutableDownloader {
 
 	/**
 	 * The pattern for {@link String#format(String, Object...) String.format()} for
-	 * the file name of a Rome executable for a certain version and architecure. The
-	 * first parameter is the platform, the second is the OS, the third is the
-	 * architecture.
-	 */
-	private static final String DOWNLOAD_FILE_PATTERN = "rome-%s-%s-%s";
-
-	/**
-	 * The pattern for {@link String#format(String, Object...) String.format()} for
-	 * the platform part of the Rome executable download URL. First parameter is the
+	 * the platform part of the Biome executable download URL. First parameter is the
 	 * OS, second parameter the architecture, the third the file extension.
 	 */
 	private static final String PLATFORM_PATTERN = "%s-%s%s";
@@ -70,39 +62,36 @@ final class RomeExecutableDownloader {
 	 */
 	private static final OpenOption[] READ_OPTIONS = {StandardOpenOption.READ};
 
-	/**
-	 * The pattern for {@link String#format(String, Object...) String.format()} for
-	 * the URL where the Rome executables can be downloaded. The first parameter is
-	 * the version, the second parameter is the OS / platform.
-	 */
-	private static final String URL_PATTERN = "https://github.com/rome/tools/releases/download/cli%%2Fv%s/rome-%s";
-
 	/**
 	 * {@link OpenOption Open options} for creating a new file, overwriting the
 	 * existing file if present.
 	 */
 	private static final OpenOption[] WRITE_OPTIONS = {StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING,
 			StandardOpenOption.WRITE};
 
-	private Path downloadDir;
+	private final Path downloadDir;
+
+	private final BiomeFlavor flavor;
 
 	/**
-	 * Creates a new downloader for the Rome executable. The executable files are
+	 * Creates a new downloader for the Biome executable. The executable files are
 	 * stored in the given download directory.
 	 *
-	 * @param downloadDir Directory where
+	 * @param flavor Flavor of Biome to use.
+	 * @param downloadDir Directory where to store the downloaded executable.
 	 */
-	public RomeExecutableDownloader(Path downloadDir) {
+	public RomeExecutableDownloader(BiomeFlavor flavor, Path downloadDir) {
+		this.flavor = flavor;
 		this.downloadDir = downloadDir;
 	}
 
 	/**
-	 * Downloads the Rome executable for the current platform from the network to
+	 * Downloads the Biome executable for the current platform from the network to
 	 * the download directory. When the executable exists already, it is
 	 * overwritten.
 	 *
-	 * @param version Desired Rome version.
-	 * @return The path to the Rome executable.
+	 * @param version Desired Biome version.
+	 * @return The path to the Biome executable.
 	 * @throws IOException           When the executable cannot be downloaded from
 	 *                               the network or the file system could not be
 	 *                               accessed.
@@ -121,7 +110,7 @@ public Path download(String version) throws IOException, InterruptedException {
 		if (executableDir != null) {
 			Files.createDirectories(executableDir);
 		}
-		logger.info("Attempting to download Rome from '{}' to '{}'", url, executablePath);
+		logger.info("Attempting to download Biome from '{}' to '{}'", url, executablePath);
 		var request = HttpRequest.newBuilder(URI.create(url)).GET().build();
 		var handler = BodyHandlers.ofFile(executablePath, WRITE_OPTIONS);
 		var response = HttpClient.newBuilder().followRedirects(Redirect.NORMAL).build().send(request, handler);
@@ -133,19 +122,19 @@ public Path download(String version) throws IOException, InterruptedException {
 			throw new IOException("Failed to download file from " + url + ", file is empty or does not exist");
 		}
 		writeChecksumFile(downloadedFile, checksumPath);
-		logger.debug("Rome was downloaded successfully to '{}'", downloadedFile);
+		logger.debug("Biome was downloaded successfully to '{}'", downloadedFile);
 		return downloadedFile;
 	}
 
 	/**
-	 * Ensures that the Rome executable for the current platform exists in the
+	 * Ensures that the Biome executable for the current platform exists in the
 	 * download directory. When the executable does not exist in the download
-	 * directory, an attempt is made to download the Rome executable from the
+	 * directory, an attempt is made to download the Biome executable from the
 	 * network. When the executable exists already, no attempt to download it again
 	 * is made.
 	 *
-	 * @param version Desired Rome version.
-	 * @return The path to the Rome executable.
+	 * @param version Desired Biome version.
+	 * @return The path to the Biome executable.
 	 * @throws IOException           When the executable cannot be downloaded from
 	 *                               the network or the file system could not be
 	 *                               accessed.
@@ -157,23 +146,23 @@ public Path download(String version) throws IOException, InterruptedException {
 	 */
 	public Path ensureDownloaded(String version) throws IOException, InterruptedException {
 		var platform = Platform.guess();
-		logger.debug("Ensuring that Rome for platform '{}' is downloaded", platform);
+		logger.debug("Ensuring that Biome for platform '{}' is downloaded", platform);
 		var existing = findDownloaded(version);
 		if (existing.isPresent()) {
-			logger.debug("Rome was already downloaded, using executable at '{}'", existing.get());
+			logger.debug("Biome was already downloaded, using executable at '{}'", existing.get());
 			return existing.get();
 		} else {
-			logger.debug("Rome was not yet downloaded, attempting to download executable");
+			logger.debug("Biome was not yet downloaded, attempting to download executable");
 			return download(version);
 		}
 	}
 
 	/**
-	 * Attempts to find the Rome executable for the current platform in the download
+	 * Attempts to find the Biome executable for the current platform in the download
 	 * directory. No attempt is made to download the executable from the network.
 	 *
-	 * @param version Desired Rome version.
-	 * @return The path to the Rome executable.
+	 * @param version Desired Biome version.
+	 * @return The path to the Biome executable.
 	 * @throws IOException           When the executable does not exists in the
 	 *                               download directory, or when the file system
 	 *                               could not be accessed.
@@ -184,7 +173,7 @@ public Path ensureDownloaded(String version) throws IOException, InterruptedExce
 	public Optional<Path> findDownloaded(String version) throws IOException {
 		var platform = Platform.guess();
 		var executablePath = getExecutablePath(version, platform);
-		logger.debug("Checking rome executable at {}", executablePath);
+		logger.debug("Checking Biome executable at {}", executablePath);
 		return checkFileWithChecksum(executablePath) ? Optional.ofNullable(executablePath) : Optional.empty();
 	}
 
@@ -248,12 +237,12 @@ private String computeChecksum(Path file, String algorithm) throws IOException {
 	}
 
 	/**
-	 * Finds the code name for the given operating system used by the Rome
+	 * Finds the code name for the given operating system used by the Biome
 	 * executable download URL.
 	 *
 	 * @param os Desired operating system.
-	 * @return Code name for the Rome download URL.
-	 * @throws IOException When the given OS is not supported by Rome.
+	 * @return Code name for the Biome download URL.
+	 * @throws IOException When the given OS is not supported by Biome.
 	 */
 	private String getArchitectureCodeName(Architecture architecture) throws IOException {
 		switch (architecture) {
@@ -281,28 +270,28 @@ private Path getChecksumPath(Path file) {
 	}
 
 	/**
-	 * Finds the URL from which the Rome executable can be downloaded.
+	 * Finds the URL from which the Biome executable can be downloaded.
 	 *
-	 * @param version  Desired Rome version.
+	 * @param version  Desired Biome version.
 	 * @param platform Desired platform.
-	 * @return The URL for the Rome executable.
-	 * @throws IOException When the platform is not supported by Rome.
+	 * @return The URL for the Biome executable.
+	 * @throws IOException When the platform is not supported by Biome.
 	 */
 	private String getDownloadUrl(String version, Platform platform) throws IOException {
 		var osCodeName = getOsCodeName(platform.getOs());
 		var architectureCodeName = getArchitectureCodeName(platform.getArchitecture());
 		var extension = getDownloadUrlExtension(platform.getOs());
 		var platformString = String.format(PLATFORM_PATTERN, osCodeName, architectureCodeName, extension);
-		return String.format(URL_PATTERN, version, platformString);
+		return String.format(flavor.getUrlPattern(), version, platformString);
 	}
 
 	/**
-	 * Finds the file extension of the Rome download URL for the given operating
+	 * Finds the file extension of the Biome download URL for the given operating
 	 * system.
 	 *
 	 * @param os Desired operating system.
-	 * @return Extension for the Rome download URL.
-	 * @throws IOException When the given OS is not supported by Rome.
+	 * @return Extension for the Biome download URL.
+	 * @throws IOException When the given OS is not supported by Biome.
 	 */
 	private String getDownloadUrlExtension(OS os) throws IOException {
 		switch (os) {
@@ -318,27 +307,27 @@ private String getDownloadUrlExtension(OS os) throws IOException {
 	}
 
 	/**
-	 * Finds the path on the file system for the Rome executable with a given
+	 * Finds the path on the file system for the Biome executable with a given
 	 * version and platform.
 	 *
-	 * @param version  Desired Rome version.
+	 * @param version  Desired Biome version.
 	 * @param platform Desired platform.
-	 * @return The path for the Rome executable.
+	 * @return The path for the Biome executable.
 	 */
 	private Path getExecutablePath(String version, Platform platform) {
 		var os = platform.getOs().name().toLowerCase(Locale.ROOT);
 		var arch = platform.getArchitecture().name().toLowerCase(Locale.ROOT);
-		var fileName = String.format(DOWNLOAD_FILE_PATTERN, os, arch, version);
+		var fileName = String.format(flavor.getDownloadFilePattern(), os, arch, version);
 		return downloadDir.resolve(fileName);
 	}
 
 	/**
-	 * Finds the code name for the given operating system used by the Rome
+	 * Finds the code name for the given operating system used by the Biome
 	 * executable download URL.
 	 *
 	 * @param os Desired operating system.
-	 * @return Code name for the Rome download URL.
-	 * @throws IOException When the given OS is not supported by Rome.
+	 * @return Code name for the Biome download URL.
+	 * @throws IOException When the given OS is not supported by Biome.
 	 */
 	private String getOsCodeName(OS os) throws IOException {
 		switch (os) {