Add build flags into extension settings (#156)

* Add build flags into extension settings

* Small fix by Lint Check

* Small fix by Lint Check2

* Small fix by Copilot

* Refine description and variables

* Refine description and change flag order

* Change flag order2

Author: jthuangarm

package.json

@@ -374,10 +374,11 @@
             "default": true,
             "description": "Validate project input file(s) against schema"
           },
-          "debug": {
-            "type": "boolean",
-            "default": false,
-            "description": "Enable debug messages"
+          "buildOutputVerbosity": {
+            "type": "string",
+            "default": "normal",
+            "enum": [ "quiet", "normal", "verbose", "debug" ],
+            "description": "Controls the verbosity of the output generated by cbuild."
           },
           "intermediateDirectory": {
             "type": "string",
@@ -1366,6 +1367,18 @@
           },
           "default": {},
           "markdownDescription": "Specify additional environment variables to be set for build, run, and terminals."
+        },
+        "cmsis-csolution.buildOutputVerbosity": {
+          "type": "string",
+          "default": "normal",
+          "enum": [ "quiet", "normal", "verbose", "debug"],
+          "enumDescriptions": [
+            "Only errors",
+            "Standard output",
+            "Detailed steps",
+            "Internal/debug info"
+          ],
+          "markdownDescription": "Controls the verbosity of output generated by the `cbuild` and `cbuild setup` processes."
         }
       }
     },

src/manifest.ts

@@ -42,6 +42,7 @@ export const UV2CSOLUTION_PATH_ENV_VAR = 'UV2CSOLUTION_PATH';
 export const CONFIG_DOWNLOAD_MISSING_PACKS = 'downloadPacks';
 export const OUTPUT_DIRECTORY = 'outputDirectory';
 export const CONFIG_AUTO_DEBUG_LAUNCH = 'autoDebugLaunch';
+export const CONFIG_BUILD_OUTPUT_VERBOSITY = 'buildOutputVerbosity';
 
 export const MIN_TOOLBOX_VERSION = '2.12.0';
 

src/tasks/build/build-runner.test.ts

@@ -17,7 +17,7 @@
 import 'jest';
 import { cancellationTokenFactory } from '../../vscode-api/with-progress-provider.factories';
 import { MockProcessManager, processManagerFactory } from '../../vscode-api/runner/process-manager.factories';
-import { BuildTaskDefinition } from './build-task-definition';
+import { BuildTaskDefinition, BuildOutputVerbosity } from './build-task-definition';
 import { BuildRunner, cbuildArgsFromTaskDefinition } from './build-runner';
 import { HandleBuildEnoent } from './handle-enoent';
 import { CmsisToolboxManager, CmsisToolboxManagerImpl } from '../../solutions/cmsis-toolbox';
@@ -65,7 +65,7 @@ describe('BuildRunner', () => {
                 type: 'some-task',
                 solution: 'some-solution',
                 clean: true,
-                debug: true,
+                buildOutputVerbosity: 'debug',
                 intermediateDirectory: 'some-int-dir',
                 outputDirectory: 'some-output-dir',
                 cmakeTarget: 'cmake-target',
@@ -148,6 +148,30 @@ describe('BuildRunner', () => {
         });
     });
 
+    describe('log level flags', () => {
+        it.each([
+            ['quiet', '--quiet'],
+            ['normal', undefined],
+            ['verbose', '--verbose'],
+            ['debug', '--debug'],
+        ])('maps build output verbosity %s to flag %s', (outputVerbosity, expectedFlag) => {
+            const buildTaskDefinition: BuildTaskDefinition = {
+                type: 'some-task',
+                solution: 'some-solution',
+                buildOutputVerbosity: outputVerbosity as BuildOutputVerbosity,
+            };
+
+            const args = cbuildArgsFromTaskDefinition(buildTaskDefinition);
+            if (expectedFlag) {
+                expect(args).toContain(expectedFlag);
+            } else {
+                expect(args).not.toContain('--quiet');
+                expect(args).not.toContain('--verbose');
+                expect(args).not.toContain('--debug');
+            }
+        });
+    });
+
     describe('run', () => {
         it('spawns a process with the params from the given build task definition', async () => {
             const buildTaskDefinition: BuildTaskDefinition = {

src/tasks/build/build-runner.ts

@@ -17,7 +17,7 @@
 import { CmsisToolboxManager } from '../../solutions/cmsis-toolbox';
 import { getOutputDirectory } from '../../util';
 import { CancellationToken, Runner } from '../../vscode-api/runner/runner';
-import { BuildTaskDefinition } from './build-task-definition';
+import { BuildTaskDefinition, BuildOutputVerbosity } from './build-task-definition';
 import type { TerminalDimensions } from 'vscode';
 
 export const cbuildArgsFromTaskDefinition = (definition: BuildTaskDefinition): string[] => {
@@ -35,8 +35,9 @@ export const cbuildArgsFromTaskDefinition = (definition: BuildTaskDefinition): s
         executionArgs.push('--clean');
     }
 
-    if (definition.debug) {
-        executionArgs.push('--debug');
+    const buildOutputFlag = VERBOSITY_TO_FLAG[definition.buildOutputVerbosity ?? 'normal'];
+    if (buildOutputFlag) {
+        executionArgs.push(buildOutputFlag);
     }
 
     if (definition.generator) {
@@ -95,6 +96,13 @@ export const cbuildArgsFromTaskDefinition = (definition: BuildTaskDefinition): s
     return executionArgs;
 };
 
+const VERBOSITY_TO_FLAG: Record<BuildOutputVerbosity, string | undefined> = {
+    quiet: '--quiet',
+    normal: undefined,
+    verbose: '--verbose',
+    debug: '--debug',
+};
+
 export class BuildRunner implements Runner {
     public constructor(
         private readonly cmsisToolboxManager: CmsisToolboxManager,

src/tasks/build/build-task-definition-builder.test.ts

@@ -38,6 +38,7 @@ describe('BuildTaskDefinitionBuilderImpl', () => {
                 setup: false,
                 clean: false,
                 rebuild: false,
+                buildOutputVerbosity: 'normal',
                 downloadPacks: true,
                 active: undefined,
                 cmakeTarget: 'all',
@@ -64,6 +65,7 @@ describe('BuildTaskDefinitionBuilderImpl', () => {
                 setup: false,
                 clean: false,
                 rebuild: false,
+                buildOutputVerbosity: 'normal',
                 downloadPacks: false,
                 active: undefined,
                 cmakeTarget: 'all',
@@ -89,6 +91,7 @@ describe('BuildTaskDefinitionBuilderImpl', () => {
                 setup: false,
                 clean: false,
                 rebuild: true,
+                buildOutputVerbosity: 'normal',
                 downloadPacks: true,
                 active: undefined,
                 cmakeTarget: 'all',
@@ -113,6 +116,7 @@ describe('BuildTaskDefinitionBuilderImpl', () => {
                 setup: false,
                 clean: true,
                 rebuild: false,
+                buildOutputVerbosity: 'normal',
                 downloadPacks: true,
                 active: undefined,
                 cmakeTarget: 'all',
@@ -137,6 +141,7 @@ describe('BuildTaskDefinitionBuilderImpl', () => {
                 setup: true,
                 clean: false,
                 rebuild: false,
+                buildOutputVerbosity: 'normal',
                 downloadPacks: true,
                 active: undefined,
                 cmakeTarget: 'database',
@@ -157,5 +162,21 @@ describe('BuildTaskDefinitionBuilderImpl', () => {
 
             expect(createDefinition).rejects.toThrow('No active solution set');
         });
+
+        it('reads buildOutputVerbosity from configuration if non-default value is set', async () => {
+            const solutionManager = solutionManagerFactory();
+            const configProvider = configurationProviderFactory();
+            configProvider.getConfigVariable.mockImplementation((name: string) => {
+                return (name === manifest.CONFIG_BUILD_OUTPUT_VERBOSITY) ? 'verbose' : undefined;
+            });
+            const buildTaskDefinitionBuilder = new BuildTaskDefinitionBuilderImpl(
+                solutionManager,
+                configProvider,
+            );
+
+            const taskDefinition = await buildTaskDefinitionBuilder.createDefinitionFromUriOrSolutionNode('build');
+
+            expect(taskDefinition.buildOutputVerbosity).toBe('verbose');
+        });
     });
 });

src/tasks/build/build-task-definition-builder.ts

@@ -16,7 +16,7 @@
 
 import * as vscode from 'vscode';
 import { SolutionManager } from '../../solutions/solution-manager';
-import { BuildTaskDefinition, createLocalDefinitionFromUriOrSolutionNode } from './build-task-definition';
+import { BuildTaskDefinition, createLocalDefinitionFromUriOrSolutionNode, BuildOutputVerbosity } from './build-task-definition';
 import * as manifest from '../../manifest';
 import { ConfigurationProvider } from '../../vscode-api/configuration-provider';
 import { COutlineItem } from '../../views/solution-outline/tree-structure/solution-outline-item';
@@ -44,6 +44,14 @@ export class BuildTaskDefinitionBuilderImpl implements BuildTaskDefinitionBuilde
         return solutionPath;
     }
 
+    private getBuildOutputVerbosity(): BuildOutputVerbosity {
+        const verbosity = this.configProvider.getConfigVariable<BuildOutputVerbosity>(manifest.CONFIG_BUILD_OUTPUT_VERBOSITY);
+        if (typeof verbosity !== 'string') {
+            return 'normal';
+        }
+        return verbosity;
+    }
+
     private isDownloadPacksEnabled(): boolean {
         return this.configProvider.getConfigVariable<boolean>(manifest.CONFIG_DOWNLOAD_MISSING_PACKS) ?? true;
     }
@@ -55,6 +63,7 @@ export class BuildTaskDefinitionBuilderImpl implements BuildTaskDefinitionBuilde
             clean: action === 'clean',
             rebuild: action === 'rebuild',
             setup: action === 'setup',
+            buildOutputVerbosity: this.getBuildOutputVerbosity(),
             downloadPacks: this.isDownloadPacksEnabled(),
             cmakeTarget: action === 'setup' ? 'database' : 'all',
             west: this.solutionManager.getCsolution()?.getCproject()?.projectType === 'West'

src/tasks/build/build-task-definition.ts

@@ -23,7 +23,7 @@ export type BuildTaskDefinition = {
     readonly type: string;
     solution?: string;
     clean?: boolean;
-    debug?: boolean;
+    buildOutputVerbosity?: BuildOutputVerbosity;
     intermediateDirectory?: string;
     outputDirectory?: string;
     cmakeTarget?: string;
@@ -39,6 +39,8 @@ export type BuildTaskDefinition = {
     west?: boolean;
 };
 
+export type BuildOutputVerbosity = 'quiet' | 'normal' | 'verbose' | 'debug';
+
 type UriOrSolutionNode = vscode.Uri | COutlineItem;
 
 const LOCAL_BUILD_TASK_TYPE = `${PACKAGE_NAME}.build`;