Skip to content

Also read JDT UI project prefs to configure cleanups #2870

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

Merged
rgrunber merged 1 commit into from
Sep 28, 2023
Merged

Also read JDT UI project prefs to configure cleanups #2870

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
2 changes: 1 addition & 1 deletion org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/JavaLanguageServerPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@

public class JavaLanguageServerPlugin extends Plugin {

private static final String JDT_UI_PLUGIN = "org.eclipse.jdt.ui";
public static final String JDT_UI_PLUGIN = "org.eclipse.jdt.ui";
public static final String MANUAL = "Manual";
public static final String DIRECT = "Direct";
public static final String NATIVE = "Native";
Expand Down
6 changes: 4 additions & 2 deletions ....ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/AddDeprecatedAnnotationCleanUp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.Arrays;
import java.util.Collection;
import java.util.List;

import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.manipulation.CleanUpContextCore;
import org.eclipse.jdt.core.manipulation.ICleanUpFixCore;
import org.eclipse.jdt.internal.corext.fix.CleanUpConstants;
import org.eclipse.jdt.internal.corext.fix.Java50FixCore;

/**
Expand All @@ -29,8 +31,8 @@ public class AddDeprecatedAnnotationCleanUp implements ISimpleCleanUp {
private static final List<String> COMPILER_OPTS = Arrays.asList(JavaCore.COMPILER_PB_MISSING_DEPRECATED_ANNOTATION);

@Override
public String getIdentifier() {
return "addDeprecated";
public Collection<String> getIdentifiers() {
return List.of("addDeprecated", CleanUpConstants.ADD_MISSING_ANNOTATIONS_DEPRECATED);
}

@Override
Expand Down
6 changes: 4 additions & 2 deletions ...dt.ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/AddOverrideAnnotationCleanUp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.Arrays;
import java.util.Collection;
import java.util.List;

import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.manipulation.CleanUpContextCore;
import org.eclipse.jdt.core.manipulation.ICleanUpFixCore;
import org.eclipse.jdt.internal.corext.fix.CleanUpConstants;
import org.eclipse.jdt.internal.corext.fix.Java50FixCore;

/**
Expand All @@ -29,8 +31,8 @@ public class AddOverrideAnnotationCleanUp implements ISimpleCleanUp {
private static final List<String> COMPILER_OPTS = Arrays.asList(JavaCore.COMPILER_PB_MISSING_OVERRIDE_ANNOTATION);

@Override
public String getIdentifier() {
return "addOverride";
public Collection<String> getIdentifiers() {
return List.of("addOverride", CleanUpConstants.ADD_MISSING_ANNOTATIONS_OVERRIDE);
}

@Override
Expand Down
32 changes: 23 additions & 9 deletions org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/CleanUpRegistry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,23 @@
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Status;
import org.eclipse.jdt.core.IBuffer;
import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.manipulation.CleanUpContextCore;
import org.eclipse.jdt.ls.core.internal.JDTUtils;
import org.eclipse.jdt.ls.core.internal.JavaLanguageServerPlugin;
import org.eclipse.lsp4j.TextDocumentIdentifier;
import org.eclipse.lsp4j.TextEdit;

Expand Down Expand Up @@ -55,7 +58,10 @@ public CleanUpRegistry() {

// Store in a Map so that they can be accessed by ID quickly
cleanUps = new HashMap<>();
cleanUpsList.forEach(cleanUp -> cleanUps.put(cleanUp.getIdentifier(), cleanUp));
cleanUpsList.forEach(cleanUp ->
cleanUp.getIdentifiers().forEach(id ->
cleanUps.put(id, cleanUp)
));
}

/**
Expand All @@ -72,13 +78,21 @@ public CleanUpRegistry() {
* according to the clean ups that are enabled
*/
public List<TextEdit> getEditsForAllActiveCleanUps(TextDocumentIdentifier textDocumentId, List<String> cleanUpEnabled, IProgressMonitor monitor) {

IJavaProject javaProject = JDTUtils.resolveCompilationUnit(textDocumentId.getUri()).getJavaProject();

List<ISimpleCleanUp> cleanUpsToRun = cleanUpEnabled.stream() //
.distinct() //
.map(cleanUpId -> cleanUps.get(cleanUpId)).filter(Objects::nonNull) //
.toList();
ICompilationUnit unit = JDTUtils.resolveCompilationUnit(textDocumentId.getUri());
if (unit == null) {
return List.of();
}
IJavaProject javaProject = unit.getJavaProject();

Collection<ISimpleCleanUp> cleanUpsToRun = new LinkedHashSet<>(cleanUpEnabled.size());
for (String cleanUpId : cleanUpEnabled) {
ISimpleCleanUp cleanUp = cleanUps.get(cleanUpId);
if (cleanUp != null) {
cleanUpsToRun.add(cleanUp);
} else {
JavaLanguageServerPlugin.log(Status.warning("Not found cleanup id: " + cleanUpId));
}
}
if (cleanUpsToRun.isEmpty()) {
return Collections.emptyList();
}
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/CleanUpUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public static TextEdit getTextEditFromCleanUp(ISimpleCleanUp cleanUp, CleanUpCon
TextEdit jdtEdit = cleanUpChange.getEdit();
return jdtEdit;
} catch (CoreException e) {
JavaLanguageServerPlugin.logError(String.format("Failed to create text edit for clean up %s", cleanUp.getIdentifier()));
JavaLanguageServerPlugin.logError(String.format("Failed to create text edit for clean up %s", cleanUp.getIdentifiers().iterator().next()));
}
return null;
}
Expand Down
7 changes: 4 additions & 3 deletions org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/ISimpleCleanUp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
*******************************************************************************/
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.Collection;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
Expand All @@ -25,11 +26,11 @@
public interface ISimpleCleanUp {

/**
* Returns the unique identifier for this clean up.
* Returns the possible identifiers for this clean up.
*
* @return the unique identifier for this clean up
* @return the identifiers for this clean up
*/
String getIdentifier();
Collection<String> getIdentifiers();

/**
* Returns the cleanup fix for the given source file.
Expand Down
5 changes: 3 additions & 2 deletions ...ipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/InstanceofPatternMatch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.manipulation.CleanUpContextCore;
import org.eclipse.jdt.core.manipulation.ICleanUpFixCore;
import org.eclipse.jdt.internal.corext.fix.CleanUpConstants;
import org.eclipse.jdt.internal.corext.fix.PatternMatchingForInstanceofFixCore;

/**
Expand All @@ -27,8 +28,8 @@
public class InstanceofPatternMatch implements ISimpleCleanUp {

@Override
public String getIdentifier() {
return "instanceofPatternMatch";
public List<String> getIdentifiers() {
return List.of("instanceofPatternMatch", CleanUpConstants.USE_PATTERN_MATCHING_FOR_INSTANCEOF);
}

@Override
Expand Down
5 changes: 3 additions & 2 deletions ...eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/InvertEqualsCleanUp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.manipulation.CleanUpContextCore;
import org.eclipse.jdt.core.manipulation.ICleanUpFixCore;
import org.eclipse.jdt.internal.corext.fix.CleanUpConstants;
import org.eclipse.jdt.internal.corext.fix.InvertEqualsFixCore;

/**
Expand All @@ -28,8 +29,8 @@
public class InvertEqualsCleanUp implements ISimpleCleanUp {

@Override
public String getIdentifier() {
return "invertEquals";
public List<String> getIdentifiers() {
return List.of("invertEquals", CleanUpConstants.INVERT_EQUALS);
}

@Override
Expand Down
6 changes: 4 additions & 2 deletions ...ore/src/org/eclipse/jdt/ls/core/internal/cleanup/LambdaExpressionAndMethodRefCleanUp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@
*******************************************************************************/
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.Collection;
import java.util.Collections;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.manipulation.CleanUpContextCore;
import org.eclipse.jdt.core.manipulation.ICleanUpFixCore;
import org.eclipse.jdt.internal.corext.fix.CleanUpConstants;
import org.eclipse.jdt.internal.corext.fix.LambdaExpressionAndMethodRefFixCore;

/**
Expand All @@ -27,8 +29,8 @@
public class LambdaExpressionAndMethodRefCleanUp implements ISimpleCleanUp {

@Override
public String getIdentifier() {
return "lambdaExpression";
public Collection<String> getIdentifiers() {
return List.of("lambdaExpression", CleanUpConstants.SIMPLIFY_LAMBDA_EXPRESSION_AND_METHOD_REF);
}

@Override
Expand Down
6 changes: 4 additions & 2 deletions ...pse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/LambdaExpressionCleanup.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@
*******************************************************************************/
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.Collection;
import java.util.Collections;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.manipulation.CleanUpContextCore;
import org.eclipse.jdt.core.manipulation.ICleanUpFixCore;
import org.eclipse.jdt.internal.corext.fix.CleanUpConstants;
import org.eclipse.jdt.internal.corext.fix.LambdaExpressionsFixCore;

/**
Expand All @@ -27,8 +29,8 @@
public class LambdaExpressionCleanup implements ISimpleCleanUp {

@Override
public String getIdentifier() {
return "lambdaExpressionFromAnonymousClass";
public Collection<String> getIdentifiers() {
return List.of("lambdaExpressionFromAnonymousClass", CleanUpConstants.USE_LAMBDA);
}

@Override
Expand Down
5 changes: 3 additions & 2 deletions ...jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/MemberAccessUsesThisCleanUp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
*******************************************************************************/
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.Collection;
import java.util.Collections;
import java.util.List;

Expand All @@ -28,8 +29,8 @@
public class MemberAccessUsesThisCleanUp implements ISimpleCleanUp {

@Override
public String getIdentifier() {
return "qualifyMembers";
public Collection<String> getIdentifiers() {
return List.of("qualifyMembers");
Copy link
Copy Markdown
Contributor

@rgrunber rgrunber Sep 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No interest in enabling this & qualifyStaticMembers ?

Copy link
Copy Markdown
Contributor Author

@mickaelistria mickaelistria Sep 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those cleanups don't map to a single JDT-UI cleanup id. JDT-UI has a single cleanup id for "style" which delegates to other configurations. The grain is different in JDT-LS to easily map those cleanups to a JDT-UI id

}

@Override
Expand Down
5 changes: 3 additions & 2 deletions ...s.core/src/org/eclipse/jdt/ls/core/internal/cleanup/StaticAccessUsesClassNameCleanUp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
*******************************************************************************/
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.Collection;
import java.util.Collections;
import java.util.List;

Expand All @@ -28,8 +29,8 @@
public class StaticAccessUsesClassNameCleanUp implements ISimpleCleanUp {

@Override
public String getIdentifier() {
return "qualifyStaticMembers";
public Collection<String> getIdentifiers() {
return List.of("qualifyStaticMembers");
}

@Override
Expand Down
6 changes: 4 additions & 2 deletions ....ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/StringConcatToTextBlockCleanUp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@
*******************************************************************************/
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.Collection;
import java.util.Collections;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.manipulation.CleanUpContextCore;
import org.eclipse.jdt.core.manipulation.ICleanUpFixCore;
import org.eclipse.jdt.internal.corext.fix.CleanUpConstants;
import org.eclipse.jdt.internal.corext.fix.StringConcatToTextBlockFixCore;

/**
Expand All @@ -27,8 +29,8 @@
public class StringConcatToTextBlockCleanUp implements ISimpleCleanUp {

@Override
public String getIdentifier() {
return "stringConcatToTextBlock";
public Collection<String> getIdentifiers() {
return List.of("stringConcatToTextBlock", CleanUpConstants.STRINGCONCAT_TO_TEXTBLOCK);
}

@Override
Expand Down
6 changes: 4 additions & 2 deletions ...pse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/SwitchExpressionCleanup.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@
*******************************************************************************/
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.Collection;
import java.util.Collections;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.manipulation.CleanUpContextCore;
import org.eclipse.jdt.core.manipulation.ICleanUpFixCore;
import org.eclipse.jdt.internal.corext.fix.CleanUpConstants;
import org.eclipse.jdt.internal.corext.fix.SwitchExpressionsFixCore;

/**
Expand All @@ -27,8 +29,8 @@
public class SwitchExpressionCleanup implements ISimpleCleanUp {

@Override
public String getIdentifier() {
return "switchExpression";
public Collection<String> getIdentifiers() {
return List.of("switchExpression", CleanUpConstants.CONTROL_STATEMENTS_CONVERT_TO_SWITCH_EXPRESSIONS);
}

@Override
Expand Down
6 changes: 4 additions & 2 deletions ...ipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/TryWithResourceCleanUp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@
*******************************************************************************/
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.Collection;
import java.util.Collections;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.manipulation.CleanUpContextCore;
import org.eclipse.jdt.core.manipulation.ICleanUpFixCore;
import org.eclipse.jdt.internal.corext.fix.CleanUpConstants;
import org.eclipse.jdt.internal.corext.fix.TryWithResourceFixCore;

/**
Expand All @@ -28,8 +30,8 @@
public class TryWithResourceCleanUp implements ISimpleCleanUp {

@Override
public String getIdentifier() {
return "tryWithResource";
public Collection<String> getIdentifiers() {
return List.of("tryWithResource", CleanUpConstants.TRY_WITH_RESOURCE);
}

@Override
Expand Down
6 changes: 4 additions & 2 deletions ...t.ls.core/src/org/eclipse/jdt/ls/core/internal/cleanup/VariableDeclarationFixCleanup.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@
*******************************************************************************/
package org.eclipse.jdt.ls.core.internal.cleanup;

import java.util.Collection;
import java.util.Collections;
import java.util.List;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.manipulation.CleanUpContextCore;
import org.eclipse.jdt.core.manipulation.ICleanUpFixCore;
import org.eclipse.jdt.internal.corext.fix.CleanUpConstants;
import org.eclipse.jdt.internal.corext.fix.VariableDeclarationFixCore;

/**
Expand All @@ -27,8 +29,8 @@
public class VariableDeclarationFixCleanup implements ISimpleCleanUp {

@Override
public String getIdentifier() {
return "addFinalModifier";
public Collection<String> getIdentifiers() {
return List.of("addFinalModifier", CleanUpConstants.VARIABLE_DECLARATIONS_USE_FINAL);
}

@Override
Expand Down
Loading