feature/#88 warning suppression code actions

Author: davidramnero

README.md

@@ -16,7 +16,7 @@
 - **Warning notes**: Display notes for warnings when those are available
 - **Dynamic config**: The extension supports running a script to generate arguments to pass to cppcheck. This can be done by including the command in the argument field wrapped with \@(), e.g. `--suppress=memleak:src/file1.cpp @(bash path/to/script.sh)`. The script is expected to output the argument(s) wrapped with \@(). If the script e.g. creates a project file it should print out as `@(--project=path/to/projectfile.json)`. This output will be spliced into the argument string as such: `--suppress=memleak:src/file1.cpp --project=path/to/projectfile.json`.
 
-- **Warning suppression**: Warnings of a specific type can be supressed with the --supress flag in the argument field in the extension settings. The extension also supports inline suppression for specific lines of code, simply write `// cppcheck-supress >warning id<` (see image below).
+- **Warning suppression**: Warnings of a specific type can be supressed with the --suppress flag in the argument field in the extension settings. The extension also supports inline suppression for specific lines of code, simply write `// cppcheck-suppress >warning id<` (see image below).
 ![Image showing how to suppress warnings](./images/suppression.png)
 ## Requirements
 

src/extension.ts

@@ -6,7 +6,7 @@ import * as crypto from 'crypto';
 import { documentationLinkMap, getPremiumCertLink } from './util/documentation';
 import { runCommand } from './util/scripts';
 import { looksLikePath, resolvePath, findWorkspaceRoot } from './util/path';
-import { diagnosticsUnion } from './util/diagnostics';
+import { CodeActionProvider, diagnosticsUnion } from './util/diagnostics';
 
 // To keep track of document changes we save hashed versions of their content to this record
 let documentHashMemory : Record<string, string> = {};
@@ -95,6 +95,17 @@ 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) {
+    context.subscriptions.push(
+        vscode.languages.registerCodeActionsProvider(
+            { pattern: "**/*" },
+            new CodeActionProvider(),
+            {
+                providedCodeActionKinds: [
+                    vscode.CodeActionKind.QuickFix
+                ]
+            }
+        )
+    );
 
     // Register a command to push user to workspace settings from walkthrough
     context.subscriptions.push(
@@ -108,6 +119,16 @@ export async function activate(context: vscode.ExtensionContext) {
             }
         )
     );
+    
+    // Register a command for suppressing a warning type
+    context.subscriptions.push(
+        vscode.commands.registerCommand(
+            "cppcheck-official.suppressWarningAll",
+            (diagnostic: vscode.Diagnostic) => {
+                console.log("Suppress", diagnostic);
+            }
+        )
+    );
 
     // ProgressIndicator status bar item to show when checks are running
 	cppcheckProgressIndicator = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 10);

src/util/diagnostics.ts

@@ -1,5 +1,65 @@
 import * as vscode from 'vscode';
 
+export class CodeActionProvider implements vscode.CodeActionProvider {
+    provideCodeActions(
+        document: vscode.TextDocument,
+        range: vscode.Range,
+        context: vscode.CodeActionContext,
+        token: vscode.CancellationToken
+    ): vscode.CodeAction[] {
+
+        const actions: vscode.CodeAction[] = [];
+
+        for (const diagnostic of context.diagnostics) {
+            var diagnosticCode = diagnostic.code;
+            if (typeof(diagnosticCode) === "object" && typeof(diagnosticCode) !== null) {
+                diagnosticCode = diagnosticCode.value;
+            }
+            
+            // Set up one action for suppressing the specific warning on the line targeted by the diagnostic
+            const suppressAction = new vscode.CodeAction(
+                `Suppress warning for ${diagnosticCode} here`,
+                vscode.CodeActionKind.QuickFix
+            );
+
+            // Copy indentation from line affected by diagnostic
+            const lineText = document.lineAt(diagnostic.range.start.line).text;
+            const indent = lineText.match(/^\s*/)?.[0] ?? "";
+            
+            // Insert suppression comment above affected line
+            const suppressLineEdit = new vscode.WorkspaceEdit();
+            suppressLineEdit.insert(
+                document.uri,
+                new vscode.Position(
+                    diagnostic.range.start.line,
+                    0,
+                ),
+                `${indent}// cppcheck-suppress ${diagnosticCode}\n`
+            );
+            suppressAction.edit = suppressLineEdit;
+            suppressAction.diagnostics = [diagnostic];
+            actions.push(suppressAction);
+
+            // Set up one action for suppressing warning of a given type universally
+            const suppressTypeAction = new vscode.CodeAction(
+                `Suppress warning type ${diagnosticCode} universally`,
+                vscode.CodeActionKind.QuickFix
+            );
+
+            suppressTypeAction.command = {
+                command: "cppcheck-official.suppressWarningAll",
+                title: "Suppress warning here",
+                arguments: [diagnostic]
+            };
+
+            suppressTypeAction.diagnostics = [diagnostic];
+            actions.push(suppressTypeAction);
+        }
+
+        return actions;
+    }
+}
+
 export function diagnosticsUnion(diagnosticsA : vscode.Diagnostic[], diagnosticB : vscode.Diagnostic[]) : vscode.Diagnostic[] {
     const diagnosticsUnion = new Array<vscode.Diagnostic>;
     // Add all elements from diagnosticsA to result array