fix(logger): appended error messages now rendered properly

garden-cli/src/logger/renderers.ts

@@ -39,8 +39,8 @@ const cliPadEnd = (s: string, width: number): string => {
 }
 const truncateSection = (s: string) => cliTruncate(s, SECTION_PREFIX_WIDTH)
 const sectionStyle = (s: string) => chalk.cyan.italic(cliPadEnd(truncateSection(s), SECTION_PREFIX_WIDTH))
-const msgStyle = (s: string) => hasAnsi(s) ? s : chalk.gray(s)
-const errorStyle = chalk.red
+export const msgStyle = (s: string) => hasAnsi(s) ? s : chalk.gray(s)
+export const errorStyle = chalk.red
 
 /*** RENDER HELPERS ***/
 function insertVal(out: string[], idx: number, toRender: Function | string, renderArgs: any[]): string[] {
@@ -111,7 +111,9 @@ export function renderMsg(entry: LogEntry): string {
 
   const styleFn = status === "error" ? errorStyle : msgStyle
   if (isArray(msg)) {
-    return msg.map(styleFn).join(chalk.gray(" → "))
+    // We apply the style function to each item (as opposed to the entire string) in case some
+    // part of the message already has a style
+    return msg.map(str => styleFn(str)).join(styleFn(" → "))
   }
   return msg ? styleFn(msg) : ""
 }

garden-cli/test/src/logger.ts

@@ -4,6 +4,7 @@ import { BasicTerminalWriter } from "../../src/logger/writers/basic-terminal-wri
 import { FancyTerminalWriter } from "../../src/logger/writers/fancy-terminal-writer"
 import { getLogger } from "../../src/logger/logger"
 import { getChildNodes } from "../../src/logger/util"
+import { renderMsg, msgStyle, errorStyle } from "../../src/logger/renderers"
 
 const logger = getLogger()
 
@@ -218,6 +219,40 @@ describe("LogEntry", () => {
   })
 })
 
+describe("renderers", () => {
+  describe("renderMsg", () => {
+    it("should return an empty string if the entry is empty", () => {
+      const entry = logger.info()
+      expect(renderMsg(entry)).to.equal("")
+    })
+    it("should render the message with the message style", () => {
+      const entry = logger.info({ msg: "hello message" })
+      expect(renderMsg(entry)).to.equal(msgStyle("hello message"))
+    })
+    it("should join an array of messages with an arrow symbol and render with the message style", () => {
+      const entry = logger.info({ msg: ["message a", "message b"] })
+      expect(renderMsg(entry)).to.equal(msgStyle("message a") + msgStyle(" → ") + msgStyle("message b"))
+    })
+    it("should render the message without styles if the entry is from an intercepted stream", () => {
+      const entry = logger.info({ fromStdStream: true, msg: "hello stream" })
+      expect(renderMsg(entry)).to.equal("hello stream")
+    })
+    it("should join an array of messages and render without styles if the entry is from an intercepted stream", () => {
+      const entry = logger.info({ fromStdStream: true, msg: ["stream a", "stream b"] })
+      expect(renderMsg(entry)).to.equal("stream a stream b")
+    })
+    it("should render the message with the error style if the entry has error status", () => {
+      const entry = logger.info({ msg: "hello error", status: "error" })
+      expect(renderMsg(entry)).to.equal(errorStyle("hello error"))
+    })
+    it("should join an array of messages with an arrow symbol and render with the error style" +
+      " if the entry has error status", () => {
+        const entry = logger.info({ msg: ["error a", "error b"], status: "error" })
+        expect(renderMsg(entry)).to.equal(errorStyle("error a") + errorStyle(" → ") + errorStyle("error b"))
+      })
+  })
+})
+
 describe("util", () => {
   describe("getChildNodes", () => {
     it("should convert an n-ary tree into an ordered list of child nodes (skipping the root)", () => {