chore(status_bar): refactor status bar item

Author: gg-jonathangriffe

src/extension.ts

@@ -23,14 +23,12 @@ import {
   languages,
   window,
   workspace,
-  StatusBarItem,
-  StatusBarAlignment,
   WebviewView,
 } from "vscode";
 import { GGShieldResolver } from "./lib/ggshield-resolver";
 import { getCurrentFile, isGitInstalled } from "./utils";
 import { GitGuardianWebviewProvider } from "./ggshield-webview/gitguardian-webview-view";
-import { StatusBarStatus, updateStatusBarItem } from "./gitguardian-interface/gitguardian-status-bar";
+import { createStatusBarItem, StatusBarStatus, updateStatusBarItem } from "./gitguardian-interface/gitguardian-status-bar";
 import {
   generateSecretName,
   GitGuardianSecretHoverProvider,
@@ -42,8 +40,6 @@ import { GitGuardianRemediationMessageWebviewProvider } from "./ggshield-webview
  * Extension diagnostic collection
  */
 let diagnosticCollection: DiagnosticCollection;
-let statusBar: StatusBarItem;
-
 /**
  * Scan a file using ggshield
  *
@@ -55,22 +51,22 @@ let statusBar: StatusBarItem;
  * @param filePath path to file
  * @param fileUri file uri
  */
-async function scanFile(
+export async function scanFile(
   this: any,
   filePath: string,
   fileUri: Uri,
   configuration: GGShieldConfiguration
 ): Promise<void> {
   const results = ggshieldScanFile(filePath, configuration);
   if (!results) {
-    updateStatusBarItem(StatusBarStatus.ready, statusBar);
+    updateStatusBarItem(StatusBarStatus.ready);
     return;
   }
   let incidentsDiagnostics: Diagnostic[] = parseGGShieldResults(results);
   if (incidentsDiagnostics.length !== 0) {
-    updateStatusBarItem(StatusBarStatus.secretFound, statusBar);
+    updateStatusBarItem(StatusBarStatus.secretFound);
   } else {
-    updateStatusBarItem(StatusBarStatus.noSecretFound, statusBar);
+    updateStatusBarItem(StatusBarStatus.noSecretFound);
   }
   diagnosticCollection.set(fileUri, incidentsDiagnostics);
 }
@@ -162,13 +158,11 @@ export function activate(context: ExtensionContext) {
   );
   context.subscriptions.push(ggshieldViewProvider, ggshieldRemediationMessageViewProvider, ggshieldQuotaViewProvider);
 
-  statusBar = window.createStatusBarItem(StatusBarAlignment.Left, 0);
-  updateStatusBarItem(StatusBarStatus.initialization, statusBar);
+  createStatusBarItem(context);
 
   //generic commands to open correct view on status bar click
   registerOpenViewsCommands(context, outputChannel);
   registerQuotaViewCommands(ggshieldQuotaViewProvider);
-  context.subscriptions.push(statusBar);
 
   context.subscriptions.push(
     languages.registerHoverProvider("*", new GitGuardianSecretHoverProvider())
@@ -180,14 +174,14 @@ export function activate(context: ExtensionContext) {
       // Check if ggshield is authenticated
       ggshieldAuthStatus(configuration, context);
       if (context.globalState.get("isAuthenticated", false)) {
-        updateStatusBarItem(StatusBarStatus.ready, statusBar);
+        updateStatusBarItem(StatusBarStatus.ready);
         setApiKey(configuration, ggshieldApiKey(configuration));
         ggshieldViewProvider.refresh();
         ggshieldRemediationMessageViewProvider.refresh();
         ggshieldQuotaViewProvider.refresh();
 
       } else {
-        updateStatusBarItem(StatusBarStatus.unauthenticated, statusBar);
+        updateStatusBarItem(StatusBarStatus.unauthenticated);
       }
     })
     .then(async () => {
@@ -262,10 +256,10 @@ export function activate(context: ExtensionContext) {
             context
           ).then(() => {
             if (context.globalState.get("isAuthenticated", false)) {
-              updateStatusBarItem(StatusBarStatus.ready, statusBar);
+              updateStatusBarItem(StatusBarStatus.ready);
               setApiKey(configuration, ggshieldApiKey(configuration));
             } else {
-              updateStatusBarItem(StatusBarStatus.unauthenticated, statusBar);
+              updateStatusBarItem(StatusBarStatus.unauthenticated);
             }
             ggshieldViewProvider.refresh();
             ggshieldRemediationMessageViewProvider.refresh();
@@ -276,7 +270,7 @@ export function activate(context: ExtensionContext) {
         }),
         commands.registerCommand("gitguardian.logout", async () => {
           logoutGGShield(ggshieldResolver.configuration, context);
-          updateStatusBarItem(StatusBarStatus.unauthenticated, statusBar);
+          updateStatusBarItem(StatusBarStatus.unauthenticated);
           setApiKey(configuration, undefined);
           ggshieldViewProvider.refresh();
           ggshieldRemediationMessageViewProvider.refresh();
@@ -286,13 +280,8 @@ export function activate(context: ExtensionContext) {
     })
     .catch((error) => {
       outputChannel.appendLine(`Error: ${error.message}`);
-      updateStatusBarItem(StatusBarStatus.error, statusBar);
+      updateStatusBarItem(StatusBarStatus.error);
     });
 }
 
-export function deactivate() {
-  if (diagnosticCollection) {
-    diagnosticCollection.dispose();
-    statusBar.dispose();
-  }
-}
+export function deactivate() {}

src/gitguardian-interface/gitguardian-status-bar.ts

@@ -1,4 +1,8 @@
-import { StatusBarItem, ThemeColor } from "vscode";
+import { ExtensionContext, StatusBarAlignment, StatusBarItem, ThemeColor, window } from "vscode";
+
+
+let statusBarItem: StatusBarItem;
+
 
 export interface StatusBarConfig {
   text: string;
@@ -16,7 +20,13 @@ export enum StatusBarStatus {
   error = "Error",
 }
 
-export function getStatusBarConfig(status: StatusBarStatus): StatusBarConfig {
+export function createStatusBarItem(context: ExtensionContext): void {
+  statusBarItem = window.createStatusBarItem(StatusBarAlignment.Left, 0);
+  updateStatusBarItem(StatusBarStatus.initialization);
+  context.subscriptions.push(statusBarItem);
+}
+
+function getStatusBarConfig(status: StatusBarStatus): StatusBarConfig {
   switch (status) {
     case StatusBarStatus.initialization:
       return {
@@ -64,7 +74,6 @@ export function getStatusBarConfig(status: StatusBarStatus): StatusBarConfig {
 
 export function updateStatusBarItem(
   status: StatusBarStatus,
-  statusBarItem: StatusBarItem
 ): void {
   const config = getStatusBarConfig(status);
   statusBarItem.text = config.text;