chore: Add line returns to clog output (#414)

kylecarbs · web-flow · commit 753937ad4995 · 2021-08-12T09:21:35.000-05:00
diff --git a/pkg/clog/clog.go b/pkg/clog/clog.go
@@ -35,12 +35,11 @@ type CLIError struct {
 // String formats the CLI message for consumption by a human.
 func (m CLIMessage) String() string {
 	var str strings.Builder
-	str.WriteString(fmt.Sprintf("%s: %s\n",
+	fmt.Fprintf(&str, "%s: %s\r\n",
 		color.New(m.Color).Sprint(m.Level),
-		color.New(color.Bold).Sprint(m.Header)),
-	)
+		color.New(color.Bold).Sprint(m.Header))
 	for _, line := range m.Lines {
-		str.WriteString(fmt.Sprintf("  %s %s\n", color.New(m.Color).Sprint("|"), line))
+		fmt.Fprintf(&str, "  %s %s\r\n", color.New(m.Color).Sprint("|"), line)
 	}
 	return str.String()
 }
diff --git a/pkg/clog/clog_test.go b/pkg/clog/clog_test.go
@@ -25,7 +25,7 @@ func TestError(t *testing.T) {
 		output, err := ioutil.ReadAll(&buf)
 		assert.Success(t, "read all stderr output", err)
 
-		assert.Equal(t, "output is as expected", "error: fake error\n\n", string(output))
+		assert.Equal(t, "output is as expected", "error: fake error\r\n\n", string(output))
 	})
 
 	t.Run("plain-error", func(t *testing.T) {
@@ -41,7 +41,7 @@ func TestError(t *testing.T) {
 		output, err := ioutil.ReadAll(&buf)
 		assert.Success(t, "read all stderr output", err)
 
-		assert.Equal(t, "output is as expected", "fatal: wrap 1: base error\n\n", string(output))
+		assert.Equal(t, "output is as expected", "fatal: wrap 1: base error\r\n\n", string(output))
 	})
 
 	t.Run("message", func(t *testing.T) {
@@ -58,7 +58,7 @@ func TestError(t *testing.T) {
 			output, err := ioutil.ReadAll(&buf)
 			assert.Success(t, "read all stderr output", err)
 
-			assert.Equal(t, "output is as expected", f.level+": testing\n  | hint: maybe do \"this\"\n  | \n  | cause: what happened was \"this\"\n", string(output))
+			assert.Equal(t, "output is as expected", f.level+": testing\r\n  | hint: maybe do \"this\"\r\n  | \r\n  | cause: what happened was \"this\"\r\n", string(output))
 		}
 	})
 
@@ -78,7 +78,7 @@ func TestError(t *testing.T) {
 
 		assert.Equal(t,
 			"output is as expected",
-			"error: fake header\n  | next line\n  | \n  | tip: content of fake tip\n\n",
+			"error: fake header\r\n  | next line\r\n  | \r\n  | tip: content of fake tip\r\n\n",
 			string(output),
 		)
 	})
diff --git a/pkg/clog/errgroup_test.go b/pkg/clog/errgroup_test.go
@@ -37,7 +37,7 @@ func TestErrGroup(t *testing.T) {
 
 		err := egroup.Wait()
 		assert.ErrorContains(t, "error group wait", err, "2 failures emitted")
-		assert.True(t, "log buf contains", strings.Contains(buf.String(), "fatal: whoops\n\n"))
-		assert.True(t, "log buf contains", strings.Contains(buf.String(), "error: rich error\n  | second line\n\n"))
+		assert.True(t, "log buf contains", strings.Contains(buf.String(), "fatal: whoops\r\n\n"))
+		assert.True(t, "log buf contains", strings.Contains(buf.String(), "error: rich error\r\n  | second line\r\n\n"))
 	})
 }

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ func TestErrGroup(t *testing.T) {`
`37`	`37`
`38`	`38`	`err := egroup.Wait()`
`39`	`39`	`assert.ErrorContains(t, "error group wait", err, "2 failures emitted")`
`40`		`- assert.True(t, "log buf contains", strings.Contains(buf.String(), "fatal: whoops\n\n"))`
`41`		`- assert.True(t, "log buf contains", strings.Contains(buf.String(), "error: rich error\n \| second line\n\n"))`
	`40`	`+ assert.True(t, "log buf contains", strings.Contains(buf.String(), "fatal: whoops\r\n\n"))`
	`41`	`+ assert.True(t, "log buf contains", strings.Contains(buf.String(), "error: rich error\r\n \| second line\r\n\n"))`
`42`	`42`	`})`
`43`	`43`	`}`