feat: review: send messages to channel output

Author: sevbch

src/extension.ts

@@ -71,7 +71,7 @@ function registerOpenViewsCommands(
 
 export function activate(context: ExtensionContext) {
   const outputChannel = window.createOutputChannel("GitGuardian");
-  let configuration = getConfiguration(context);
+  let configuration = getConfiguration(context, outputChannel);
 
   const ggshieldResolver = new GGShieldResolver(
     outputChannel,

src/lib/ggshield-configuration-utils.ts

@@ -1,4 +1,4 @@
-import { ExtensionContext, workspace } from "vscode";
+import { ExtensionContext, OutputChannel, workspace } from "vscode";
 import * as os from "os";
 import { GGShieldConfiguration } from "./ggshield-configuration";
 import { getGGShieldAbsolutePath } from "./ggshield-resolver-utils";
@@ -8,7 +8,8 @@ import { getGGShieldAbsolutePath } from "./ggshield-resolver-utils";
  * @returns {GGShieldConfiguration} from the extension settings
  */
 export function getConfiguration(
-  context: ExtensionContext
+  context: ExtensionContext,
+  outputChannel: OutputChannel
 ): GGShieldConfiguration {
   const config = workspace.getConfiguration("gitguardian");
 
@@ -19,7 +20,8 @@ export function getConfiguration(
   const ggshieldAbsolutePath: string = getGGShieldAbsolutePath(
     os.platform(),
     os.arch(),
-    context
+    context,
+    outputChannel
   );
 
   return new GGShieldConfiguration(

src/lib/ggshield-resolver-utils.ts

@@ -1,5 +1,5 @@
 import * as path from "path";
-import { ExtensionContext } from "vscode";
+import { ExtensionContext, OutputChannel } from "vscode";
 import * as fs from "fs";
 import * as tar from "tar";
 const AdmZip = require("adm-zip");
@@ -14,7 +14,8 @@ const AdmZip = require("adm-zip");
 export function getGGShieldAbsolutePath(
   platform: NodeJS.Platform,
   arch: string,
-  context: ExtensionContext
+  context: ExtensionContext,
+  outputChannel: OutputChannel
 ): string {
   const version = getGGShieldLatestVersion();
   console.log(`Latest GGShield version: ${version}`);
@@ -31,6 +32,9 @@ export function getGGShieldAbsolutePath(
 
   // if exists, return the path
   if (fs.existsSync(ggshieldBinaryPath)) {
+    outputChannel.appendLine(
+      `Using GGShield v${version}. Checkout https://github.com/GitGuardian/ggshield for more info.`
+    );
     console.log(`GGShield already exists at ${ggshieldBinaryPath}`);
     return ggshieldBinaryPath;
   }
@@ -41,6 +45,9 @@ export function getGGShieldAbsolutePath(
   fs.mkdirSync(ggshieldFolder);
   // install GGShield
   installGGShield(platform, arch, ggshieldFolder, version);
+  outputChannel.appendLine(
+    `Updated to GGShield v${version}. Checkout https://github.com/GitGuardian/ggshield for more info.`
+  );
   console.log(`GGShield binary installed at ${ggshieldBinaryPath}`);
   return ggshieldBinaryPath;
 }

src/lib/ggshield-resolver.ts

@@ -31,7 +31,7 @@ export class GGShieldResolver {
     try {
       this.testConfiguration(this.configuration);
       this.channel.appendLine(
-        `Using ggshield at: ${this.configuration.ggshieldPath}, to change this go to settings.`
+        `Using ggshield at: ${this.configuration.ggshieldPath}.`
       );
       return;
     } catch (error) {

src/test/suite/lib/ggshield-configuration-utils.test.ts

@@ -1,20 +1,26 @@
 import * as simple from "simple-mock";
 import assert = require("assert");
-import { ExtensionContext, workspace } from "vscode";
+import { ExtensionContext, workspace, window } from "vscode";
 import { getConfiguration } from "../../../lib/ggshield-configuration-utils";
 import * as ggshieldResolverUtils from "../../../lib/ggshield-resolver-utils";
 
 suite("getConfiguration", () => {
   let getConfigurationMock: simple.Stub<Function>;
-  let getGGShieldAbsolutePathMock: simple.Stub<(platform: NodeJS.Platform, arch: string, context: ExtensionContext) => string>;
+  let getGGShieldAbsolutePathMock: simple.Stub<
+    (
+      platform: NodeJS.Platform,
+      arch: string,
+      context: ExtensionContext
+    ) => string
+  >;
 
   setup(() => {
     // Mock workspace.getConfiguration
     getConfigurationMock = simple.mock(workspace, "getConfiguration");
     // Mock getGGShieldAbsolutePath
-    getGGShieldAbsolutePathMock = simple.mock(ggshieldResolverUtils, "getGGShieldAbsolutePath").returnWith(
-      () => "/mock/path/to/ggshield"
-    );
+    getGGShieldAbsolutePathMock = simple
+      .mock(ggshieldResolverUtils, "getGGShieldAbsolutePath")
+      .returnWith(() => "/mock/path/to/ggshield");
   });
 
   teardown(() => {
@@ -23,6 +29,7 @@ suite("getConfiguration", () => {
 
   test("Vscode settings are correctly read", () => {
     const context = {} as ExtensionContext;
+    const outputChannel = window.createOutputChannel("GitGuardian");
     simple.mock(context, "asAbsolutePath").returnWith("");
 
     getConfigurationMock.returnWith({
@@ -35,10 +42,13 @@ suite("getConfiguration", () => {
         }
       },
     });
-    const configuration = getConfiguration(context);
+    const configuration = getConfiguration(context, outputChannel);
 
     // Assert both workspace.getConfiguration and GGShieldConfiguration constructor were called
-    assert(getConfigurationMock.called, "getConfiguration should be called once");
+    assert(
+      getConfigurationMock.called,
+      "getConfiguration should be called once"
+    );
 
     // Assert that the configuration has the expected values
     assert.strictEqual(configuration.apiUrl, "https://custom-url.com");