feat: show progress for debug --info

Author: Akos Kitta

src/debug.ts

@@ -21,8 +21,15 @@ export function activateDebug(_: vscode.ExtensionContext): vscode.Disposable {
     vscode.commands.registerCommand(
       'arduino.debug.start',
       async (params: StartDebugParams) => {
-        const launchConfig = await createLaunchConfig(params);
-        return startDebug(params.launchConfigsDirPath, launchConfig);
+        try {
+          const launchConfig = await createLaunchConfig(params);
+          return startDebug(params.launchConfigsDirPath, launchConfig);
+        } catch (err) {
+          if (err instanceof vscode.CancellationError) {
+            return;
+          }
+          throw err;
+        }
       }
     ),
     vscode.commands.registerCommand(
@@ -60,6 +67,10 @@ export interface StartDebugParams {
    * Programmer for the debugging.
    */
   readonly programmer?: string;
+  /**
+   * Custom progress message to use when getting the debug information from the CLI.
+   */
+  readonly message?: string;
 }
 export type StartDebugResult = boolean;
 
@@ -124,6 +135,8 @@ async function startDebug(
   return vscode.debug.startDebugging(undefined, launchConfig);
 }
 
+const getDebugInfoMessage = 'Getting debug info...';
+
 async function createLaunchConfig(
   params: StartDebugParams
 ): Promise<ArduinoDebugLaunchConfig> {
@@ -133,7 +146,10 @@ async function createLaunchConfig(
   }
   const { file, args } = buildDebugInfoArgs(params);
   const [stdout, customConfigs] = await Promise.all([
-    exec(file, args),
+    withProgress(
+      () => exec(file, args),
+      params.message ? params.message : getDebugInfoMessage
+    ),
     loadDebugCustomJson(params),
   ]);
   const debugInfo = await parseRawDebugInfo(stdout);
@@ -151,6 +167,23 @@ async function createLaunchConfig(
   return launchConfig;
 }
 
+async function withProgress<T>(
+  task: () => Promise<T> | T,
+  message: string
+): Promise<T> {
+  return vscode.window.withProgress(
+    { location: vscode.ProgressLocation.Window },
+    async (progress, token) => {
+      if (token.isCancellationRequested) {
+        throw new vscode.CancellationError();
+      }
+      progress.report({ message });
+      const result = await task();
+      return result as T;
+    }
+  );
+}
+
 async function parseRawDebugInfo(
   raw: string
 ): Promise<(DebugInfo & Executable) | undefined> {

src/ino.ts

@@ -187,7 +187,7 @@ async function buildLanguageClient(
     String(daemonAddress.instance),
     '-fqbn',
     board.fqbn,
-    '-skip-libraries-discovery-on-rebuild', // The Arduino IDE
+    '-skip-libraries-discovery-on-rebuild', // The default Arduino IDE behavior
   ];
   if (board.name) {
     args.push('-board-name', board.name);
@@ -201,7 +201,7 @@ async function buildLanguageClient(
   if (flags && flags.length) {
     args.push(...flags);
   }
-  if (!!log) {
+  if (log) {
     args.push('-log');
     let logPath: string | undefined = undefined;
     if (typeof log === 'string') {
@@ -296,6 +296,3 @@ function noopOutputChannel(name: string): vscode.OutputChannel {
     name,
   };
 }
-
-const __tests__ = {} as const;
-export { __tests__ };