Add a global setting to specify the default console to launch the program (#594)

* Add a global setting to specify the default console to launch the program

Signed-off-by: Jinbo Wang <[email protected]>

* Address review comments

Signed-off-by: Jinbo Wang <[email protected]>

Author: testforstephen

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Add a debug toolbar button to apply the changed classes to the running application. [#559](https://github.com/microsoft/vscode-java-debug/issues/559). 
 - Show toString() values in Variable window and hover tooltip. [#315](https://github.com/microsoft/vscode-java-debug/issues/315), [#364](https://github.com/microsoft/vscode-java-debug/issues/364).
+- Add a global user setting `java.debug.settings.console` to specify the default console to launch your program. [PR#594](https://github.com/microsoft/vscode-java-debug/pull/594).
 
 ### Fixed:
 - Fix: The debug toolbar doesn't close after the program running in external terminal exits. [#582](https://github.com/microsoft/vscode-java-debug/issues/582).

README.md

@@ -59,7 +59,7 @@ Please also check the documentation of [Language Support for Java by Red Hat](ht
 - `cwd` - The working directory of the program. Defaults to `${workspaceFolder}`.
 - `env` - The extra environment variables for the program.
 - `stopOnEntry` - Automatically pause the program after launching.
-- `console` - The specified console to launch the program. Defaults to `internalConsole`.
+- `console` - The specified console to launch the program. If not specified, use the console specified by the `java.debug.settings.console` user setting.
   - `internalConsole` - VS Code debug console (input stream not supported).
   - `integratedTerminal` - VS Code integrated terminal.
   - `externalTerminal` - External terminal that can be configured in user settings.
@@ -102,6 +102,10 @@ Please also check the documentation of [Language Support for Java by Red Hat](ht
   - never - Never apply the changes.
 - `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`.
+- `java.debug.settings.console`: The specified console to launch Java program, defaults to `internalConsole`. If you want to customize the console for a specific debug session, please modify the 'console' config in launch.json.
+  - `internalConsole` - VS Code debug console (input stream not supported).
+  - `integratedTerminal` - VS Code integrated terminal.
+  - `externalTerminal` - External terminal that can be configured in user settings.
 
 ## Troubleshooting
 Reference the [troubleshooting guide](https://github.com/Microsoft/vscode-java-debug/blob/master/Troubleshooting.md) for common errors.

package.json

@@ -457,6 +457,21 @@
           "type": "boolean",
           "description": "%java.debugger.configuration.forceBuildBeforeLaunch%",
           "default": true
+        },
+        "java.debug.settings.console": {
+          "type": "string",
+          "enum": [
+            "internalConsole",
+            "integratedTerminal",
+            "externalTerminal"
+          ],
+          "enumDescriptions": [
+            "%java.debugger.launch.internalConsole.description%",
+            "%java.debugger.launch.integratedTerminal.description%",
+            "%java.debugger.launch.externalTerminal.description%"
+          ],
+          "description": "%java.debugger.configuration.console%",
+          "default": "internalConsole"
         }
       }
     }

package.nls.json

@@ -44,5 +44,6 @@
     "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.hotCodeReplace.description": "Reload the changed Java classes during debugging. Make sure 'java.autobuild.enabled' is not disabled.",
     "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."
+    "java.debugger.configuration.forceBuildBeforeLaunch": "Force building the workspace before launching java program.",
+    "java.debugger.configuration.console": "The specified console to launch Java program. If you want to customize the console for a specific debug session, please modify the 'console' config in launch.json."
 }

package.nls.zh.json

@@ -44,5 +44,6 @@
     "java.debugger.configuration.maxStringLength.description": "设定“变量”或“调试控制台”视图中显示的字符串最大长度，长度超过部分将被剪掉。如果值为0，则不执行修剪。",
     "java.debugger.configuration.hotCodeReplace.description": "在调试期间重新加载已更改的Java类。确保未禁用'java.autobuild.enabled'。",
     "java.debugger.configuration.enableRunDebugCodeLens.description": "在main方法上启用CodeLens标记。",
-    "java.debugger.configuration.forceBuildBeforeLaunch": "在启动java程序之前强制编译整个工作空间。"
+    "java.debugger.configuration.forceBuildBeforeLaunch": "在启动java程序之前强制编译整个工作空间。",
+    "java.debugger.configuration.console": "指定的控制台用于启动Java程序。如果要为特定的调试会话自定义控制台，请修改launch.json中的“console”配置。"
 }

src/configurationProvider.ts

@@ -148,6 +148,12 @@ export class JavaDebugConfigurationProvider implements vscode.DebugConfiguration
             }
 
             if (config.request === "launch") {
+                // If the user doesn't specify 'console' in launch.json, use the global setting to get the launch console.
+                if (!config.console) {
+                    const debugSettings: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration("java.debug.settings");
+                    config.console = debugSettings.console;
+                }
+
                 if (needsBuildWorkspace()) {
                     try {
                         const buildResult = await vscode.commands.executeCommand(commands.JAVA_BUILD_WORKSPACE, false);