Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
### Changes
- Add embedded lockfiles to Eclipse JDT (4.9, 4.11, 4.39, 4.40), bump version to latest `4.39` -> `4.40`. ([#1996](https://github.com/diffplug/spotless/issues/1996))

## [4.9.0] - 2026-07-27
### Added
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@
import static java.util.stream.Collectors.toMap;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.Serializable;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
Expand All @@ -28,6 +31,7 @@

import javax.annotation.Nullable;

import com.diffplug.common.base.Errors;
import com.diffplug.common.collect.ImmutableMap;
import com.diffplug.spotless.FileSignature;
import com.diffplug.spotless.FormatterFunc;
Expand Down Expand Up @@ -122,6 +126,10 @@ protected void addPlatformRepo(P2Model model, String version) {
/** Returns the FormatterStep (whose state will be calculated lazily). */
public FormatterStep build() {
var roundtrippableState = new EquoStep(formatterVersion, settingProperties, settingXml, FileSignature.promise(settingsFiles), JarState.promise(() -> {
List<String> lockfileDependencies = readEmbeddedLockfileDependencies(formatterVersion);
if (lockfileDependencies != null) {
return JarState.withoutTransitives(lockfileDependencies, mavenProvisioner);
}
P2Model model = createModelWithMirrors();
P2ModelWrapper modelWrapper = P2ModelWrapper.wrap(model);
List<File> classpath = p2Provisioner.provisionP2Dependencies(modelWrapper, mavenProvisioner, cacheDirectory).stream()
Expand All @@ -133,6 +141,54 @@ public FormatterStep build() {
return FormatterStep.create(formatterName, roundtrippableState, EquoStep::state, stateToFormatter);
}

private @Nullable List<String> readEmbeddedLockfileDependencies(String version) {
String lockfileResourcePath = lockfileResourcePath(version);
if (lockfileResourcePath == null) {
return null;
}
if (!lockfileResourcePath.startsWith("/")) {
throw new IllegalArgumentException("Lockfile resource path must start with '/': " + lockfileResourcePath);
}
InputStream lockfile = EquoBasedStepBuilder.class.getResourceAsStream(lockfileResourcePath);
if (lockfile == null) {
// No lockfile embedded for this version — fall back to P2 provisioning
return null;
}
String allLines;
try (lockfile) {
allLines = new String(lockfile.readAllBytes(), StandardCharsets.UTF_8);
} catch (IOException e) {
throw Errors.asRuntime(e);
}
var dependencies = new ArrayList<String>();
for (String line : allLines.split("\n")) {
String trimmed = line.trim();
if (!trimmed.isEmpty() && !trimmed.startsWith("#")) {
dependencies.add(trimmed);
}
}
if (dependencies.isEmpty()) {
throw new IllegalArgumentException("No dependencies defined in lockfile " + lockfileResourcePath);
}
return dependencies;
}

/**
* Returns the classpath resource path of an embedded lockfile for the given formatter version.
* <p>
* The default implementation always returns {@code null}, which means dependency resolution
* falls back to P2 provisioning.
* <p>
* Overriding implementations should return an absolute classpath resource path (starting with
* {@code /}) that is compatible with {@link Class#getResourceAsStream(String)}.
*
* @return absolute classpath resource path of the embedded lockfile, or {@code null} to use
* P2 provisioning
*/
protected @Nullable String lockfileResourcePath(String version) {
return null;
}

private P2Model createModelWithMirrors() {
P2Model model = model(formatterVersion);
if (p2Mirrors.isEmpty()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public final class EclipseJdtFormatterStep {
private EclipseJdtFormatterStep() {}

private static final String NAME = "eclipse jdt formatter";
private static final Jvm.Support<String> JVM_SUPPORT = Jvm.<String> support(NAME).add(17, "4.39");
private static final Jvm.Support<String> JVM_SUPPORT = Jvm.<String> support(NAME).add(17, "4.40");

public static String defaultVersion() {
return JVM_SUPPORT.getRecommendedFormatterVersion();
Expand Down Expand Up @@ -76,6 +76,11 @@ protected P2Model model(String version) {
return model;
}

@Override
protected String lockfileResourcePath(String version) {
return "/com/diffplug/spotless/extra/eclipse_jdt_formatter/v" + version + ".lockfile";
}

@Override
public void setVersion(String version) {
if (version.endsWith(".0")) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Spotless formatter based on Eclipse-JDT 4.11
org.eclipse.jdt:org.eclipse.jdt.core:3.17.0
org.eclipse.platform:org.eclipse.core.commands:3.9.300
org.eclipse.platform:org.eclipse.core.contenttype:3.7.300
org.eclipse.platform:org.eclipse.core.expressions:3.6.300
org.eclipse.platform:org.eclipse.core.filesystem:1.7.300
org.eclipse.platform:org.eclipse.core.jobs:3.10.300
org.eclipse.platform:org.eclipse.core.resources:3.13.300
org.eclipse.platform:org.eclipse.core.runtime:3.15.200
org.eclipse.platform:org.eclipse.equinox.app:1.4.100
org.eclipse.platform:org.eclipse.equinox.common:3.10.300
org.eclipse.platform:org.eclipse.equinox.preferences:3.7.300
org.eclipse.platform:org.eclipse.equinox.registry:3.8.300
org.eclipse.platform:org.eclipse.equinox.supplement:1.8.200
org.eclipse.platform:org.eclipse.osgi:3.13.300
org.eclipse.platform:org.eclipse.text:3.8.100
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Spotless formatter based on Eclipse-JDT 4.25
org.eclipse.jdt:org.eclipse.jdt.core:3.31.0
org.eclipse.platform:org.eclipse.core.commands:3.10.200
org.eclipse.platform:org.eclipse.core.contenttype:3.8.200
org.eclipse.platform:org.eclipse.core.expressions:3.8.200
org.eclipse.platform:org.eclipse.core.filesystem:1.9.500
org.eclipse.platform:org.eclipse.core.jobs:3.13.100
org.eclipse.platform:org.eclipse.core.resources:3.18.0
org.eclipse.platform:org.eclipse.core.runtime:3.26.0
org.eclipse.platform:org.eclipse.equinox.app:1.6.200
org.eclipse.platform:org.eclipse.equinox.common:3.16.200
org.eclipse.platform:org.eclipse.equinox.preferences:3.10.100
org.eclipse.platform:org.eclipse.equinox.registry:3.11.200
org.eclipse.platform:org.eclipse.equinox.supplement:1.10.600
org.eclipse.platform:org.eclipse.osgi:3.18.100
org.eclipse.platform:org.eclipse.text:3.12.200
org.osgi:org.osgi.service.prefs:1.1.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Spotless formatter based on Eclipse-JDT 4.26
org.eclipse.jdt:org.eclipse.jdt.core:3.32.0
org.eclipse.platform:org.eclipse.core.commands:3.10.300
org.eclipse.platform:org.eclipse.core.contenttype:3.8.200
org.eclipse.platform:org.eclipse.core.expressions:3.8.200
org.eclipse.platform:org.eclipse.core.filesystem:1.9.500
org.eclipse.platform:org.eclipse.core.jobs:3.13.200
org.eclipse.platform:org.eclipse.core.resources:3.18.100
org.eclipse.platform:org.eclipse.core.runtime:3.26.100
org.eclipse.platform:org.eclipse.equinox.app:1.6.200
org.eclipse.platform:org.eclipse.equinox.common:3.17.0
org.eclipse.platform:org.eclipse.equinox.preferences:3.10.100
org.eclipse.platform:org.eclipse.equinox.registry:3.11.200
org.eclipse.platform:org.eclipse.equinox.supplement:1.10.600
org.eclipse.platform:org.eclipse.osgi:3.18.200
org.eclipse.platform:org.eclipse.text:3.12.300
org.osgi:org.osgi.service.prefs:1.1.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Spotless formatter based on Eclipse-JDT 4.39
org.eclipse.jdt:org.eclipse.jdt.core:3.45.0
net.java.dev.jna:jna-platform:5.18.1
org.eclipse.jdt:ecj:3.45.0
org.eclipse.platform:org.eclipse.core.commands:3.12.500
org.eclipse.platform:org.eclipse.core.contenttype:3.9.800
org.eclipse.platform:org.eclipse.core.expressions:3.9.500
org.eclipse.platform:org.eclipse.core.filesystem:1.11.400
org.eclipse.platform:org.eclipse.core.jobs:3.15.700
org.eclipse.platform:org.eclipse.core.resources:3.23.200
org.eclipse.platform:org.eclipse.core.runtime:3.34.200
org.eclipse.platform:org.eclipse.equinox.app:1.7.600
org.eclipse.platform:org.eclipse.equinox.common:3.20.300
org.eclipse.platform:org.eclipse.equinox.preferences:3.12.100
org.eclipse.platform:org.eclipse.equinox.registry:3.12.600
org.eclipse.platform:org.eclipse.equinox.supplement:1.12.200
org.eclipse.platform:org.eclipse.osgi:3.24.100
org.eclipse.platform:org.eclipse.text:3.14.600
org.osgi:org.osgi.service.prefs:1.1.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Spotless formatter based on Eclipse-JDT 4.40
org.eclipse.jdt:org.eclipse.jdt.core:3.46.0
net.java.dev.jna:jna-platform:5.18.1
org.eclipse.jdt:ecj:3.46.0
org.eclipse.platform:org.eclipse.core.commands:3.12.500
org.eclipse.platform:org.eclipse.core.contenttype:3.9.800
org.eclipse.platform:org.eclipse.core.expressions:3.9.600
org.eclipse.platform:org.eclipse.core.filesystem:1.11.400
org.eclipse.platform:org.eclipse.core.jobs:3.15.800
org.eclipse.platform:org.eclipse.core.resources:3.24.0
org.eclipse.platform:org.eclipse.core.runtime:3.34.200
org.eclipse.platform:org.eclipse.equinox.app:1.7.600
org.eclipse.platform:org.eclipse.equinox.common:3.20.400
org.eclipse.platform:org.eclipse.equinox.preferences:3.12.100
org.eclipse.platform:org.eclipse.equinox.registry:3.12.600
org.eclipse.platform:org.eclipse.equinox.supplement:1.12.300
org.eclipse.platform:org.eclipse.osgi:3.24.200
org.eclipse.platform:org.eclipse.text:3.14.700
org.osgi:org.osgi.service.prefs:1.1.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Spotless formatter based on Eclipse-JDT 4.9
org.eclipse.jdt:org.eclipse.jdt.core:3.15.0
org.eclipse.platform:org.eclipse.core.commands:3.9.200
org.eclipse.platform:org.eclipse.core.contenttype:3.7.100
org.eclipse.platform:org.eclipse.core.expressions:3.6.200
org.eclipse.platform:org.eclipse.core.filesystem:1.7.200
org.eclipse.platform:org.eclipse.core.jobs:3.10.100
org.eclipse.platform:org.eclipse.core.resources:3.13.100
org.eclipse.platform:org.eclipse.core.runtime:3.15.0
org.eclipse.platform:org.eclipse.equinox.app:1.3.600
org.eclipse.platform:org.eclipse.equinox.common:3.10.100
org.eclipse.platform:org.eclipse.equinox.preferences:3.7.200
org.eclipse.platform:org.eclipse.equinox.registry:3.8.100
org.eclipse.platform:org.eclipse.equinox.supplement:1.8.100
org.eclipse.platform:org.eclipse.osgi:3.13.100
org.eclipse.platform:org.eclipse.text:3.7.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
/*
* Copyright 2016-2026 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.extra;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyCollection;
import static org.mockito.ArgumentMatchers.assertArg;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
import static org.mockito.Mockito.when;

import java.io.File;
import java.nio.file.Path;
import java.util.Collection;
import java.util.List;
import java.util.Set;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;

import com.diffplug.common.collect.ImmutableMap;
import com.diffplug.spotless.Provisioner;
import com.diffplug.spotless.StepHarness;

import dev.equo.solstice.p2.P2Model;

class EquoBasedStepBuilderLockfileTest {

@Test
void missingEmbeddedLockfileFallsBackToP2() throws Exception {
P2Provisioner p2Provisioner = mock();
Provisioner mavenProvisioner = mock();
when(p2Provisioner.provisionP2Dependencies(any(), any(), any())).thenReturn(List.of());
EquoBasedStepBuilder builder = builderWithLockfilePath("/com/diffplug/spotless/extra/missing.lockfile", p2Provisioner, mavenProvisioner);
StepHarness.forStep(builder.build()).test("class T {}", "class T {}");
verify(p2Provisioner).provisionP2Dependencies(any(), any(), any());
verifyNoInteractions(mavenProvisioner);
}

@Test
void lockfilePathMustBeAbsolute() {
P2Provisioner p2Provisioner = mock();
Provisioner mavenProvisioner = mock();
EquoBasedStepBuilder builder = builderWithLockfilePath("com/diffplug/spotless/extra/empty.lockfile",
p2Provisioner, mavenProvisioner);
IllegalArgumentException exception = assertThrows(IllegalArgumentException.class,
() -> StepHarness.forStep(builder.build()).test("class T {}", "class T {}"));
assertTrue(exception.getMessage().contains("must start with '/'"));
verifyNoInteractions(p2Provisioner, mavenProvisioner);
}

@Test
void emptyEmbeddedLockfileThrows() {
P2Provisioner p2Provisioner = mock();
Provisioner mavenProvisioner = mock();
EquoBasedStepBuilder builder = builderWithLockfilePath("/com/diffplug/spotless/extra/empty.lockfile",
p2Provisioner, mavenProvisioner);
IllegalArgumentException exception = assertThrows(IllegalArgumentException.class,
() -> StepHarness.forStep(builder.build()).test("class T {}", "class T {}"));
assertTrue(exception.getMessage().contains("No dependencies defined in lockfile"));
verifyNoInteractions(p2Provisioner, mavenProvisioner);
}

@Test
void embeddedLockfileUsesWithoutTransitivesAndAllCoordinates(@TempDir Path tempDir) throws Exception {
P2Provisioner p2Provisioner = mock();
Provisioner mavenProvisioner = mock();
File dummyJar = tempDir.resolve("spotless-lockfile-test.jar").toFile();
assertTrue(dummyJar.createNewFile());
when(mavenProvisioner.provisionWithTransitives(eq(false), anyCollection())).thenReturn(Set.of(dummyJar));
EquoBasedStepBuilder builder = builderWithLockfilePath("/com/diffplug/spotless/extra/two-deps.lockfile",
p2Provisioner, mavenProvisioner);

StepHarness.forStep(builder.build()).test("class T {}", "class T {}");

verify(mavenProvisioner).provisionWithTransitives(eq(false), assertArg((Collection<String> coords) -> assertThat(coords)
.containsExactlyInAnyOrder(
"org.eclipse.jdt:org.eclipse.jdt.core:3.45.0",
"org.eclipse.jdt:ecj:3.45.0")));
verifyNoInteractions(p2Provisioner);
}

private static EquoBasedStepBuilder builderWithLockfilePath(String lockfilePath, P2Provisioner p2Provisioner, Provisioner mavenProvisioner) {
return new EquoBasedStepBuilder(
"lockfile test formatter",
mavenProvisioner,
p2Provisioner,
"4.40",
state -> input -> input,
ImmutableMap.builder()) {
@Override
protected P2Model model(String version) {
return new P2Model();
}

@Override
protected String lockfileResourcePath(String version) {
return lockfilePath;
}
};
}

}
Loading