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 redhat-developer#2144

Signed-off-by: David Thompson <davthomp@redhat.com>

Author: datho7561

README.md

@@ -213,6 +213,7 @@ The following settings are supported:
 
 New in 1.13.0
 * `java.compile.nullAnalysis.mode`: Specify how to enable the annotation-based null analysis. Supported values are `disabled` (disable the null analysis), `interactive` (asks when null annotation types are detected), `automatic` (automatically enable null analysis when null annotation types are detected). Defaults to `disabled`.
+* `java.cleanup.actionsOnSave`: 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](document/_java.learnMoreAboutCleanUps.md#java-clean-ups) to learn more about what each clean up does.
 
 Semantic Highlighting
 ===============

document/_java.learnMoreAboutCleanUps.md

@@ -0,0 +1,124 @@
+# Java Clean Ups
+
+Java clean ups are run on the current document whenever it's saved.
+They can fix a wide variety of issues, from code style to programming mistakes,
+and can even modernize the sources based on new Java language features.
+Here is some information on the supported cleanups and the details of what they do.
+
+### `qualifyMembers`
+
+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;
+}
+```
+
+### `qualifyStaticMembers`
+
+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;
+	}
+}
+```
+
+### `addOverride`
+
+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!");
+	}
+}
+```
+
+### `addDeprecated`
+
+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

@@ -997,6 +997,21 @@
           "default": "disabled",
           "markdownDescription": "Specify how to enable the annotation-based null analysis.",
           "scope": "window"
+        },
+        "java.cleanup.actionsOnSave": {
+          "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": [
+              "qualifyMembers",
+              "qualifyStaticMembers",
+              "addOverride",
+              "addDeprecated"
+            ]
+          },
+          "default": [],
+          "scope": "window"
         }
       }
     },
@@ -1129,6 +1144,11 @@
         "command": "java.project.createModuleInfo.command",
         "title": "%java.project.createModuleInfo.command%",
         "category": "Java"
+      },
+      {
+        "command": "_java.learnMoreAboutCleanUps",
+        "title": "Learn more about Java Clean Ups",
+        "category": "Java"
       }
     ],
     "keybindings": [

src/commands.ts

@@ -267,6 +267,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/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.');