Add link to open merge view

Author: mguzmanm

src/desktop/extension.ts

@@ -179,7 +179,7 @@ export const activate = async (context: ExtensionContext): Promise<CsolutionExte
         cmsisToolboxManager,
         compileCommandsGenerator,
     );
-    
+
     const solutionProblems = new SolutionProblemsImpl(solutionManager, eventHub);
     const themeProvider = new ThemeProviderImpl();
     const statusBar = new StatusBar(solutionManager, cmsisToolboxManager, themeProvider);

src/manifest.ts

@@ -44,6 +44,7 @@ export const OUTPUT_DIRECTORY = 'outputDirectory';
 export const CONFIG_AUTO_DEBUG_LAUNCH = 'autoDebugLaunch';
 export const CONFIG_BUILD_OUTPUT_VERBOSITY = 'buildOutputVerbosity';
 export const MANAGE_COMPONENTS_PACKS_COMMAND_ID = `${PACKAGE_NAME}.manageComponentsPacks`;
+export const MERGE_FILE_FROM_PATH_COMMAND_ID = `${PACKAGE_NAME}.mergeFileFromPath`;
 
 export const MIN_TOOLBOX_VERSION = '2.12.0';
 

src/solutions/solution-problems.ts

@@ -17,11 +17,11 @@
 import * as path from 'node:path';
 import * as vscode from 'vscode';
 import { constructor } from '../generic/constructor';
-import { MANAGE_COMPONENTS_PACKS_COMMAND_ID } from '../manifest';
+import { MANAGE_COMPONENTS_PACKS_COMMAND_ID, MERGE_FILE_FROM_PATH_COMMAND_ID } from '../manifest';
 import { LogMessages } from '../json-rpc/csolution-rpc-client';
 import * as fsUtils from '../utils/fs-utils';
 import { getFileNameFromPath } from '../utils/path-utils';
-import { stripTwoExtensions } from '../utils/string-utils';
+import { stripTwoExtensions, stripVendor, stripVersion } from '../utils/string-utils';
 import { getWorkspaceFolder } from '../utils/vscode-utils';
 import { SolutionLoadStateChangeEvent, SolutionManager } from './solution-manager';
 import { ConvertResultData, SolutionEventHub } from './solution-event-hub';
@@ -101,6 +101,17 @@ export const enrichLogMessagesFromToolOutput = async (logMessages: LogMessages,
     warnings.forEach(w => pushUniquely(logWarnings, w));
 };
 
+export const MERGE_VIEW_LINK_LABEL = 'Open in Merge View';
+export type MergeUpdateLevel = 'required' | 'recommended' | 'suggested' | 'mandatory';
+const mergeMessageRegex = /file\s+'([^']+)'\s+update\s+(required|recommended|suggested|mandatory)/i;
+const mergeComponentRegex = /(?:for|from)\s+component\s+'([^']+)'/i;
+export interface MergeMessageMatch {
+    localPath: string;
+    updateLevel: MergeUpdateLevel;
+    matchStart: number;
+    matchLength: number;
+}
+
 export interface SolutionProblems {
     activate(context: vscode.ExtensionContext): Promise<void>;
 }
@@ -190,12 +201,15 @@ export class SolutionProblemsImpl implements SolutionProblems {
         if (!file) {
             return false;
         }
+        const mergeAction = this.createMergeDiagnosticAction(messageText, file);
         const range = await this.createDiagnosticRange(file, filename, line, column);
 
-        const entry = new vscode.Diagnostic(range, messageText, severity);
+        const entry = new vscode.Diagnostic(range, mergeAction?.message ?? messageText, severity);
         entry.source = 'csolution';
 
-        if (!line && !column) {
+        if (mergeAction) {
+            entry.code = mergeAction.code;
+        } else if (!line && !column) {
             // add 'Find in Files' action only if no line/column info is available
             entry.code = this.createDiagnosticActionCode(messageText);
         }
@@ -296,6 +310,55 @@ export class SolutionProblemsImpl implements SolutionProblems {
         return undefined;
     }
 
+    private parseMergeMessage(line: string): MergeMessageMatch | undefined {
+        const match = mergeMessageRegex.exec(line);
+        if (!match || match.index === undefined) {
+            return undefined;
+        }
+
+        return {
+            localPath: match[1],
+            updateLevel: match[2].toLowerCase() as MergeUpdateLevel,
+            matchStart: match.index,
+            matchLength: match[0].length,
+        };
+    }
+
+    private createMergeDiagnosticMessage(localPath: string, updateLevel: MergeUpdateLevel, componentId: string | undefined): string {
+        const fileName = path.basename(localPath);
+        if (componentId === undefined) {
+            return `update ${updateLevel} for config file '${fileName}' has a new version available for merge.`;
+        }
+
+        const componentIdNoVersion = stripVersion(componentId);
+        const componentDisplayName = stripVendor(componentIdNoVersion);
+        return `update ${updateLevel} for config file '${fileName}' from component '${componentDisplayName}'.`;
+    }
+
+    private createMergeCommandUri(localPath: string): vscode.Uri {
+        const args = this.encodeCommandArgs([localPath]);
+        return vscode.Uri.parse(`command:${MERGE_FILE_FROM_PATH_COMMAND_ID}?${args}`);
+    }
+
+    private createMergeDiagnosticAction(message: string, diagnosticFilePath: string): { message: string; code: NonNullable<vscode.Diagnostic['code']> } | undefined {
+        const merge = this.parseMergeMessage(message);
+        if (!merge) {
+            return undefined;
+        }
+
+        const componentId = mergeComponentRegex.exec(message)?.[1];
+        const localPath = path.isAbsolute(merge.localPath) ? merge.localPath : diagnosticFilePath;
+        const formattedMessage = this.createMergeDiagnosticMessage(localPath, merge.updateLevel, componentId);
+
+        return {
+            message: formattedMessage,
+            code: {
+                value: MERGE_VIEW_LINK_LABEL,
+                target: this.createMergeCommandUri(localPath),
+            },
+        };
+    }
+
     private encodeFindInFilesArgs(query: string): string {
         const args = {
             query: query,

src/views/solution-outline/commands/merge-command.test.ts

@@ -87,11 +87,13 @@ describe('MergeCommand', () => {
         componentNode.setTag('component');
         componentNode.setAttribute('label', 'Component X');
         componentNode.setAttribute('local', path.join(tmpDir, 'component.c'));
+        componentNode.setAttribute('resourcePath', path.join(tmpDir, 'component.c'));
 
         fileNode = new COutlineItem('file');
         fileNode.setTag('file');
         fileNode.setAttribute('label', 'Component X');
         fileNode.setAttribute('local', path.join(tmpDir, 'component.c'));
+        fileNode.setAttribute('resourcePath', path.join(tmpDir, 'component.c'));
     });
 
     describe('activation', () => {
@@ -326,6 +328,7 @@ describe('MergeCommand', () => {
             const node = new COutlineItem('file');
             const local = path.join(tmpDir, 'safe-local.c');
             node.setAttribute('local', local);
+            node.setAttribute('resourcePath', local);
 
             const commandPrivate = command as unknown as {
                 getVSCodeExecutablePath: () => string | undefined;
@@ -356,6 +359,7 @@ describe('MergeCommand', () => {
             node.setTag('file');
             node.setAttribute('label', 'Component X');
             node.setAttribute('local', local);
+            node.setAttribute('resourcePath', local);
 
             const commandPrivate = command as unknown as {
                 getVSCodeExecutablePath: () => string | undefined;

src/views/solution-outline/commands/merge-command.ts

@@ -52,6 +52,8 @@ export class MergeCommand {
             vscode.window.showErrorMessage('Cannot open merge view: merge file path is missing.');
             return;
         }
+
+        await this.runVSCodeMergeForPath(path.normalize(localPath));
     }
 
     private async runVSCodeMerge(node: COutlineItem): Promise<void> {
@@ -60,7 +62,17 @@ export class MergeCommand {
             return;
         }
 
-        const mergeFiles = this.discoverMergeFiles(node);
+        const localPath = node.getResourcePath();
+        if (!localPath) {
+            vscode.window.showErrorMessage('Required local file is missing to perform merge.');
+            return;
+        }
+
+        await this.runVSCodeMergeForPath(localPath);
+    }
+
+    private async runVSCodeMergeForPath(localPath: string): Promise<void> {
+        const mergeFiles = this.discoverMergeFiles(localPath);
         if (!mergeFiles) {
             return;
         }
@@ -78,7 +90,6 @@ export class MergeCommand {
 
         // make a copy of local to create merged file
         fsUtils.copyFile(local, merged);
-        node.setAttribute('merged', merged);
 
         // ensure all paths are absolute
         local = path.resolve(local);
@@ -112,12 +123,7 @@ export class MergeCommand {
         }
     }
 
-    private discoverMergeFiles(node: COutlineItem): { local: string; update: string; base: string } | undefined {
-        const local = node.getAttribute('local');
-        if (!local) {
-            vscode.window.showErrorMessage('Required local file is missing to perform merge.');
-            return undefined;
-        }
+    private discoverMergeFiles(local: string): { local: string; update: string; base: string } | undefined {
 
         const discovered = this.findNewestMergeFiles(local);
         const update = discovered.update;