feat: Use unicode symbols with ASCII fallback for log labels (#399)

* feat: use unicode symbols with ASCII fallback for log labels

* fix: add types

* fix: add types

* chore: move isUnicodeSupported to separate file

Author: chiragchadha1

lib/__tests__/logger.test.ts

@@ -8,13 +8,83 @@ import {
   LOG_LEVEL,
   logger,
   shouldLog,
+  getLabels,
 } from '../logger.js';
+import { isUnicodeSupported } from '../isUnicodeSupported.js';
 
 describe('lib/logger', () => {
   afterEach(() => {
     setLogLevel(LOG_LEVEL.LOG);
   });
 
+  describe('isUnicodeSupported()', () => {
+    const originalEnv = process.env;
+    const originalPlatform = process.platform;
+
+    afterEach(() => {
+      process.env = originalEnv;
+      Object.defineProperty(process, 'platform', {
+        value: originalPlatform,
+      });
+    });
+
+    it('returns true on non-win32 when TERM is not linux', () => {
+      Object.defineProperty(process, 'platform', { value: 'darwin' });
+      process.env = { ...originalEnv, TERM: 'xterm-256color' };
+      expect(isUnicodeSupported()).toBe(true);
+    });
+
+    it('returns false on non-win32 when TERM is linux', () => {
+      Object.defineProperty(process, 'platform', { value: 'linux' });
+      process.env = { ...originalEnv, TERM: 'linux' };
+      expect(isUnicodeSupported()).toBe(false);
+    });
+
+    it('returns true on win32 when WT_SESSION is set', () => {
+      Object.defineProperty(process, 'platform', { value: 'win32' });
+      process.env = { ...originalEnv, WT_SESSION: '1' };
+      expect(isUnicodeSupported()).toBe(true);
+    });
+
+    it('returns false on win32 with no unicode-capable env vars', () => {
+      Object.defineProperty(process, 'platform', { value: 'win32' });
+      process.env = {};
+      expect(isUnicodeSupported()).toBe(false);
+    });
+  });
+
+  describe('getLabels()', () => {
+    const originalEnv = process.env;
+    const originalPlatform = process.platform;
+
+    afterEach(() => {
+      process.env = originalEnv;
+      Object.defineProperty(process, 'platform', {
+        value: originalPlatform,
+      });
+    });
+
+    it('returns unicode labels when unicode is supported', () => {
+      Object.defineProperty(process, 'platform', { value: 'darwin' });
+      process.env = { ...originalEnv, TERM: 'xterm-256color' };
+      const labels = getLabels();
+      expect(labels.success).toBe('✔ SUCCESS');
+      expect(labels.warning).toBe('⚠ WARNING');
+      expect(labels.error).toBe('✖ ERROR');
+      expect(labels.info).toBe('ℹ INFO');
+    });
+
+    it('returns ASCII labels when unicode is not supported', () => {
+      Object.defineProperty(process, 'platform', { value: 'linux' });
+      process.env = { ...originalEnv, TERM: 'linux' };
+      const labels = getLabels();
+      expect(labels.success).toBe('[SUCCESS]');
+      expect(labels.warning).toBe('[WARNING]');
+      expect(labels.error).toBe('[ERROR]');
+      expect(labels.info).toBe('[INFO]');
+    });
+  });
+
   describe('stylize()', () => {
     it('stylizes input', () => {
       const res = stylize('[ERROR]', Styles.error, ['test']);

lib/__tests__/oauth.test.ts

@@ -56,7 +56,6 @@ describe('lib/oauth', () => {
   describe('addOauthToAccountConfig', () => {
     it('should update the config', () => {
       const oauthManager = new OAuth2Manager(account, () => null);
-      console.log('oauthManager', oauthManager.account);
       addOauthToAccountConfig(oauthManager);
       expect(updateConfigAccount).toHaveBeenCalledTimes(1);
       expect(updateConfigAccount).toHaveBeenCalledWith(account);

lib/isUnicodeSupported.ts

@@ -0,0 +1,17 @@
+// Adapted from https://github.com/sindresorhus/is-unicode-supported (MIT)
+export function isUnicodeSupported(): boolean {
+  if (process.platform !== 'win32') {
+    return process.env.TERM !== 'linux';
+  }
+
+  return (
+    Boolean(process.env.WT_SESSION) ||
+    Boolean(process.env.TERMINUS_SUBLIME) ||
+    process.env.ConEmuTask === '{cmd::Cmder}' ||
+    process.env.TERM_PROGRAM === 'Terminus-Sublime' ||
+    process.env.TERM_PROGRAM === 'vscode' ||
+    process.env.TERM === 'xterm-256color' ||
+    process.env.TERM === 'alacritty' ||
+    process.env.TERMINAL_EMULATOR === 'JetBrains-JediTerm'
+  );
+}

lib/logger.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 import chalk, { type ChalkInstance } from 'chalk';
+import { isUnicodeSupported } from './isUnicodeSupported.js';
 
 export const LOG_LEVEL = {
   NONE: 0,
@@ -10,6 +11,34 @@ export const LOG_LEVEL = {
   ERROR: 8,
 };
 
+interface LogLabels {
+  success: string;
+  warning: string;
+  error: string;
+  info: string;
+  debug: string;
+}
+
+const UNICODE_LABELS: LogLabels = {
+  success: '✔ SUCCESS',
+  warning: '⚠ WARNING',
+  error: '✖ ERROR',
+  info: 'ℹ INFO',
+  debug: 'DEBUG',
+};
+
+const ASCII_LABELS: LogLabels = {
+  success: '[SUCCESS]',
+  warning: '[WARNING]',
+  error: '[ERROR]',
+  info: '[INFO]',
+  debug: '[DEBUG]',
+};
+
+export function getLabels(): LogLabels {
+  return isUnicodeSupported() ? UNICODE_LABELS : ASCII_LABELS;
+}
+
 /**
  * Chalk styles for logger strings.
  */
@@ -33,22 +62,27 @@ export function stylize(label: string, style: ChalkInstance, args: any[]) {
 
 export class Logger {
   error(...args: any[]) {
-    console.error(...stylize('[ERROR]', Styles.error, args));
+    const labels = getLabels();
+    console.error(...stylize(labels.error, Styles.error, args));
   }
   warn(...args: any[]) {
-    console.warn(...stylize('[WARNING]', Styles.warn, args));
+    const labels = getLabels();
+    console.warn(...stylize(labels.warning, Styles.warn, args));
   }
   log(...args: any[]) {
     console.log(...args);
   }
   success(...args: any[]) {
-    console.log(...stylize('[SUCCESS]', Styles.success, args));
+    const labels = getLabels();
+    console.log(...stylize(labels.success, Styles.success, args));
   }
   info(...args: any[]) {
-    console.info(...stylize('[INFO]', Styles.info, args));
+    const labels = getLabels();
+    console.info(...stylize(labels.info, Styles.info, args));
   }
   debug(...args: any[]) {
-    console.debug(...stylize('[DEBUG]', Styles.log, args));
+    const labels = getLabels();
+    console.debug(...stylize(labels.debug, Styles.log, args));
   }
   group(...args: any[]) {
     console.group(...args);