chore(scan): separate scan function into separate file

Author: gg-jonathangriffe

src/extension.ts

@@ -1,22 +1,20 @@
 import {
+  cleanUpFileDiagnostics,
+  createDiagnosticCollection,
   ggshieldApiKey,
   ggshieldAuthStatus,
-  ggshieldScanFile,
   ignoreLastFound,
   ignoreSecret,
   loginGGShield,
   logoutGGShield,
+  scanFile,
   showAPIQuota,
 } from "./lib/ggshield-api";
 import {
   getConfiguration,
-  GGShieldConfiguration,
   setApiKey,
 } from "./lib/ggshield-configuration";
-import { parseGGShieldResults } from "./lib/ggshield-results-parser";
 import {
-  Diagnostic,
-  DiagnosticCollection,
   ExtensionContext,
   Uri,
   commands,
@@ -36,49 +34,6 @@ import {
 import { GitGuardianQuotaWebviewProvider } from "./ggshield-webview/gitguardian-quota-webview";
 import { GitGuardianRemediationMessageWebviewProvider } from "./ggshield-webview/gitguardian-remediation-message-view";
 
-/**
- * Extension diagnostic collection
- */
-let diagnosticCollection: DiagnosticCollection;
-/**
- * Scan a file using ggshield
- *
- * - retrieve configuration
- * - scan file using ggshield CLI application
- * - parse ggshield results
- * - set diagnostics collection so the incdients are visible to the user
- *
- * @param filePath path to file
- * @param fileUri file uri
- */
-export async function scanFile(
-  this: any,
-  filePath: string,
-  fileUri: Uri,
-  configuration: GGShieldConfiguration
-): Promise<void> {
-  const results = ggshieldScanFile(filePath, configuration);
-  if (!results) {
-    updateStatusBarItem(StatusBarStatus.ready);
-    return;
-  }
-  let incidentsDiagnostics: Diagnostic[] = parseGGShieldResults(results);
-  if (incidentsDiagnostics.length !== 0) {
-    updateStatusBarItem(StatusBarStatus.secretFound);
-  } else {
-    updateStatusBarItem(StatusBarStatus.noSecretFound);
-  }
-  diagnosticCollection.set(fileUri, incidentsDiagnostics);
-}
-
-/**
- * Clean up file diagnostics
- *
- * @param fileUri file uri
- */
-function cleanUpFileDiagnostics(fileUri: Uri): void {
-  diagnosticCollection.delete(fileUri);
-}
 
 function registerOpenViewsCommands(
   context: ExtensionContext,
@@ -197,9 +152,7 @@ export function activate(context: ExtensionContext) {
     .then(() => {
       // Start scanning documents on activation events
       // (i.e. when a new document is opened or when the document is saved)
-      diagnosticCollection = languages.createDiagnosticCollection("ggshield");
-
-      context.subscriptions.push(diagnosticCollection);
+      createDiagnosticCollection(context);
       context.subscriptions.push(
         workspace.onDidSaveTextDocument((textDocument) => {
           // Check if the document is inside the workspace
@@ -243,7 +196,7 @@ export function activate(context: ExtensionContext) {
             scanFile(
               currentFile,
               Uri.file(currentFile),
-              ggshieldResolver.configuration
+              ggshieldResolver.configuration,
             );
           }
         ),

src/lib/ggshield-api.ts

@@ -3,14 +3,20 @@ import {
   SpawnOptionsWithoutStdio,
   spawn,
 } from "child_process";
-import { window, WebviewView, ExtensionContext, commands } from "vscode";
+import { window, WebviewView, DiagnosticCollection, commands, ExtensionContext, languages, Uri, Diagnostic } from "vscode";
 import axios from 'axios';
 import { GGShieldConfiguration } from "./ggshield-configuration";
 import { GGShieldScanResults } from "./api-types";
 import * as os from "os";
 import { apiToDashboard, dasboardToApi } from "../utils";
 import { runGGShieldCommand } from "./run-ggshield";
+import { StatusBarStatus, updateStatusBarItem } from "../gitguardian-interface/gitguardian-status-bar";
+import { parseGGShieldResults } from "./ggshield-results-parser";
 
+/**
+ * Extension diagnostic collection
+ */
+let diagnosticCollection: DiagnosticCollection;
 
 /**
  * Display API quota
@@ -115,19 +121,38 @@ export function ignoreSecret(
   }
 }
 
+export function createDiagnosticCollection(context: ExtensionContext): void {
+  diagnosticCollection = languages.createDiagnosticCollection("ggshield");
+  context.subscriptions.push(diagnosticCollection);
+}
+
+/**
+ * Clean up file diagnostics
+ *
+ * @param fileUri file uri
+ */
+export function cleanUpFileDiagnostics(fileUri: Uri): void {
+  diagnosticCollection.delete(fileUri);
+}
+
+
 /**
- * Scan a file using ggshield CLI application
+ * Scan a file using ggshield
  *
- * Show error messages on failure
+ * - retrieve configuration
+ * - scan file using ggshield CLI application
+ * - parse ggshield results
+ * - set diagnostics collection so the incdients are visible to the user
  *
  * @param filePath path to file
- * @param configuration ggshield configuration
- * @returns results or undefined if there was an error
+ * @param fileUri file uri
  */
-export function ggshieldScanFile(
+export async function scanFile(
+  this: any,
   filePath: string,
+  fileUri: Uri,
   configuration: GGShieldConfiguration
-): GGShieldScanResults | undefined {
+): Promise<void> {
   const proc = runGGShieldCommand(configuration, [
     "secret",
     "scan",
@@ -155,9 +180,22 @@ export function ggshieldScanFile(
     return undefined;
   }
 
-  return JSON.parse(proc.stdout);
+  const results = JSON.parse(proc.stdout);
+  if (!results) {
+    updateStatusBarItem(StatusBarStatus.ready);
+    return;
+  }
+  let incidentsDiagnostics: Diagnostic[] = parseGGShieldResults(results);
+  if (incidentsDiagnostics.length !== 0) {
+    updateStatusBarItem(StatusBarStatus.secretFound);
+  } else {
+    updateStatusBarItem(StatusBarStatus.noSecretFound);
+  }
+  
+  diagnosticCollection.set(fileUri, incidentsDiagnostics);
 }
 
+
 export async function loginGGShield(
   configuration: GGShieldConfiguration,
   outputChannel: any,