VSCode: add status bar

vscode-cairo/package.json

@@ -135,6 +135,12 @@
             },
             "default": {},
             "markdownDescription": "Extra environment variables that will be passed to the `cairo-language-server` executable.\nUseful for passing e.g. `CAIRO_LS_LOG` for debugging."
+          },
+          "cairo1.showInStatusBar": {
+            "type": "boolean",
+            "default": true,
+            "description": "Show CairoLS information in the status bar.",
+            "scope": "window"
           }
         }
       }

vscode-cairo/src/config.ts

@@ -3,6 +3,7 @@ import * as vscode from "vscode";
 
 interface ConfigProps {
   enableLanguageServer: boolean;
+  showInStatusBar: boolean;
   languageServerPath: string;
   enableScarb: boolean;
   preferScarbLanguageServer: boolean;

vscode-cairo/src/context.ts

@@ -9,15 +9,19 @@ export class Context {
         log: true,
       }),
     );
+    const statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 100);
+
     extensionContext.subscriptions.push(log);
+    extensionContext.subscriptions.push(statusBarItem);
 
-    return new Context(extensionContext, log);
+    return new Context(extensionContext, log, statusBarItem);
   }
 
   public readonly config: Config = new Config();
 
   private constructor(
     public readonly extension: vscode.ExtensionContext,
     public readonly log: RootLogOutputChannel,
+    public readonly statusBarItem: vscode.StatusBarItem,
   ) {}
 }

vscode-cairo/src/extension.ts

@@ -2,6 +2,7 @@ import * as vscode from "vscode";
 import * as lc from "vscode-languageclient/node";
 import { setupLanguageServer } from "./cairols";
 import { Context } from "./context";
+import { setupStatusBar } from "./statusBar";
 
 let client: lc.LanguageClient | undefined;
 
@@ -14,11 +15,19 @@ export async function activate(extensionContext: vscode.ExtensionContext) {
     ctx.log.warn("language server is disabled");
     ctx.log.warn("note: set `cairo1.enableLanguageServer` to `true` to enable it");
   }
+
+  if (ctx.config.get("showInStatusBar")) {
+    await setupStatusBar(ctx, client);
+  } else {
+    ctx.log.warn("status bar is disabled");
+    ctx.log.warn("note: set `cairo1.showInStatusBar` to `true` to enable it");
+  }
 }
 
 export function deactivate(): Thenable<void> | undefined {
   if (!client) {
     return undefined;
   }
+
   return client.stop();
 }

vscode-cairo/src/scarb.ts

@@ -87,6 +87,11 @@ export class Scarb implements LanguageServerExecutableProvider {
     return this.hasCommand("cairo-language-server", ctx);
   }
 
+  public async getVersion(ctx: Context): Promise<string> {
+    const output = await this.execWithOutput(["--version"], ctx);
+    return output.trim();
+  }
+
   public async cacheClean(ctx: Context): Promise<void> {
     await this.execWithOutput(["cache", "clean"], ctx);
   }

vscode-cairo/src/statusBar.ts

@@ -0,0 +1,53 @@
+import * as vscode from "vscode";
+import { Context } from "./context";
+import { Scarb } from "./scarb";
+import * as lc from "vscode-languageclient/node";
+
+const CAIRO_STATUS_BAR_COMMAND = "cairo1.statusBar.clicked";
+
+export async function setupStatusBar(ctx: Context, client?: lc.LanguageClient) {
+  ctx.extension.subscriptions.push(
+    vscode.workspace.onDidChangeConfiguration((e) => {
+      if (e.affectsConfiguration("cairo1.showInStatusBar")) {
+        updateStatusBar(ctx);
+      }
+    }),
+  );
+
+  ctx.extension.subscriptions.push(
+    vscode.commands.registerCommand(CAIRO_STATUS_BAR_COMMAND, () => {
+      if (client) {
+        client.outputChannel.show();
+      } else {
+        vscode.window.showWarningMessage("Cairo Language Server is not active");
+      }
+    }),
+  );
+  ctx.statusBarItem.command = CAIRO_STATUS_BAR_COMMAND;
+
+  updateStatusBar(ctx);
+}
+
+async function updateStatusBar(ctx: Context) {
+  const config = vscode.workspace.getConfiguration("cairo1");
+  const showInStatusBar = config.get<boolean>("showInStatusBar", true);
+
+  if (showInStatusBar) {
+    ctx.statusBarItem.text = "Cairo";
+    ctx.statusBarItem.tooltip = "Cairo Language";
+
+    try {
+      const scarb = await Scarb.find(vscode.workspace.workspaceFolders?.[0], ctx);
+      if (scarb) {
+        const version = await scarb.getVersion(ctx);
+        ctx.statusBarItem.tooltip = `Cairo Language\n${version}`;
+      }
+    } catch (error) {
+      ctx.log.error(`Error getting Scarb version: ${error}`);
+    }
+
+    ctx.statusBarItem.show();
+  } else {
+    ctx.statusBarItem.hide();
+  }
+}