Add new settings for clean ups

- Add documentation (accessible through a command) for what each clean up does

Depends on eclipse-jdtls/eclipse.jdt.ls#2298
Closes #2144

Signed-off-by: David Thompson <[email protected]>

Author: datho7561

document/_java.learnMoreAboutCleanUps.md

@@ -0,0 +1,123 @@
+# Java Clean Ups
+
+Java clean ups are run on the current document whenever it's saved.
+They can fix code style and simple programming mistakes.
+Here is some information on the details of what each clean up does.
+
+### `memberAccessUsesThis`
+
+Whenever a member (field or method) of a class is accessed from within the class,
+prefix the access with `this`.
+This is similar to how Python requires the programmer to access members using `self`.
+
+For instance:
+
+```java
+private int value;
+
+public void getValue() {
+	return value;
+}
+```
+
+becomes:
+
+```java
+private int value;
+
+public void getValue() {
+	return this.value;
+}
+```
+
+### `staticAccessUsesClassName`
+
+Whenever there is a static variable or function, prefix the access with the name of the class that the static variable or function belongs to.
+
+For instance:
+
+```java
+import static java.lang.System.out;
+
+public class MyClass {
+	public static final double FACTOR = 0.5;
+
+	public double getNumber(double value) {
+		out.println("moo");
+		return value * FACTOR;
+	}
+}
+```
+
+becomes:
+
+```java
+import static java.lang.System.out;
+
+public class MyClass {
+	public static final double FACTOR = 0.5;
+
+	public double getNumber(double value) {
+		System.out.println("moo");
+		return value * MyClass.FACTOR;
+	}
+}
+```
+
+### `addOverrideAnnotation`
+
+When a method of a class that overrides a method from a parent class or provides an implementation for a method from an interface, add the `@Override` annotation.
+
+For example:
+
+```java
+public class MyRunner implements Runnable {
+	public void run() {
+		System.out.println("Hello, World!");
+	}
+}
+```
+
+becomes:
+
+```java
+public class MyRunner implements Runnable {
+	@Override
+	public void run() {
+		System.out.println("Hello, World!");
+	}
+}
+```
+
+### `addDeprecatedAnnotation`
+
+When a method is marked `@deprecated` in the Javadoc, but doesn't have the `@Deprecated` annotation, add the `@Deprecated` annotation.
+This only works if the compiler has been configured to mark deprecated methods without the deprecated annotation
+as an info/warning/error in the JDT settings.
+
+For example:
+
+```java
+/**
+ * Not used anymore, please stop using.
+ *
+ * @deprecated
+ */
+public boolean isAGoat() {
+	return false;
+}
+```
+
+becomes:
+
+```java
+/**
+ * Not used anymore, please stop using.
+ *
+ * @deprecated
+ */
+@Deprecated
+public boolean isAGoat() {
+	return false;
+}
+```

package.json

@@ -980,6 +980,21 @@
           ],
           "markdownDescription": "Specify the Nullable annotation types to be used for null analysis. If more than one annotation is specified, then the topmost annotation will be used first if it exists in your project dependencies.",
           "scope": "window"
+        },
+        "java.cleanup.enabled": {
+          "type": "array",
+          "markdownDescription": "The list of clean ups to be run on the current document when it's saved. Clean ups can automatically fix code style or programming mistakes. [Click here](command:_java.learnMoreAboutCleanUps) to learn more about what each clean up does.",
+          "items": {
+            "type":"string",
+            "enum": [
+              "memberAccessUsesThis",
+              "staticAccessUsesClassName",
+              "addOverrideAnnotation",
+              "addDeprecatedAnnotation"
+            ]
+          },
+          "default": [],
+          "scope": "resource"
         }
       }
     },
@@ -1112,6 +1127,11 @@
         "command": "java.project.createModuleInfo.command",
         "title": "%java.project.createModuleInfo.command%",
         "category": "Java"
+      },
+      {
+        "command": "_java.learnMoreAboutCleanUps",
+        "title": "%_java.learnMoreAboutCleanUps%",
+        "category": "Java"
       }
     ],
     "keybindings": [

package.nls.json

@@ -22,5 +22,6 @@
 	"java.action.showSupertypeHierarchy": "Show Supertype Hierarchy",
 	"java.action.showSubtypeHierarchy": "Show Subtype Hierarchy",
 	"java.action.changeBaseType": "Base on this Type",
-	"java.project.createModuleInfo.command": "Create module-info.java"
+	"java.project.createModuleInfo.command": "Create module-info.java",
+	"_java.learnMoreAboutCleanUps": "Learn more about Java Clean Ups"
 }

src/commands.ts

@@ -262,6 +262,8 @@ export namespace Commands {
 
     export const LEARN_MORE_ABOUT_REFACTORING = '_java.learnMoreAboutRefactorings';
 
+    export const LEARN_MORE_ABOUT_CLEAN_UPS = '_java.learnMoreAboutCleanUps';
+
     export const TEMPLATE_VARIABLES = '_java.templateVariables';
 
     export const NOT_COVERED_EXECUTION = '_java.notCoveredExecution';

src/extension.ts

@@ -172,6 +172,9 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 	context.subscriptions.push(commands.registerCommand(Commands.MEATDATA_FILES_GENERATION, async () => {
 		markdownPreviewProvider.show(context.asAbsolutePath(path.join('document', `_java.metadataFilesGeneration.md`)), 'Metadata Files Generation', "", context);
 	}));
+	context.subscriptions.push(commands.registerCommand(Commands.LEARN_MORE_ABOUT_CLEAN_UPS, async () => {
+		markdownPreviewProvider.show(context.asAbsolutePath(path.join('document', `${Commands.LEARN_MORE_ABOUT_CLEAN_UPS}.md`)), 'Java Clean Ups', "java-clean-ups", context);
+	}));
 	if (!storagePath) {
 		storagePath = getTempWorkspace();
 	}

test/lightweight-mode-suite/extension.test.ts

@@ -22,6 +22,7 @@ suite('Java Language Extension - LightWeight', () => {
 				Commands.OPEN_FORMATTER,
 				Commands.CLEAN_WORKSPACE,
 				Commands.SWITCH_SERVER_MODE,
+				// Commands.LEARN_MORE_ABOUT_CLEAN_UPS,
 			].sort();
 			const foundJavaCommands = commands.filter((value) => {
 				return JAVA_COMMANDS.indexOf(value)>=0 || value.startsWith('java.');

test/standard-mode-suite/extension.test.ts

@@ -86,6 +86,7 @@ suite('Java Language Extension - Standard', () => {
 				Commands.SHOW_SUBTYPE_HIERARCHY,
 				Commands.SHOW_SUPERTYPE_HIERARCHY,
 				Commands.SHOW_CLASS_HIERARCHY,
+				Commands.LEARN_MORE_ABOUT_CLEAN_UPS,
 			].sort();
 			const foundJavaCommands = commands.filter((value) => {
 				return JAVA_COMMANDS.indexOf(value)>=0 || value.startsWith('java.');