refactor: split up writers into separate modules

package.json

@@ -43,7 +43,6 @@
     "klaw": "^2.1.1",
     "kubernetes-client": "^5.2.0",
     "log-symbols": "^2.2.0",
-    "log-update": "^2.3.0",
     "moment": "^2.22.1",
     "node-emoji": "^1.8.1",
     "node-pty": "^0.7.4",

src/cli.ts

@@ -35,7 +35,7 @@ import {
   PluginError,
 } from "./exceptions"
 import { Garden } from "./garden"
-import { FileWriter } from "./logger/writers"
+import { FileWriter } from "./logger/writers/file-writer"
 import { getLogger, RootLogNode } from "./logger"
 import { resolve } from "path"
 import { BuildCommand } from "./commands/build"

src/logger/index.ts

@@ -25,7 +25,9 @@ import {
   LogEntryOpts,
   LogSymbolType,
 } from "./types"
-import { BasicTerminalWriter, FancyTerminalWriter, Writer } from "./writers"
+import { BasicTerminalWriter } from "./writers/basic-terminal-writer"
+import { FancyTerminalWriter } from "./writers/fancy-terminal-writer"
+import { Writer } from "./writers/base"
 import { ParameterError } from "../exceptions"
 
 const ROOT_DEPTH = -1

src/logger/renderers.ts

@@ -116,3 +116,28 @@ export function renderDuration(entry: LogEntry): string {
     ? msgStyle(` (finished in ${duration(entry.timestamp)}s)`)
     : ""
 }
+
+export function formatForTerminal(entry: LogEntry): string {
+  let renderers
+  if (entry.depth > 0) {
+    // Skip section on child entries.
+    renderers = [
+      [leftPad, [entry]],
+      [renderSymbol, [entry]],
+      [renderEmoji, [entry]],
+      [renderMsg, [entry]],
+      [renderDuration, [entry]],
+      ["\n"],
+    ]
+  } else {
+    renderers = [
+      [renderSymbol, [entry]],
+      [renderSection, [entry]],
+      [renderEmoji, [entry]],
+      [renderMsg, [entry]],
+      [renderDuration, [entry]],
+      ["\n"],
+    ]
+  }
+  return combine(renderers)
+}

src/logger/util.ts

@@ -6,7 +6,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-import { LogEntryOpts } from "./types"
+import { LogEntryOpts, LogLevel } from "./types"
 import { LogEntry, LogNode } from "."
 
 export interface Node {
@@ -107,7 +107,7 @@ export function interceptStream(stream: NodeJS.WriteStream, callback: Function)
   return restore
 }
 
-export const getTerminalWidth = (stream: NodeJS.WriteStream = process.stdout) => {
+export function getTerminalWidth(stream: NodeJS.WriteStream = process.stdout) {
   const columns = (stream || {}).columns
 
   if (!columns) {
@@ -121,3 +121,7 @@ export const getTerminalWidth = (stream: NodeJS.WriteStream = process.stdout) =>
 
   return columns
 }
+
+export function validate(level: LogLevel, entry: LogEntry): boolean {
+  return level >= entry.level && entry.opts.msg !== undefined
+}

src/logger/writers/base.ts

@@ -0,0 +1,21 @@
+import {
+  LogLevel,
+} from "../types"
+
+import { LogEntry, RootLogNode } from "../index"
+
+export interface WriterConfig {
+  level?: LogLevel
+}
+
+export abstract class Writer {
+  public level: LogLevel | undefined
+
+  constructor({ level }: WriterConfig = {}) {
+    this.level = level
+  }
+
+  abstract render(...args): string | string[] | null
+  abstract onGraphChange(entry: LogEntry, rootLogNode: RootLogNode): void
+  abstract stop(): void
+}

src/logger/writers/basic-terminal-writer.ts

@@ -0,0 +1,30 @@
+import {
+  LogLevel,
+} from "../types"
+import {
+  formatForTerminal,
+} from "../renderers"
+import { LogEntry, RootLogNode } from "../index"
+import { validate } from "../util"
+import { Writer } from "./base"
+
+export class BasicTerminalWriter extends Writer {
+  public level: LogLevel
+
+  render(entry: LogEntry, rootLogNode: RootLogNode): string | null {
+    const level = this.level || rootLogNode.level
+    if (validate(level, entry)) {
+      return formatForTerminal(entry)
+    }
+    return null
+  }
+
+  onGraphChange(entry: LogEntry, rootLogNode: RootLogNode) {
+    const out = this.render(entry, rootLogNode)
+    if (out) {
+      console.log(out)
+    }
+  }
+
+  stop() { }
+}