feat(utils): support custom return values in logger.task

Author: matejchalk

packages/utils/src/lib/logger.int.test.ts

@@ -376,6 +376,23 @@ ${ansis.green('✔')} Uploaded report to portal ${ansis.gray('(42 ms)')}
       );
     });
 
+    it('should resolve value from worker', async () => {
+      const config = { plugins: ['eslint'] };
+
+      await expect(
+        new Logger().task('Loading configuration', async () => ({
+          message: 'Loaded configuration',
+          result: config,
+        })),
+      ).resolves.toBe(config);
+
+      expect(stdout).toBe(
+        `
+${ansis.green('✔')} Loaded configuration ${ansis.gray('(42 ms)')}
+`.trimStart(),
+      );
+    });
+
     it('should allow spinners to be run in sequence', async () => {
       performanceNowSpy
         .mockReset()

packages/utils/src/lib/logger.ts

@@ -212,12 +212,16 @@ export class Logger {
    * @param title Display text used as pending message.
    * @param worker Asynchronous implementation. Returned promise determines spinner status and final message. Support for inner logs has some limitations (described above).
    */
-  async task(title: string, worker: () => Promise<string>): Promise<void> {
-    await this.#spinner(worker, {
+  async task<T = undefined>(
+    title: string,
+    worker: () => Promise<string | { message: string; result: T }>,
+  ): Promise<T> {
+    const result = await this.#spinner(worker, {
       pending: title,
-      success: value => value,
+      success: value => (typeof value === 'string' ? value : value.message),
       failure: error => `${title} → ${ansis.red(String(error))}`,
     });
+    return typeof result === 'object' ? result.result : (undefined as T);
   }
 
   /**

testing/test-setup/src/lib/logger.mock.ts

@@ -35,7 +35,8 @@ beforeAll(async () => {
         return typeof value === 'object' ? value.result : undefined;
       }),
       vi.spyOn(logger, 'task').mockImplementation(async (_, worker) => {
-        await worker();
+        const value = await worker();
+        return typeof value === 'object' ? value.result : undefined;
       }),
       vi.spyOn(logger, 'command').mockImplementation((_, worker) => worker()),
     );