feat(utils): print custom cwd in logger command spinner

Author: matejchalk

packages/utils/mocks/logger-demo.ts

@@ -11,7 +11,11 @@ async function sleep(delay: number) {
 logger.setVerbose(process.argv.includes('--verbose'));
 
 const errorStage = process.argv
-  .find(arg => arg.startsWith('--error='))
+  .findLast(arg => arg.startsWith('--error='))
+  ?.split('=')[1];
+
+const cwd = process.argv
+  .findLast(arg => arg.startsWith('--cwd='))
   ?.split('=')[1];
 
 try {
@@ -35,14 +39,18 @@ try {
     `Running plugin "ESLint" ${ansis.gray('[1/2]')}`,
     async () => {
       const bin = 'npx eslint . --format=json';
-      await logger.command(bin, async () => {
-        await sleep(3000);
-        if (errorStage === 'plugin') {
-          logger.info('Configuration file not found.');
-          throw new Error(`Command ${ansis.bold(bin)} exited with code 1`);
-        }
-        logger.debug('All files pass linting.');
-      });
+      await logger.command(
+        bin,
+        async () => {
+          await sleep(3000);
+          if (errorStage === 'plugin') {
+            logger.info('Configuration file not found.');
+            throw new Error(`Command ${ansis.bold(bin)} exited with code 1`);
+          }
+          logger.debug('All files pass linting.');
+        },
+        { cwd },
+      );
 
       logger.info('Found 0 lint problems');
 

packages/utils/project.json

@@ -43,6 +43,9 @@
         },
         "error-upload": {
           "args": ["--error=upload"]
+        },
+        "custom-cwd": {
+          "args": ["--cwd=src"]
         }
       }
     }

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

@@ -1,6 +1,7 @@
 import ansis from 'ansis';
 import cliSpinners from 'cli-spinners';
 import os from 'node:os';
+import path from 'node:path';
 import process from 'node:process';
 import type { MockInstance } from 'vitest';
 import { Logger } from './logger.js';
@@ -503,6 +504,42 @@ ${ansis.red('✖')} Uploading report to portal → ${ansis.red('GraphQL error: I
         `${ansis.red('✖')} ${ansis.red('$')} npx eslint . --format=json\n`,
       );
     });
+
+    it("should print command's working directory if it differs from `process.cwd()`", async () => {
+      const command = new Logger().command(
+        'npx eslint . --format=json',
+        async () => {},
+        { cwd: 'src' },
+      );
+
+      expect(output).toBe(
+        `${ansis.cyan('⠋')} ${ansis.blue('src')} ${ansis.blue('$')} npx eslint . --format=json`,
+      );
+
+      await expect(command).resolves.toBeUndefined();
+
+      expect(output).toBe(
+        `${ansis.green('✔')} ${ansis.blue('src')} ${ansis.green('$')} npx eslint . --format=json ${ansis.gray('(42 ms)')}\n`,
+      );
+    });
+
+    it('should print relative working directory if absoluted path provided', async () => {
+      const command = new Logger().command(
+        'npx eslint . --format=json',
+        async () => {},
+        { cwd: path.join(process.cwd(), 'src') },
+      );
+
+      expect(output).toBe(
+        `${ansis.cyan('⠋')} ${ansis.blue('src')} ${ansis.blue('$')} npx eslint . --format=json`,
+      );
+
+      await expect(command).resolves.toBeUndefined();
+
+      expect(output).toBe(
+        `${ansis.green('✔')} ${ansis.blue('src')} ${ansis.green('$')} npx eslint . --format=json ${ansis.gray('(42 ms)')}\n`,
+      );
+    });
   });
 
   describe('spinners + groups', () => {

packages/utils/src/lib/logger.ts

@@ -1,5 +1,6 @@
 import ansis, { type AnsiColors } from 'ansis';
 import os from 'node:os';
+import path from 'node:path';
 import ora, { type Ora } from 'ora';
 import { dateToUnixTimestamp } from './dates.js';
 import { isEnvVarEnabled } from './env.js';
@@ -198,19 +199,28 @@ export class Logger {
    *
    * A `$`-prefix is added. Its color indicates the status (blue=pending, green=success, red=failure).
    *
+   * If the command's working directory isn't `process.cwd()`, a relative path is prefixed to the output.
+   *
    * @example
    * await logger.command('npx eslint . --format=json', async () => {
    *   // ...
    * });
    *
    * @param bin Command string with arguments.
    * @param worker Asynchronous execution of the command (not implemented by the logger).
+   * @param options Custom CWD path where the command is executed (default is `process.cwd()`).
    */
-  command(bin: string, worker: () => Promise<void>): Promise<void> {
+  command(
+    bin: string,
+    worker: () => Promise<void>,
+    options?: { cwd?: string },
+  ): Promise<void> {
+    const cwd = options?.cwd && path.relative(process.cwd(), options.cwd);
+    const cwdPrefix = cwd ? `${ansis.blue(cwd)} ` : '';
     return this.#spinner(worker, {
-      pending: `${ansis.blue('$')} ${bin}`,
-      success: () => `${ansis.green('$')} ${bin}`,
-      failure: () => `${ansis.red('$')} ${bin}`,
+      pending: `${cwdPrefix}${ansis.blue('$')} ${bin}`,
+      success: () => `${cwdPrefix}${ansis.green('$')} ${bin}`,
+      failure: () => `${cwdPrefix}${ansis.red('$')} ${bin}`,
     });
   }