Add an user setting to control whether to build the workspace before debugging (#485)

* Add an user setting to control whether to build the workspace before debuging

Signed-off-by: Jinbo Wang <jinbwan@microsoft.com>

* Add Chinese translation for the new setting

Signed-off-by: Jinbo Wang <jinbwan@microsoft.com>

Author: testforstephen

README.md

@@ -91,6 +91,7 @@ Please also check the documentation of [Language Support for Java by Red Hat](ht
 - `java.debug.settings.maxStringLength`: the maximum length of string displayed in "Variables" or "Debug Console" viewlet, the string longer than this length will be trimmed, defaults to `0` which means no trim is performed.
 - `java.debug.settings.enableHotCodeReplace`: enable hot code replace for Java code. Make sure the auto build is not disabled for [VSCode Java](https://github.com/redhat-developer/vscode-java). See the [wiki page](https://github.com/Microsoft/vscode-java-debug/wiki/Hot-Code-Replace) for more information about usages and limitations.
 - `java.debug.settings.enableRunDebugCodeLens`: enable the code lens provider for the run and debug buttons over main entry points, defaults to `true`.
+- `java.debug.settings.forceBuildBeforeLaunch`: force building the workspace before launching java program, defaults to `true`.
 
 ## Troubleshooting
 Reference the [troubleshooting guide](https://github.com/Microsoft/vscode-java-debug/blob/master/Troubleshooting.md) for common errors.

package.json

@@ -394,6 +394,11 @@
           "type": "boolean",
           "description": "%java.debugger.configuration.enableRunDebugCodeLens.description%",
           "default": true
+        },
+        "java.debug.settings.forceBuildBeforeLaunch": {
+          "type": "boolean",
+          "description": "%java.debugger.configuration.forceBuildBeforeLaunch%",
+          "default": true
         }
       }
     }

package.nls.json

@@ -36,5 +36,6 @@
     "java.debugger.configuration.showQualifiedNames.description": "Show fully qualified class names in \"Variables\" viewlet.",
     "java.debugger.configuration.maxStringLength.description": "The maximum length of strings displayed in \"Variables\" or \"Debug Console\" viewlet, strings longer than this length will be trimmed, if 0 no trim is performed.",
     "java.debugger.configuration.enableHotCodeReplace.description": "Enable hot code replace for Java code.",
-    "java.debugger.configuration.enableRunDebugCodeLens.description": "Enable the run and debug code lens providers over main methods."
+    "java.debugger.configuration.enableRunDebugCodeLens.description": "Enable the run and debug code lens providers over main methods.",
+    "java.debugger.configuration.forceBuildBeforeLaunch": "Force building the workspace before launching java program."
 }

package.nls.zh.json

@@ -36,5 +36,6 @@
     "java.debugger.configuration.showQualifiedNames.description": "在“变量”视图中显示类的全名。",
     "java.debugger.configuration.maxStringLength.description": "设定“变量”或“调试控制台”视图中显示的字符串最大长度，长度超过部分将被剪掉。如果值为0，则不执行修剪。",
     "java.debugger.configuration.enableHotCodeReplace.description": "为Java代码启用热代码替换。",
-    "java.debugger.configuration.enableRunDebugCodeLens.description": "在main方法上启用CodeLens标记。"
+    "java.debugger.configuration.enableRunDebugCodeLens.description": "在main方法上启用CodeLens标记。",
+    "java.debugger.configuration.forceBuildBeforeLaunch": "在启动java程序之前强制编译整个工作空间。"
 }

src/configurationProvider.ts

@@ -147,16 +147,18 @@ export class JavaDebugConfigurationProvider implements vscode.DebugConfiguration
             }
 
             if (config.request === "launch") {
-                try {
-                    const buildResult = await vscode.commands.executeCommand(commands.JAVA_BUILD_WORKSPACE, false);
-                } catch (err) {
-                    const ans = await utility.showErrorMessageWithTroubleshooting({
-                        message: "Build failed, do you want to continue?",
-                        type: Type.USAGEERROR,
-                        anchor: anchor.BUILD_FAILED,
-                    }, "Proceed", "Abort");
-                    if (ans !== "Proceed") {
-                        return undefined;
+                if (needsBuildWorkspace()) {
+                    try {
+                        const buildResult = await vscode.commands.executeCommand(commands.JAVA_BUILD_WORKSPACE, false);
+                    } catch (err) {
+                        const ans = await utility.showErrorMessageWithTroubleshooting({
+                            message: "Build failed, do you want to continue?",
+                            type: Type.USAGEERROR,
+                            anchor: anchor.BUILD_FAILED,
+                        }, "Proceed", "Abort");
+                        if (ans !== "Proceed") {
+                            return undefined;
+                        }
                     }
                 }
 
@@ -475,6 +477,11 @@ async function updateDebugSettings() {
     }
 }
 
+function needsBuildWorkspace(): boolean {
+    const debugSettingsRoot: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration("java.debug.settings");
+    return debugSettingsRoot ? debugSettingsRoot.forceBuildBeforeLaunch : true;
+}
+
 function convertLogLevel(commonLogLevel: string) {
     // convert common log level to java log level
     switch (commonLogLevel.toLowerCase()) {