basic functionality for writing suppression lines to project file

Author: davidramnero

src/extension.ts

@@ -8,6 +8,7 @@ import { runCommand } from './util/scripts';
 import { looksLikePath, resolvePath, findWorkspaceRoot } from './util/path';
 import { diagnosticsUnion } from './util/diagnostics';
 import { CodeActionProvider } from './util/codeActions';
+import { writeSuppressionToProjectFile } from './util/files';
 
 // To keep track of document changes we save hashed versions of their content to this record
 let documentHashMemory : Record<string, string> = {};
@@ -18,6 +19,7 @@ let previewAnalysisTimer: NodeJS.Timeout | undefined;
 let previewedDocument: vscode.TextDocument | undefined;
 let cppcheckProgressIndicator: vscode.StatusBarItem;
 let checksRunning = false;
+let cppcheckProjectFileUri: vscode.Uri | undefined;
 
 enum SeverityNumber {
     Info = 0,
@@ -96,6 +98,7 @@ function getDocumentSha1(document: vscode.TextDocument): string {
 // This method is called when your extension is activated.
 // Your extension is activated the very first time the command is executed.
 export async function activate(context: vscode.ExtensionContext) {
+    // Set up code actions provider
     context.subscriptions.push(
         vscode.languages.registerCodeActionsProvider(
             { pattern: "**/*" },
@@ -125,8 +128,12 @@ export async function activate(context: vscode.ExtensionContext) {
     context.subscriptions.push(
         vscode.commands.registerCommand(
             "cppcheck-official.suppressWarningAll",
-            (diagnostic: vscode.Diagnostic) => {
-                console.log("Suppress", diagnostic);
+            async (warningType : String) => {
+                if (cppcheckProjectFileUri) {
+                    await writeSuppressionToProjectFile(cppcheckProjectFileUri, warningType);
+                } else {
+                    vscode.window.showInformationMessage(`Adding suppression is currently only supported for .cppcheck project files`);
+                }
             }
         )
     );
@@ -321,6 +328,8 @@ async function runCppcheckOnFileXML(
     });
 
     let usingProjectFile = false;
+    cppcheckProjectFileUri = undefined;
+
     const args = [
         '--enable=all',
         '--inline-suppr',
@@ -330,9 +339,16 @@ async function runCppcheckOnFileXML(
         '--suppress=missingIncludeSystem',
         ...argsParsed,
     ].filter(Boolean);
+    
     if (processedArgs.includes("--project")) {
         usingProjectFile = true;
         args.push(`--file-filter=${filePath}`);
+        // If project file is of type .cppcheck we keep track of it
+        var projectFilePath = processedArgs.split('--project=')[1].split(' ')[0];
+        var projectFileType = projectFilePath.split('.')[1];
+        if (projectFileType.toLowerCase() === 'cppcheck') {
+            cppcheckProjectFileUri = vscode.Uri.file(projectFilePath);
+        }
     } else {
         args.push(filePath);
     }

src/util/files.ts

@@ -0,0 +1,55 @@
+import * as vscode from 'vscode';
+
+export async function writeSuppressionToProjectFile(projectFileUri : vscode.Uri, warningType : String) {
+    const fileType = projectFileUri.toString().split('.')[1];
+    if (fileType !== 'cppcheck') {
+        throw new Error(`Function writeSuppressionToProjectFile only supports writing to .cppcheck project files! Recieved file is of type .${fileType}`);
+    }
+
+    // Open project file with vscode workspace API
+    const document = await vscode.workspace.openTextDocument(projectFileUri);
+    const text = document.getText();
+    const edit = new vscode.WorkspaceEdit();
+    var textToInsert = '';
+    var positionToInsertAt = 0;
+
+    // Search for suppressions section
+    const match = /<suppressions\b[^>]*>([\s\S]*?)<\/suppressions>/m.exec(text);
+    if (match !== null) {
+        // match !== null -> Suppressions section exists
+        const closeIndex = text.indexOf("</suppressions>");
+        
+        // Determine indentation and construct the new suppression line
+        const line = document.lineAt(document.positionAt(closeIndex).line - 1);
+        const indentation = line.text.match(/^\s*/)?.[0] ?? "    ";
+        const newSuppressionLine = `\n${indentation}<suppression id="${warningType}"/>\n`;
+
+        // We splice in the new line just before the end of the suppressions block
+        textToInsert = newSuppressionLine;
+        positionToInsertAt = closeIndex;
+    } else {
+        // match === null -> Suppressions section does not exist
+        const closeIndex = text.indexOf("</project>");
+
+        // Determine indentation and construct the new suppressions block
+        const line = document.lineAt(document.positionAt(closeIndex).line - 1);
+        const indentation = line.text.match(/^\s*/)?.[0] ?? "    ";
+        const suppressionsBlock =
+            `\n${indentation}<suppressions>
+            ${indentation}    <suppression id="${warningType}"/>
+            ${indentation}</suppressions>\n`;
+
+        // Splice in the new suppressions block just before the end of the project-file
+        textToInsert = suppressionsBlock;
+        positionToInsertAt = closeIndex;
+    }
+
+    // Write file
+    edit.insert(
+        document.uri,
+        document.positionAt(positionToInsertAt),
+        textToInsert
+    );
+
+    await vscode.workspace.applyEdit(edit);
+}