implement microsoft#2521 by adding output channel argument

stepeos · May 21, 2024 · f72a9cb · f72a9cb
1 parent cb43dba
commit f72a9cb
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 5 deletions.
diff --git a/package.json b/package.json
@@ -3466,12 +3466,14 @@
           "enum": [
             "focus",
             "always",
-            "never"
+            "never",
+            "on error"
           ],
           "enumDescriptions": [
             "%cmake-tools.configuration.cmake.revealLog.focus.description%",
             "%cmake-tools.configuration.cmake.revealLog.always.description%",
-            "%cmake-tools.configuration.cmake.revealLog.never.description%"
+            "%cmake-tools.configuration.cmake.revealLog.never.description%",
+            "%cmake-tools.configuration.cmake.revealLog.onError.description%"
           ],
           "description": "%cmake-tools.configuration.cmake.revealLog.description%"
         },

diff --git a/package.nls.json b/package.nls.json
@@ -249,6 +249,7 @@
     "cmake-tools.configuration.cmake.revealLog.focus.description": "The log appears and the output channel takes the cursor focus.",
     "cmake-tools.configuration.cmake.revealLog.always.description": "The log appears but the output channel doesn't take the cursor focus.",
     "cmake-tools.configuration.cmake.revealLog.never.description": "The log neither appears nor takes the focus.",
+    "cmake-tools.configuration.cmake.revealLog.onError.description": "The log appears only when the build or the configuration fails.",
     "cmake-tools.configuration.cmake.exportCompileCommandsFile.description": "Enables exporting compile_commands.json. This only is used in Kits scenarios. In Presets scenarios, please set this by using CMakePresets.json",
     "cmake-tools.configuration.cmake.useCMakePresets.description": "Use CMakePresets.json to configure drive CMake configure, build, and test. When using CMakePresets.json, kits, variants, and some settings in settings.json will be ignored.",
     "cmake-tools.configuration.cmake.allowCommentsInPresetsFile.description": "Allow the use of JSON extensions such as comments in CMakePresets.json. Please note that your CMakePresets.json file may be considered invalid by other IDEs or on the command line if you use non-standard JSON.",

diff --git a/src/cmakeProject.ts b/src/cmakeProject.ts
@@ -1611,6 +1611,7 @@ export class CMakeProject {
                                     await enableFullFeatureSet(true);
                                     await this.refreshCompileDatabase(drv.expansionOptions);
                                 } else if (result.result !== 0 && (await this.getCMakeExecutable()).isDebuggerSupported && cmakeConfiguration.get(showDebuggerConfigurationString) && !forciblyCanceled && result.resultType === ConfigureResultType.NormalOperation) {
+                                    log.showChannel(true);
                                     const yesButtonTitle: string = localize(
                                         "yes.configureWithDebugger.button",
                                         "Debug"
@@ -1947,6 +1948,9 @@ export class CMakeProject {
                 buildLogger.info(localize('starting.build', 'Starting build'));
                 await setContextAndStore(isBuildingKey, true);
                 rc = await drv!.build(newTargets, taskConsumer, isBuildCommand);
+                if (rc !== 0) {
+                    log.showChannel(true); // in case build has failed
+                }
                 await setContextAndStore(isBuildingKey, false);
                 if (rc === null) {
                     buildLogger.info(localize('build.was.terminated', 'Build was terminated'));
@@ -1977,6 +1981,9 @@ export class CMakeProject {
                         await setContextAndStore(isBuildingKey, true);
                         const rc = await drv!.build(newTargets, consumer, isBuildCommand);
                         await setContextAndStore(isBuildingKey, false);
+                        if (rc !== 0) {
+                            log.showChannel(true); // in case build has failed
+                        }
                         if (rc === null) {
                             buildLogger.info(localize('build.was.terminated', 'Build was terminated'));
                         } else {

diff --git a/src/logging.ts b/src/logging.ts
@@ -23,7 +23,7 @@ enum LogLevel {
     Fatal,
 }
 
-type RevealLogKey = 'always' | 'never' | 'focus';
+type RevealLogKey = 'always' | 'never' | 'focus' | 'on error';
 
 /**
  * Get the name of a logging level
@@ -252,10 +252,17 @@ export class Logger {
         SingletonLogger.instance().clearOutputChannel();
     }
 
-    showChannel() {
+    showChannel(target_failed?: boolean) {
         const reveal_log = vscode.workspace.getConfiguration('cmake').get<RevealLogKey>('revealLog', 'always');
 
-        const should_show = (reveal_log !== 'never');
+        let should_show: boolean = false;
+        if (reveal_log === 'always') {
+            should_show = true;
+        }
+        // won't show if no target information
+        if (reveal_log === 'on error' && target_failed !== undefined) {
+            should_show = target_failed;
+        }
         const should_focus = (reveal_log === 'focus');
 
         if (should_show) {