download different formats

Author: RubenHalman

README.md

@@ -72,7 +72,7 @@ Using the rules section of your configurations, you can specify the list of rule
 }
 ```
 
-Note: if you prefer JSON format, you can create a `.flow-scanner.json` file using the same format. For a more on configurations, review the [scanner documentation](https://flow-scanner.github.io/lightning-flow-scanner-core/#configurations).
+Note: if you prefer JSON format, you can create a `.flow-scanner.json` file using the same format. For a more on configurations, review the [scanner documentation](https://flow-scanner.github.io/lightning-flow-scanner-core/#configuration).
 
 ### Extension Settings
 

package-lock.json

@@ -148,7 +148,7 @@
     "webpack-cli": "^5.1.4"
   },
   "dependencies": {
-    "@flow-scanner/lightning-flow-scanner-core": "^6.0.4",
+    "@flow-scanner/lightning-flow-scanner-core": "^6.2.1",
     "convert-array-to-csv": "^2.0.0",
     "cosmiconfig": "^9.0.0",
     "lightning-flow-scanner-core": "^5.9.7",

package.json

@@ -2,20 +2,18 @@ import * as vscode from "vscode";
 import * as uuid from "uuid";
 import { convertArrayToCSV } from "convert-array-to-csv";
 import { ViolationOverview } from "./ViolationOverviewPanel";
-import { ScanResult } from "@flow-scanner/lightning-flow-scanner-core";
+import { ScanResult, exportSarif } from "@flow-scanner/lightning-flow-scanner-core";
 
 export class ScanOverview {
   public static currentPanel: ScanOverview | undefined;
   public static readonly viewType = "report";
+
   private readonly _panel: vscode.WebviewPanel;
   private readonly _extensionUri: vscode.Uri;
   private _disposables: vscode.Disposable[] = [];
-  private isDownloading = false;
+  private _lastScanResults: ScanResult[] = [];
 
-  public static createOrShow(
-    extensionUri: vscode.Uri,
-    scanResults: ScanResult[]
-  ) {
+  public static createOrShow(extensionUri: vscode.Uri, scanResults: ScanResult[]) {
     const column = vscode.window.activeTextEditor
       ? vscode.window.activeTextEditor.viewColumn
       : undefined;
@@ -38,11 +36,8 @@ export class ScanOverview {
         ],
       }
     );
-    ScanOverview.currentPanel = new ScanOverview(
-      panel,
-      extensionUri,
-      scanResults
-    );
+
+    ScanOverview.currentPanel = new ScanOverview(panel, extensionUri, scanResults);
   }
 
   public static kill() {
@@ -66,51 +61,47 @@ export class ScanOverview {
     this._panel.dispose();
     while (this._disposables.length) {
       const x = this._disposables.pop();
-      if (x) {
-        x.dispose();
-      }
+      if (x) x.dispose();
     }
   }
 
   private async _update(scanResults: ScanResult[]) {
+    this._lastScanResults = scanResults;
     const webview = this._panel.webview;
     this._panel.webview.html = this._getHtmlForWebview(webview);
+
     webview.onDidReceiveMessage(async (data) => {
       switch (data.type) {
         case "goToFile": {
-          if (!data.value) {
-            return;
-          }
+          if (!data.value) return;
           vscode.workspace.openTextDocument(data.value.path).then((doc) => {
             vscode.window.showTextDocument(doc);
           });
           break;
         }
+
         case "viewAll": {
-          if (!data.value) {
-            return;
-          }
+          if (!data.value) return;
           ViolationOverview.createOrShow(this._extensionUri, data.value, "All");
           break;
         }
+
         case "goToDetails": {
-          if (!data.value) {
-            return;
-          }
+          if (!data.value) return;
           ViolationOverview.createOrShow(
             this._extensionUri,
             [data.value],
             data.value.flow.label
           );
           break;
         }
+
         case "onError": {
-          if (!data.value) {
-            return;
-          }
+          if (!data.value) return;
           vscode.window.showErrorMessage(data.value);
           break;
         }
+
         case "init-view": {
           if (scanResults) {
             webview.postMessage({
@@ -120,18 +111,69 @@ export class ScanOverview {
           }
           return;
         }
+
         case "download": {
-          let saveResult = await vscode.window.showSaveDialog({
-            filters: {
-              csv: [".csv"],
-            },
-          });
-          const csv = convertArrayToCSV(data.value);
-          await vscode.workspace.fs.writeFile(saveResult, Buffer.from(csv));
-          await vscode.window.showInformationMessage(
-            "Downloaded file: " + saveResult.fsPath
-          );
-        }
+  if (!data.value || !Array.isArray(data.value) || data.value.length === 0) {
+    await vscode.window.showInformationMessage(
+      "No results found. Please make sure to complete a scan before downloading."
+    );
+    return;
+  }
+
+  const formatChoice = await vscode.window.showQuickPick(
+    [
+      { label: "CSV",  description: "Comma-separated values", value: "csv" },
+      { label: "SARIF",description: "Static Analysis Results Interchange Format", value: "sarif" }
+    ],
+    {
+      placeHolder: "Select export format (Esc to cancel)",
+      canPickMany: false,
+      ignoreFocusOut: false,
+    }
+  );
+
+  if (!formatChoice) return;
+
+  const chosenFormat = formatChoice.value;
+  const filterKey = chosenFormat === "sarif" ? "sarif" : "csv";
+  const filterExt = chosenFormat === "sarif" ? ".sarif" : ".csv";
+
+  const defaultUri = vscode.workspace.workspaceFolders?.[0]?.uri;
+  const saveResult = await vscode.window.showSaveDialog({
+    defaultUri,
+    filters: { [filterKey]: [filterExt] },
+    title: `Save ${chosenFormat.toUpperCase()} file`,
+  });
+
+  if (!saveResult) return;
+
+  try {
+    let content: string;
+
+    if (chosenFormat === "sarif") {
+      // ----  SARIF: use the *original* scan results (they have a real Flow with fsPath)
+      const originalResults: ScanResult[] = this._lastScanResults ?? [];
+      if (originalResults.length === 0) {
+        await vscode.window.showWarningMessage("No original scan data available for SARIF export.");
+        return;
+      }
+      content = exportSarif(originalResults);
+    } else {
+      // ----  CSV: keep using the web-view payload (already flattened)
+      content = convertArrayToCSV(data.value);
+    }
+
+    await vscode.workspace.fs.writeFile(saveResult, Buffer.from(content, "utf-8"));
+    await vscode.window.showInformationMessage(
+      `Downloaded ${chosenFormat.toUpperCase()} file: ${saveResult.fsPath}`
+    );
+  } catch (err: any) {
+    await vscode.window.showErrorMessage(
+      `Failed to export ${chosenFormat.toUpperCase()}: ${err?.message ?? err}`
+    );
+  }
+  break;
+}
       }
     });
   }
@@ -141,11 +183,7 @@ export class ScanOverview {
       vscode.Uri.joinPath(this._extensionUri, "out/compiled", "ScanOverview.js")
     );
     const cssUri = webview.asWebviewUri(
-      vscode.Uri.joinPath(
-        this._extensionUri,
-        "out/compiled",
-        "ScanOverview.css"
-      )
+      vscode.Uri.joinPath(this._extensionUri, "out/compiled", "ScanOverview.css")
     );
     const tabulatorStyles = webview.asWebviewUri(
       vscode.Uri.joinPath(this._extensionUri, "media", "tabulator.css")
@@ -157,24 +195,25 @@ export class ScanOverview {
       vscode.Uri.joinPath(this._extensionUri, "media", "vscode.css")
     );
     const nonce = uuid.v4();
+
     return `
         <!DOCTYPE html>
-			<html lang="en">
-			<head>
-				<meta charset="UTF-8">
+      <html lang="en">
+      <head>
+        <meta charset="UTF-8">
         <meta http-equiv="Content-Security-Policy" content="img-src https: data:; style-src 'unsafe-inline' ${webview.cspSource}; script-src 'nonce-${nonce}';">
-				<meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
         <link href="${tabulatorStyles}" rel="stylesheet">
         <link href="${stylesResetUri}" rel="stylesheet">
         <link href="${stylesMainUri}" rel="stylesheet">
         <link href="${cssUri}" rel="stylesheet">
         <script nonce="${nonce}">
-        const tsvscode = acquireVsCodeApi();
+          const tsvscode = acquireVsCodeApi();
         </script>
-			</head>
+      </head>
       <body>
             <script src="${scriptUri}" nonce="${nonce}"></script>
-			</body>
-			</html>`;
+      </body>
+      </html>`;
   }
-}
+}