Skip to content

Prefer in-process formatter when javac modules are exported #1180

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
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Prefer in-process formatter when javac modules are exported #1180

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
35 changes: 26 additions & 9 deletions 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 @@ -22,13 +22,11 @@
import com.google.common.base.Preconditions;
import com.intellij.ide.plugins.IdeaPluginDescriptor;
import com.intellij.ide.plugins.PluginManager;
import com.intellij.openapi.application.ApplicationInfo;
import com.intellij.openapi.extensions.PluginId;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.projectRoots.JdkUtil;
import com.intellij.openapi.projectRoots.Sdk;
import com.intellij.openapi.roots.ProjectRootManager;
import com.intellij.openapi.util.BuildNumber;
import com.intellij.openapi.util.SystemInfo;
import com.palantir.javaformat.bootstrap.BootstrappingFormatterService;
import com.palantir.javaformat.java.FormatterService;
Expand Down Expand Up @@ -79,8 +77,7 @@ private static Optional<FormatterService> createFormatter(FormatterCacheKey cach

// When running with JDK 15+ or using newer language features, we use the bootstrapping formatter which injects
// required "--add-exports" args.
if (useBootstrappingFormatter(
jdkMajorVersion, ApplicationInfo.getInstance().getBuild())) {
if (useBootstrappingFormatter(jdkMajorVersion, Runtime.version().feature())) {
Path jdkPath = getJdkPath(cacheKey.project);
log.info("Using bootstrapping formatter with jdk version {} and path: {}", jdkMajorVersion, jdkPath);
return Optional.of(new BootstrappingFormatterService(jdkPath, jdkMajorVersion, implementationClasspath));
Expand All @@ -96,12 +93,32 @@ private static Optional<FormatterService> createFormatter(FormatterCacheKey cach
/**
* When projects use JDK 15+ as their SDK, they might use newer language features which are only supported by the
* bootstrapping formatter.
* Separately, starting from 2022.2 (branch number '222'), Intellij now runs with JDK 17 which also requires the
* bootstrapping formatter. See https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html for
* how the build number is formatted.
* Separately, starting from 2022.2, Intellij now runs with JDK 17 which also requires the
* bootstrapping formatter unless custom VM Options to add exports are provided.
*/
private static boolean useBootstrappingFormatter(int jdkMajorVersion, BuildNumber buildNumber) {
return jdkMajorVersion >= 15 || buildNumber.getBaselineVersion() >= 222;
private static boolean useBootstrappingFormatter(int jdkMajorVersion, int jreMajorVersion) {
return (jreMajorVersion < 15 && jdkMajorVersion >= 15) || !isModulesExported();
}

private static boolean isModulesExported() {
return Stream.of(
"com.sun.tools.javac.api.JavacTrees",
"com.sun.tools.javac.file.JavacFileManager",
"com.sun.tools.javac.parser.JavacParser",
"com.sun.tools.javac.tree.JCTree",
"com.sun.tools.javac.util.Log")
.allMatch(className -> {
Class<?> klass;
try {
klass = Class.forName(className);
} catch (ClassNotFoundException e) {
return false;
}
return klass.getModule()
.isExported(
klass.getPackageName(),
FormatterProvider.class.getClassLoader().getUnnamedModule());
});
}

private static List<Path> getProvidedImplementationUrls(List<URI> implementationClasspath) {
Expand Down