Merge pull request #2158 from DougGregor/colorize-less-often

DougGregor · web-flow · commit 335d3417646a · 2023-09-06T22:15:14.000-07:00
[Diagnostics] Avoid adjacent ANSI sequences when not needed
diff --git a/Sources/SwiftDiagnostics/DiagnosticsFormatter.swift b/Sources/SwiftDiagnostics/DiagnosticsFormatter.swift
@@ -342,7 +342,7 @@ public struct DiagnosticsFormatter {
       severityAnnotation = .remarkText
     }
 
-    let prefix = colorizeIfRequested("\(severityText): ", annotation: severityAnnotation)
+    let prefix = colorizeIfRequested("\(severityText): ", annotation: severityAnnotation, resetAfter: false)
 
     return prefix + colorizeIfRequested(message, annotation: .diagnosticText);
   }
@@ -351,13 +351,14 @@ public struct DiagnosticsFormatter {
   /// supposed to color the output.
   private func colorizeIfRequested(
     _ text: String,
-    annotation: ANSIAnnotation
+    annotation: ANSIAnnotation,
+    resetAfter: Bool = true
   ) -> String {
     guard colorize, !text.isEmpty else {
       return text
     }
 
-    return annotation.applied(to: text)
+    return annotation.applied(to: text, resetAfter: resetAfter)
   }
 
   /// Colorize for the buffer outline and line numbers.
@@ -403,7 +404,11 @@ struct ANSIAnnotation {
     return ANSIAnnotation(color: self.color, trait: trait)
   }
 
-  func applied(to message: String) -> String {
+  func applied(to message: String, resetAfter: Bool = true) -> String {
+    guard resetAfter else {
+      return "\(code)\(message)"
+    }
+
     // Resetting after the message ensures that we don't color unintended lines in the output
     return "\(code)\(message)\(ANSIAnnotation.normal.code)"
   }
diff --git a/Tests/SwiftDiagnosticsTest/DiagnosticsFormatterTests.swift b/Tests/SwiftDiagnosticsTest/DiagnosticsFormatterTests.swift
@@ -101,7 +101,7 @@ final class DiagnosticsFormatterTests: XCTestCase {
 
     let expectedOutput = """
       \u{001B}[0;36m1 │\u{001B}[0;0m var foo = bar +
-        \u{001B}[0;36m│\u{001B}[0;0m                ╰─ \u{001B}[1;31merror: \u{001B}[0;0m\u{001B}[1;39mexpected expression after operator\u{001B}[0;0m
+        \u{001B}[0;36m│\u{001B}[0;0m                ╰─ \u{001B}[1;31merror: \u{001B}[1;39mexpected expression after operator\u{001B}[0;0m
 
       """
     assertStringsEqualWithDiff(annotate(source: source, colorize: true), expectedOutput)
@@ -113,9 +113,9 @@ final class DiagnosticsFormatterTests: XCTestCase {
       """
     let expectedOutput = """
       \u{001B}[0;36m1 │\u{001B}[0;0m foo.[].[].[]
-        \u{001B}[0;36m│\u{001B}[0;0m     │  │  ╰─ \u{001B}[1;31merror: \u{001B}[0;0m\u{001B}[1;39mexpected name in member access\u{001B}[0;0m
-        \u{001B}[0;36m│\u{001B}[0;0m     │  ╰─ \u{001B}[1;31merror: \u{001B}[0;0m\u{001B}[1;39mexpected name in member access\u{001B}[0;0m
-        \u{001B}[0;36m│\u{001B}[0;0m     ╰─ \u{001B}[1;31merror: \u{001B}[0;0m\u{001B}[1;39mexpected name in member access\u{001B}[0;0m
+        \u{001B}[0;36m│\u{001B}[0;0m     │  │  ╰─ \u{001B}[1;31merror: \u{001B}[1;39mexpected name in member access\u{001B}[0;0m
+        \u{001B}[0;36m│\u{001B}[0;0m     │  ╰─ \u{001B}[1;31merror: \u{001B}[1;39mexpected name in member access\u{001B}[0;0m
+        \u{001B}[0;36m│\u{001B}[0;0m     ╰─ \u{001B}[1;31merror: \u{001B}[1;39mexpected name in member access\u{001B}[0;0m
 
       """
     assertStringsEqualWithDiff(annotate(source: source, colorize: true), expectedOutput)
@@ -128,8 +128,8 @@ final class DiagnosticsFormatterTests: XCTestCase {
 
     let expectedOutput = """
       \u{001B}[0;36m1 │\u{001B}[0;0m for \u{001B}[4;39m(i\u{001B}[0;0m \u{001B}[4;39m= 🐮; i != 👩‍👩‍👦‍👦; i += 1)\u{001B}[0;0m { }
-        \u{001B}[0;36m│\u{001B}[0;0m │      ╰─ \u{001B}[1;31merror: \u{001B}[0;0m\u{001B}[1;39mexpected ')' to end tuple pattern\u{001B}[0;0m
-        \u{001B}[0;36m│\u{001B}[0;0m ╰─ \u{001B}[1;31merror: \u{001B}[0;0m\u{001B}[1;39mC-style for statement has been removed in Swift 3\u{001B}[0;0m
+        \u{001B}[0;36m│\u{001B}[0;0m │      ╰─ \u{001B}[1;31merror: \u{001B}[1;39mexpected ')' to end tuple pattern\u{001B}[0;0m
+        \u{001B}[0;36m│\u{001B}[0;0m ╰─ \u{001B}[1;31merror: \u{001B}[1;39mC-style for statement has been removed in Swift 3\u{001B}[0;0m
 
       """
 

Original file line number	Diff line number	Diff line change
`@@ -342,7 +342,7 @@ public struct DiagnosticsFormatter {`
`342`	`342`	`severityAnnotation = .remarkText`
`343`	`343`	`}`
`344`	`344`
`345`		`- let prefix = colorizeIfRequested("\(severityText): ", annotation: severityAnnotation)`
	`345`	`+ let prefix = colorizeIfRequested("\(severityText): ", annotation: severityAnnotation, resetAfter: false)`
`346`	`346`
`347`	`347`	`return prefix + colorizeIfRequested(message, annotation: .diagnosticText);`
`348`	`348`	`}`
`@@ -351,13 +351,14 @@ public struct DiagnosticsFormatter {`
`351`	`351`	`/// supposed to color the output.`
`352`	`352`	`private func colorizeIfRequested(`
`353`	`353`	`_ text: String,`
`354`		`- annotation: ANSIAnnotation`
	`354`	`+ annotation: ANSIAnnotation,`
	`355`	`+ resetAfter: Bool = true`
`355`	`356`	`) -> String {`
`356`	`357`	`guard colorize, !text.isEmpty else {`
`357`	`358`	`return text`
`358`	`359`	`}`
`359`	`360`
`360`		`- return annotation.applied(to: text)`
	`361`	`+ return annotation.applied(to: text, resetAfter: resetAfter)`
`361`	`362`	`}`
`362`	`363`
`363`	`364`	`/// Colorize for the buffer outline and line numbers.`
`@@ -403,7 +404,11 @@ struct ANSIAnnotation {`
`403`	`404`	`return ANSIAnnotation(color: self.color, trait: trait)`
`404`	`405`	`}`
`405`	`406`
`406`		`- func applied(to message: String) -> String {`
	`407`	`+ func applied(to message: String, resetAfter: Bool = true) -> String {`
	`408`	`+ guard resetAfter else {`
	`409`	`+ return "\(code)\(message)"`
	`410`	`+ }`
	`411`	`+`
`407`	`412`	`// Resetting after the message ensures that we don't color unintended lines in the output`
`408`	`413`	`return "\(code)\(message)\(ANSIAnnotation.normal.code)"`
`409`	`414`	`}`