feat: improve logs + error messages

before:

    {"level":"debug","message":"request -> neovim.api.nvim_list_bufs"}
    {"level":"debug","message":"request -> neovim.api.nvim_command"}
    {"level":"debug","message":"request -> neovim.api.nvim_get_current_tabpage"}
    {"level":"debug","message":"response -> neovim.api.nvim_command: null"}
    {"level":"debug","message":"response -> neovim.api.nvim_get_current_tabpage: [object Object]"}

after

    2024-03-16 15:01:14 DBG request -> neovim.api.nvim_eval
    2024-03-16 15:01:14 DBG request -> neovim.api.nvim_get_current_tabpage
    2024-03-16 15:01:15 DBG response -> neovim.api.nvim_get_current_tabpage: [object Object]
    2024-03-16 15:01:15 DBG request -> neovim.api.nvim_get_current_tabpage
    2024-03-16 15:01:15 DBG request -> neovim.api.nvim_get_current_win

Author: justinmk

packages/neovim/src/api/Base.ts

@@ -98,13 +98,15 @@ export class BaseApi extends EventEmitter {
     return this[DO_REQUEST](name, args).catch(err => {
       const newError = new Error(err.message);
       newError.stack = stack;
-      this.logger.error(`Error making request to ${name}`, newError);
+      this.logger.error(`failed request to "%s": %s: %s`, name, newError.name, newError.message);
       throw newError;
     });
   }
 
   request(name: string, args: any[] = []): Promise<any> {
-    const error = new Error(`Error making request to ${name}`);
+    // Dummy error, to get stacktrace.
+    const error = new Error(`failed request to "${name}" (see $NVIM_NODE_LOG_FILE for details, if it was set)`);
+
     return this.asyncRequest(name, args, error.stack);
   }
 

packages/neovim/src/utils/logger.ts

@@ -14,6 +14,20 @@ function setupWinstonLogger(): Logger {
       new winston.transports.File({
         filename: process.env.NVIM_NODE_LOG_FILE,
         level,
+        format: winston.format.combine(
+            winston.format.splat(),
+            winston.format.timestamp({
+                format: 'YYYY-MM-DD HH:mm:ss',
+            }),
+            winston.format.errors({ stack: true }),
+            winston.format.printf(info => {
+                if (info.raw) {
+                    return info.message
+                }
+                const lvl = info.level === 'debug' ? 'DBG' : info.level.slice(0, 3).toUpperCase();
+                return `${info.timestamp} ${lvl} ${info.message}`
+            })
+        ),
       })
     );
   }