Merge pull request #40 from GitGuardian/jgriffe/-/move-run-ggshield-command-to-own-file

chore: move runGGShieldCommand to its own file

Author: salome-voltz

src/lib/ggshield-api.ts

@@ -1,64 +1,16 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 import {
   SpawnOptionsWithoutStdio,
-  SpawnSyncOptionsWithStringEncoding,
-  SpawnSyncReturns,
   spawn,
-  spawnSync,
 } from "child_process";
-import { workspace, window, WebviewView } from "vscode";
+import { window, WebviewView } 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";
 
-/**
- * Run ggshield CLI application with specified arguments
- *
- * @param configuration ggshield configuration
- * @param args arguments
- * @returns
- */
-export function runGGShieldCommand(
-  configuration: GGShieldConfiguration,
-  args: string[]
-): SpawnSyncReturns<string> {
-  const { ggshieldPath, apiUrl, apiKey } = configuration;
-  let env: {
-    GITGUARDIAN_API_URL: string;
-    GG_USER_AGENT: string;
-    GITGUARDIAN_DONT_LOAD_ENV: string;
-    GITGUARDIAN_API_KEY?: string;
-    } = {
-    GITGUARDIAN_API_URL: apiUrl,
-    GG_USER_AGENT: "gitguardian-vscode",
-    GITGUARDIAN_DONT_LOAD_ENV: "true",
-  };
-  
-  if (apiKey) {
-    env = {
-      ...env,
-      // eslint-disable-next-line @typescript-eslint/naming-convention
-      GITGUARDIAN_API_KEY: apiKey,
-    };
-  }
-
-  let options: SpawnSyncOptionsWithStringEncoding = {
-    cwd: os.tmpdir(),
-    env: env,
-    encoding: "utf-8",
-    windowsHide: true,
-  };
-
-  // If the command is executed in a worskpace, execute ggshield from the root folder so .gitguardian.yaml is used
-  if (workspace.workspaceFolders?.length || 0 > 0) {
-    options["cwd"] = workspace.workspaceFolders![0].uri.fsPath;
-  }
-  let proc = spawnSync(ggshieldPath, args, options);
-
-  return proc;
-}
 
 /**
  * Display API quota

src/lib/ggshield-resolver.ts

@@ -1,11 +1,9 @@
 import * as vscode from "vscode";
 import {
-  getConfiguration,
   GGShieldConfiguration,
 } from "./ggshield-configuration";
-import { runGGShieldCommand } from "./ggshield-api";
+import { runGGShieldCommand } from "./run-ggshield";
 import { window } from "vscode";
-import * as os from "os";
 
 export class GGShieldResolver {
   channel: vscode.OutputChannel;

src/lib/run-ggshield.ts

@@ -0,0 +1,51 @@
+import { spawnSync, SpawnSyncOptionsWithStringEncoding, SpawnSyncReturns } from "child_process";
+import { GGShieldConfiguration } from "./ggshield-configuration";
+import { workspace } from "vscode";
+
+import * as os from "os";
+/**
+ * Run ggshield CLI application with specified arguments
+ *
+ * @param configuration ggshield configuration
+ * @param args arguments
+ * @returns
+ */
+export function runGGShieldCommand(
+    configuration: GGShieldConfiguration,
+    args: string[]
+  ): SpawnSyncReturns<string> {
+    const { ggshieldPath, apiUrl, apiKey } = configuration;
+    let env: {
+      GITGUARDIAN_API_URL: string;
+      GG_USER_AGENT: string;
+      GITGUARDIAN_DONT_LOAD_ENV: string;
+      GITGUARDIAN_API_KEY?: string;
+      } = {
+      GITGUARDIAN_API_URL: apiUrl,
+      GG_USER_AGENT: "gitguardian-vscode",
+      GITGUARDIAN_DONT_LOAD_ENV: "true",
+    };
+
+    if (apiKey) {
+      env = {
+        ...env,
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        GITGUARDIAN_API_KEY: apiKey,
+      };
+    }
+
+    let options: SpawnSyncOptionsWithStringEncoding = {
+      cwd: os.tmpdir(),
+      env: env,
+      encoding: "utf-8",
+      windowsHide: true,
+    };
+
+    // If the command is executed in a worskpace, execute ggshield from the root folder so .gitguardian.yaml is used
+    if (workspace.workspaceFolders?.length || 0 > 0) {
+      options["cwd"] = workspace.workspaceFolders![0].uri.fsPath;
+    }
+    let proc = spawnSync(ggshieldPath, args, options);
+
+    return proc;
+  }