Add namespaces to debug methods

Author: jdalton

package-lock.json

@@ -1,8 +1,10 @@
 declare interface ENV {
   readonly CI: boolean
+  readonly DEBUG: string
   readonly NODE_AUTH_TOKEN: string
   readonly NODE_ENV: string
   readonly PRE_COMMIT: boolean
+  readonly SOCKET_CLI_DEBUG: boolean
   readonly TAP: boolean
   readonly VITEST: boolean
 }

registry/lib/constants/env.d.ts

@@ -4,11 +4,18 @@ const { envAsBoolean, envAsString } = /*@__PURE__*/ require('../env')
 
 const { env } = process
 
+const DEBUG = envAsString(env.DEBUG)
+
 module.exports = Object.freeze({
   __proto__: null,
   // CI is always set to 'true' in a GitHub action.
   // https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#default-environment-variables
   CI: envAsBoolean(env.CI),
+  // Flag set to enable debug logging.
+  DEBUG,
+  // Variable to set the debug log level
+  // (notice, error, warn, info, verbose, http, silly).
+  LOG_LEVEL: envAsString(env.LOG_LEVEL),
   // .github/workflows/provenance.yml defines this.
   // https://docs.github.com/en/actions/use-cases-and-examples/publishing-packages/publishing-nodejs-packages
   NODE_AUTH_TOKEN: envAsString(env.NODE_AUTH_TOKEN),
@@ -20,10 +27,8 @@ module.exports = Object.freeze({
   // PRE_COMMIT is set to '1' by our 'test-pre-commit' script run by the
   // .husky/pre-commit hook.
   PRE_COMMIT: envAsBoolean(env.PRE_COMMIT),
-  // Flag set to help debug Socket CLI.
-  // eslint-disable-next-line no-warning-comments
-  // TODO: Make the environment variable name configurable.
-  SOCKET_CLI_DEBUG: envAsBoolean(env.SOCKET_CLI_DEBUG),
+  // Flag set to enable debug logging in Socket CLI.
+  SOCKET_CLI_DEBUG: !!DEBUG || envAsBoolean(env.SOCKET_CLI_DEBUG),
   // TAP=1 is set by the tap-run test runner.
   // https://node-tap.org/environment/#environment-variables-used-by-tap
   TAP: envAsBoolean(env.TAP),

registry/lib/constants/env.js

@@ -1,8 +1,10 @@
+import { InspectOptions } from 'node:util'
+
 declare const Debug: {
-  isDebug(): boolean
-  debugDir: typeof console.dir
-  debugFn: typeof console.log
-  debugLog: typeof console.log
+  isDebug(namespace?: string | undefined): boolean
+  debugDir(namespace: string, obj: any, options?: InspectOptions): void
+  debugFn(namespace: string, message?: any, ...optionalParams: any[]): void
+  debugLog(namespace: string, message?: any, ...optionalParams: any[]): void
 }
 declare namespace Debug {}
 export = Debug