Use fancy formatting in EventLogger

smashwilson · smashwilson · commit 56fb84e62a51 · 2017-05-05T10:37:21.000-04:00
diff --git a/lib/models/event-logger.js b/lib/models/event-logger.js
@@ -1,54 +1,95 @@
-import util from 'util';
+import path from 'path';
+import nsfw from 'nsfw';
+
+const actionText = new Map();
+actionText.set(nsfw.actions.CREATED, 'created');
+actionText.set(nsfw.actions.DELETED, 'deleted');
+actionText.set(nsfw.actions.MODIFIED, 'modified');
+actionText.set(nsfw.actions.RENAMED, 'renamed');
 
 export default class EventLogger {
-  constructor(name) {
-    this.name = name;
-    this.path = '<unknown>';
-    this.enabled = !!process.env.ATOM_GITHUB_FS_EVENT_LOG;
-
-    if (this.enabled) {
-      // eslint-disable-next-line no-console
-      console.log(`Creating logger for ${this.name}`);
-    }
+  constructor(kind) {
+    this.kind = kind;
+    this.directory = '<unknown>';
+    this.shortDirectory = '<unknown>';
   }
 
-  showStarted(path) {
-    this.path = path;
+  showStarted(directory) {
+    this.directory = directory;
+    this.shortDirectory = path.basename(directory);
 
-    if (!this.enabled) {
+    if (!this.isEnabled()) {
       return;
     }
 
-    // eslint-disable-next-line no-console
-    console.log(`${this.name} started watcher at path [${path}]`);
+    this.shortLog('watcher started');
   }
 
   showEvents(events) {
-    if (!this.enabled) {
+    if (!this.isEnabled()) {
       return;
     }
 
-    const prettyPrinted = util.inspect(events);
+    const uniqueRelativeNames = new Set(events.map(event => {
+      const fullPath = path.join(event.directory, event.file || event.newFile);
+      return path.relative(this.directory, fullPath);
+    }));
 
-    // eslint-disable-next-line no-console
-    console.log(`${this.name} @ [${this.path}] received events:\n${prettyPrinted}`);
+    const fileNames = Array.from(uniqueRelativeNames).slice(0, 3);
+    const elipses = uniqueRelativeNames.size > 3 ? '...' : '';
+    const summary = `${this.getShortName()}: ${fileNames.join(', ')}${elipses}`;
+
+    /* eslint-disable no-console */
+    console.groupCollapsed(summary);
+    console.table(events.map(event => ({
+      directory: event.directory,
+      file: event.file,
+      newFile: event.newFile,
+      action: actionText.get(event.action) || `(unknown: ${event.action})`,
+    })), ['directory', 'action', 'file', 'newFile']);
+    console.groupEnd();
+    /* eslint-enable no-console */
+  }
+
+  showFocusEvent() {
+    if (!this.isEnabled()) {
+      return;
+    }
+
+    this.shortLog('focus triggered');
   }
 
   showWorkdirOrHeadEvents() {
-    if (!this.enabled) {
+    if (!this.isEnabled()) {
       return;
     }
 
-    // eslint-disable-next-line no-console
-    console.log(`${this.name} @ [${this.path}] about to broadcast did-change-workdir-or-head`);
+    this.shortLog('working directory or HEAD change');
   }
 
   showStopped() {
-    if (!this.enabled) {
+    if (!this.isEnabled()) {
       return;
     }
 
+    this.shortLog('stopped');
+  }
+
+  isEnabled() {
+    return atom.config.get('github.filesystemEventDiagnostics');
+  }
+
+  getShortName() {
+    return `${this.kind} @ ${this.shortDirectory}`;
+  }
+
+  shortLog(line) {
     // eslint-disable-next-line no-console
-    console.log(`${this.name} stopped watcher at path [${this.path}]`);
+    console.log('%c%s%c: %s',
+      'font-weight: bold; color: blue;',
+      this.getShortName(),
+      'font-weight: normal; color: black;',
+      line,
+    );
   }
 }
