Improving Logging Behavior (#4770)

* Enhance CMakeOutputConsumer logging: log milestone stdout at info level and routine stdout at debug level

* Refactor CMakeOutputConsumer: make milestone regex static and improve comments

---------

Co-authored-by: Hannia Valera <[email protected]>

Author: hanniavalera

src/diagnostics/cmake.ts

@@ -21,6 +21,21 @@ export enum StateMessage {
  * in conjunction with `proc.execute`.
  */
 export class CMakeOutputConsumer extends CommandConsumer {
+    /**
+     * Matches CMake status lines that signal key configure/generate lifecycle
+     * milestones.  These are always logged at `info` so they remain visible at
+     * the default logging level.  All other stdout lines use `debug`, keeping
+     * the Output panel concise while still being one setting-change away.
+     *
+     * Matched patterns (all prefixed with `-- `):
+     *   Configuring done           / Configuring done (0.1s)
+     *   Configuring incomplete, errors occurred!
+     *   Generating done
+     *   Build files have been written to: <path>
+     */
+    private static readonly _milestoneRe =
+        /^-- +(Configuring (done|incomplete)|Generating done|Build files have been written to:)/;
+
     constructor(readonly sourceDir: string, readonly logger?: Logger) {
         super();
     }
@@ -46,12 +61,18 @@ export class CMakeOutputConsumer extends CommandConsumer {
     private readonly _stateMessages: StateMessage[] = [];
 
     /**
-     * Simply writes the line of output to the log
+     * Writes the line of output to the log at a tiered level:
+     * - Milestone lines (configure/generate done, build files written) → info
+     * - All other CMake stdout → debug
      * @param line Line of output
      */
     output(line: string) {
         if (this.logger) {
-            this.logger.trace(line);
+            if (CMakeOutputConsumer._milestoneRe.test(line)) {
+                this.logger.info(line);
+            } else {
+                this.logger.debug(line);
+            }
         }
         super.output(line);
         this._parseDiags(line);

test/unit-tests/diagnostics.test.ts

@@ -1358,16 +1358,33 @@ suite('Diagnostics', () => {
         consumer.dispose();
     });
 
-    test('CMakeOutputConsumer logs stdout lines at trace level, not info', () => {
+    test('CMakeOutputConsumer logs milestone stdout at info and routine stdout at debug', () => {
         const spy = new SpyLogger();
         const consumerWithLogger = new CMakeOutputConsumer('dummyPath', spy);
+        // Routine CMake status lines → debug
+        consumerWithLogger.output('-- The C compiler identification is GNU 9.3.0');
+        consumerWithLogger.output('-- Detecting CXX compiler ABI info');
+        // Milestone lines → info
         consumerWithLogger.output('-- Configuring done');
         consumerWithLogger.output('-- Generating done');
+        consumerWithLogger.output('-- Build files have been written to: /path/to/build');
+        consumerWithLogger.output('-- Configuring incomplete, errors occurred!');
 
-        const traceCalls = spy.calls.filter(c => c.level === 'trace');
         const infoCalls = spy.calls.filter(c => c.level === 'info');
-        expect(traceCalls.length).to.eq(2);
-        expect(infoCalls.length).to.eq(0);
+        const debugCalls = spy.calls.filter(c => c.level === 'debug');
+        const traceCalls = spy.calls.filter(c => c.level === 'trace');
+        // 4 milestones at info
+        expect(infoCalls.length).to.eq(4);
+        expect(infoCalls.map(c => c.args[0])).to.deep.eq([
+            '-- Configuring done',
+            '-- Generating done',
+            '-- Build files have been written to: /path/to/build',
+            '-- Configuring incomplete, errors occurred!'
+        ]);
+        // 2 routine lines at debug
+        expect(debugCalls.length).to.eq(2);
+        // Nothing at trace
+        expect(traceCalls.length).to.eq(0);
     });
 
     test('CMakeOutputConsumer logs stderr lines at warning level, not error', () => {