From 5de0a4f48668b45a4e7ae17ea11afc6bf5104d19 Mon Sep 17 00:00:00 2001
From: Kanad Gupta <8854718+kanadgupta@users.noreply.github.com>
Date: Wed, 20 Nov 2024 18:30:28 -0600
Subject: [PATCH] fix: debug properly (#1078)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

## 🧰 Changes

`@oclif/core@4`[^1] updated their debug logs so the top-level scope of
all logs is `oclif`. this means our debug logs look like this:

![CleanShot 2024-11-20 at 18 26
16@2x](https://github.com/user-attachments/assets/275fd8e7-2abe-4165-bcdf-fdd72e13997d)

thanks, i hate it. this fixes them up so they look like this again:

![CleanShot 2024-11-20 at 18 27
48@2x](https://github.com/user-attachments/assets/016f177e-3afb-4e27-96f2-c2881332292e)

[^1]: See the "Customizable Logger" section of [their release
notes](https://github.com/oclif/core/releases/tag/4.0.0).
---
 src/lib/baseCommand.ts | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/lib/baseCommand.ts b/src/lib/baseCommand.ts
index 360e6f76e..97ef694fb 100644
--- a/src/lib/baseCommand.ts
+++ b/src/lib/baseCommand.ts
@@ -5,6 +5,7 @@ import { format } from 'node:util';
 
 import * as core from '@actions/core';
 import { Command as OclifCommand } from '@oclif/core';
+import debugPkg from 'debug';
 
 import { isGHA, isTest } from './isCI.js';
 
@@ -15,9 +16,13 @@ export default abstract class BaseCommand<T extends typeof OclifCommand> extends
   constructor(argv: string[], config: Config) {
     super(argv, config);
 
-    const oclifDebug = this.debug;
     // this scope is copied from the @oclif/core source
+    // see https://github.com/oclif/core/blob/eef2ddedf6a844b28d8968ef5afd38c92f5875db/src/command.ts#L140
     const scope = this.id ? `${this.config.bin}:${this.id}` : this.config.bin;
+
+    // rather than using the @oclif/core debug function, we use the debug package
+    // so we have full control over the scope.
+    const debug = debugPkg(scope);
     // this is a lightweight reimplementation of the @oclif/core debug function
     // with some debug logging functionality for github actions
     this.debug = (formatter: unknown, ...args: unknown[]) => {
@@ -25,7 +30,7 @@ export default abstract class BaseCommand<T extends typeof OclifCommand> extends
         core.debug(`${scope}: ${format(formatter, ...args)}`);
       }
 
-      return oclifDebug(formatter, ...args);
+      return debug(formatter, ...args);
     };
   }