Skip to content

feature: IntelliJ plugin supports projects inside WSL2 (wsl/linux jdk). Fixes #899 #1624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KaiFieger wants to merge 1 commit into
base: develop
Choose a base branch
from
+70 −8
Open

feature: IntelliJ plugin supports projects inside WSL2 (wsl/linux jdk). Fixes #899 #1624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 28 additions & 1 deletion idea-plugin/src/main/java/com/palantir/javaformat/intellij/FormatterProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
import com.github.benmanes.caffeine.cache.LoadingCache;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.intellij.execution.wsl.WSLDistribution;
import com.intellij.execution.wsl.WslPath;
import com.intellij.ide.plugins.IdeaPluginDescriptor;
import com.intellij.ide.plugins.PluginManager;
import com.intellij.openapi.application.ApplicationInfo;
Expand Down Expand Up @@ -95,6 +97,29 @@ private static Optional<FormatterService> createFormatter(FormatterCacheKey cach
if (useBootstrappingFormatter(
jdkMajorVersion, ApplicationInfo.getInstance().getBuild())) {
Path jdkPath = getJdkPath(cacheKey.project);
if (SystemInfo.isWindows) {
WslPath jdkUncPath =
WslPath.parseWindowsUncPath(jdkPath.toAbsolutePath().toString());
if (jdkUncPath != null) {
// Project JDK is inside WSL2. We have to run the formatter inside WSL2 as well
Path jdkLinuxPath = Path.of(jdkUncPath.getLinuxPath());
String wslId = jdkUncPath.getDistributionId();
WSLDistribution distro = jdkUncPath.getDistribution();
List<Path> linuxImplementationClassPath = implementationClasspath.stream()
.map(Path::toAbsolutePath)
.map(distro::getWslPath)
.map(Path::of)
.toList();

log.info(
"Using bootstrapping formatter with WSL distribution {}, jdk version {} and path: {}",
wslId,
jdkMajorVersion,
jdkLinuxPath);
return Optional.of(new BootstrappingFormatterService(
wslId, jdkLinuxPath, jdkMajorVersion, linuxImplementationClassPath));
}
}
log.info("Using bootstrapping formatter with jdk version {} and path: {}", jdkMajorVersion, jdkPath);
return Optional.of(new BootstrappingFormatterService(jdkPath, jdkMajorVersion, implementationClasspath));
}
Expand Down Expand Up @@ -153,7 +178,9 @@ private static Path getJdkPath(Project project) {
return getProjectJdk(project)
.map(Sdk::getHomePath)
.map(Path::of)
.map(sdkHome -> sdkHome.resolve("bin").resolve("java" + (SystemInfo.isWindows ? ".exe" : "")))
.map(sdkHome -> sdkHome.resolve("bin")
.resolve("java"
+ (SystemInfo.isWindows && !WslPath.isWslUncPath(sdkHome.toString()) ? ".exe" : "")))
.filter(Files::exists)
.orElseThrow(() ->
new IllegalStateException("Could not determine JDK path for project: " + project.getName()));
Expand Down
49 changes: 42 additions & 7 deletions ...tstrap/src/main/java/com/palantir/javaformat/bootstrap/BootstrappingFormatterService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Collectors;
import org.immutables.value.Value;

Expand All @@ -44,11 +45,21 @@ public final class BootstrappingFormatterService implements FormatterService {
private final Path jdkPath;
private final Integer jdkMajorVersion;
private final List<Path> implementationClassPath;
private final Optional<String> wslDistributionId;

public BootstrappingFormatterService(Path jdkPath, Integer jdkMajorVersion, List<Path> implementationClassPath) {
this.jdkPath = jdkPath;
this.jdkMajorVersion = jdkMajorVersion;
this.implementationClassPath = implementationClassPath;
this.wslDistributionId = Optional.empty();
}

public BootstrappingFormatterService(
String wslDistributionId, Path jdkPath, Integer jdkMajorVersion, List<Path> implementationClassPath) {
this.jdkPath = jdkPath;
this.jdkMajorVersion = jdkMajorVersion;
this.implementationClassPath = implementationClassPath;
this.wslDistributionId = Optional.of(wslDistributionId);
}

@Override
Expand Down Expand Up @@ -84,13 +95,16 @@ private ImmutableList<Replacement> getFormatReplacementsInternal(String input, C
.jdkPath(jdkPath)
.withJvmArgsForVersion(jdkMajorVersion)
.implementationClasspath(implementationClassPath)
.wslDistributionId(wslDistributionId)
.outputReplacements(true)
.characterRanges(ranges.stream().map(RangeUtils::toStringRange).collect(Collectors.toList()))
.build();

@SuppressWarnings("for-rollout:NullAway")
Optional<String> output =
FormatterCommandRunner.runWithStdin(command.toArgs(), input, Optional.of(jdkPath.getParent()));
Optional<String> output = FormatterCommandRunner.runWithStdin(
command.toArgs(),
input,
wslDistributionId.isPresent() ? Optional.empty() : Optional.of(jdkPath.getParent()));
if (output.isEmpty() || output.get().isEmpty()) {
return ImmutableList.of();
}
Expand All @@ -102,9 +116,13 @@ private String runFormatterCommand(String input) throws IOException {
.jdkPath(jdkPath)
.withJvmArgsForVersion(jdkMajorVersion)
.implementationClasspath(implementationClassPath)
.wslDistributionId(wslDistributionId)
.outputReplacements(false)
.build();
return FormatterCommandRunner.runWithStdin(command.toArgs(), input, Optional.ofNullable(jdkPath.getParent()))
return FormatterCommandRunner.runWithStdin(
command.toArgs(),
input,
wslDistributionId.isPresent() ? Optional.empty() : Optional.ofNullable(jdkPath.getParent()))
.orElse(input);
}

Expand All @@ -114,21 +132,38 @@ interface FormatterCliArgs {

boolean outputReplacements();

Optional<String> wslDistributionId();

Path jdkPath();

List<Path> implementationClasspath();

List<String> jvmArgs();

default List<String> toArgs() {
ImmutableList.Builder<String> args = ImmutableList.<String>builder()
.add(jdkPath().toAbsolutePath().toString())
ImmutableList.Builder<String> args = ImmutableList.<String>builder();

String pathSeparator;
Function<Path, String> pathToString;
if (wslDistributionId().isPresent()) {
pathSeparator = ":";
pathToString = path -> path.toString().replace('\\', '/');

args.add("wsl", "-d", wslDistributionId().get());
args.add("--cd", pathToString.apply(jdkPath().getParent()));
} else {
pathSeparator = System.getProperty("path.separator");
pathToString = path -> path.toAbsolutePath().toString();
}

args.add()
.add(pathToString.apply(jdkPath()))
.addAll(jvmArgs())
.add(
"-cp",
implementationClasspath().stream()
.map(path -> path.toAbsolutePath().toString())
.collect(Collectors.joining(System.getProperty("path.separator"))))
.map(pathToString)
.collect(Collectors.joining(pathSeparator)))
.add(FORMATTER_MAIN_CLASS);

if (!characterRanges().isEmpty()) {
Expand Down