Merge pull request #61 from Cyenoch/master

feat: output logs to vscode output channel

Author: 2214962083

.vscode/settings.json

@@ -1,8 +1,13 @@
 {
   "i18n-ally.pathMatcher": "package.nls.{locale}.json",
   "i18n-ally.keystyle": "flat",
-  "i18n-ally.localesPaths": ["."],
-  "i18n-ally.enabledFrameworks": ["vscode", "react"],
+  "i18n-ally.localesPaths": [
+    "."
+  ],
+  "i18n-ally.enabledFrameworks": [
+    "vscode",
+    "react"
+  ],
   "i18n-ally.dirStructure": "file",
   // Enable eslint for all supported languages
   "eslint.validate": [
@@ -29,6 +34,7 @@
   "typescript.enablePromptUseWorkspaceTsdk": true, // For security reasons it's require that users opt into using the workspace version of typescript
   "typescript.preferences.preferTypeOnlyAutoImports": true, // Prefer type-only imports
   "testing.openTesting": "neverOpen", // Don't open the testing view automatically when running tests
+  "prettier.enable": true, // enable prettier for those who disabled it for some reason
   "prettier.ignorePath": ".gitignore", // Don't run prettier for files listed in .gitignore
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnPaste": false,
@@ -40,7 +46,6 @@
   // "typescript.inlayHints.propertyDeclarationTypes.enabled": true,
   "typescript.inlayHints.parameterTypes.enabled": true,
   // "typescript.inlayHints.functionLikeReturnTypes.enabled": true,
-
   "workbench.colorCustomizations": {
     "activityBar.background": "#0E3140",
     "titleBar.activeBackground": "#14455A",

src/logger.ts

@@ -1,3 +1,5 @@
+import * as vscode from 'vscode'
+
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 const isServer = typeof window === 'undefined'
@@ -53,6 +55,7 @@ const hslToRgb = (
 }
 
 export interface LoggerOptions {
+  vscodeOutputName: string
   label?: string
   enableDebug?: boolean
   logStorageFlagName?: string
@@ -68,6 +71,8 @@ export class Logger {
 
   color: string | undefined
 
+  vscodeOutputChannel: vscode.OutputChannel
+
   private _enableDebug!: boolean
 
   protected get enableDebug() {
@@ -83,14 +88,18 @@ export class Logger {
     this._enableDebug = value
   }
 
-  constructor(optionsOrLabel?: LoggerOptions | string) {
+  constructor(optionsOrLabel: LoggerOptions | string) {
     const options: LoggerOptions =
       (typeof optionsOrLabel === 'string'
-        ? { label: optionsOrLabel }
+        ? { label: optionsOrLabel, vscodeOutputName: optionsOrLabel }
         : optionsOrLabel) || {}
 
-    const { enableDebug, label } = options
+    const { enableDebug, label, vscodeOutputName } = options
 
+    this.vscodeOutputChannel = vscode.window.createOutputChannel(
+      vscodeOutputName,
+      'log'
+    )
     this.label = label
     this.color = this.calculateColor(label)
     this.enableDebug = enableDebug as boolean
@@ -124,10 +133,30 @@ export class Logger {
     return `[${this.label}]`
   }
 
-  private logWithColor = (
-    method: 'log' | 'warn' | 'error' | 'debug',
-    ...args: any[]
+  private formatDate(date: Date): string {
+    return date.toISOString().replace('T', ' ').replace('Z', '')
+  }
+
+  private logToVscodeOutputChannel: typeof this.logWithColor = (
+    method,
+    ...args
   ) => {
+    const level = method === 'log' ? 'info' : method
+    const vscodeLogContent = [
+      this.formatDate(new Date()),
+      `[${level}]`,
+      ...args
+    ]
+    this.vscodeOutputChannel.appendLine(
+      vscodeLogContent
+        .map(arg =>
+          typeof arg === 'object' ? JSON.stringify(arg, null, 2) : String(arg)
+        )
+        .join(' ')
+    )
+  }
+
+  private logToConsole: typeof this.logWithColor = (method, ...args) => {
     if (!this.label) {
       ;(console as any)[method](...args)
       return
@@ -147,6 +176,14 @@ export class Logger {
     }
   }
 
+  private logWithColor = (
+    method: 'log' | 'warn' | 'error' | 'debug',
+    ...args: any[]
+  ) => {
+    this.logToVscodeOutputChannel(method, ...args)
+    this.logToConsole(method, ...args)
+  }
+
   // Check if logging should occur
   shouldLog = () => this.enableDebug
 
@@ -181,4 +218,4 @@ export class Logger {
   }
 }
 
-export const logger = new Logger('aide')
+export const logger = new Logger('Aide')