Merge pull request #1280 from simba909/feature/automagically-colored-diagnostics

Implement support for automatically coloring output in DiagnosticsFormatter

Author: DougGregor

Sources/SwiftDiagnostics/DiagnosticsFormatter.swift

@@ -139,10 +139,11 @@ public struct DiagnosticsFormatter {
     switch message.severity {
     case .error:
       let annotation = ANSIAnnotation(color: .red, trait: .bold)
-      return annotation.applied(to: message.message)
+      return annotation.applied(to: "error: \(message.message)")
     case .warning:
-      let annotation = ANSIAnnotation(color: .yellow)
-      return annotation.applied(to: message.message)
+      let color = ANSIAnnotation(color: .yellow)
+      let prefix = color.withTrait(.bold).applied(to: "warning: ")
+      return prefix + color.applied(to: message.message)
     case .note:
       return message.message
     }
@@ -181,6 +182,10 @@ struct ANSIAnnotation {
     self.trait = trait
   }
 
+  func withTrait(_ trait: Trait) -> Self {
+    return ANSIAnnotation(color: self.color, trait: trait)
+  }
+
   func applied(to message: String) -> String {
     // Resetting after the message ensures that we don't color unintended lines in the output
     return "\(code)\(message)\(ANSIAnnotation.normal.code)"

Sources/swift-parser-cli/TerminalUtils.swift

@@ -0,0 +1,51 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#if canImport(Glibc)
+import Glibc
+#elseif os(Windows)
+import CRT
+#else
+import Darwin.C
+#endif
+
+#if os(Android)
+typealias FILEPointer = OpaquePointer
+#else
+typealias FILEPointer = UnsafeMutablePointer<FILE>
+#endif
+
+enum TerminalHelper {
+  static var isConnectedToTerminal: Bool {
+    return isTTY(stderr)
+  }
+
+  /// Checks if passed file pointer is a tty.
+  static func isTTY(_ filePointer: FILEPointer) -> Bool {
+    return terminalType(filePointer) == .tty
+  }
+
+  /// The type of terminal.
+  enum TerminalType {
+    /// The terminal is a TTY.
+    case tty
+
+    /// The terminal is a file stream.
+    case file
+  }
+
+  /// Computes the terminal type of the stream.
+  static func terminalType(_ filePointer: FILEPointer) -> TerminalType {
+    let isTTY = isatty(fileno(filePointer)) != 0
+    return isTTY ? .tty : .file
+  }
+}

Sources/swift-parser-cli/swift-parser-cli.swift

@@ -198,17 +198,22 @@ class PrintDiags: ParsableCommand {
   @Flag(name: .long, help: "Perform sequence folding with the standard operators")
   var foldSequences: Bool = false
 
-  @Flag(name: .long, help: "Colorize output with ANSI color codes")
+  @Flag(name: .long, help: "Force output coloring with ANSI color codes")
   var colorize: Bool = false
 
   func run() throws {
     let source = try getContentsOfSourceFile(at: sourceFile)
 
     source.withUnsafeBufferPointer { sourceBuffer in
       let tree = Parser.parse(source: sourceBuffer)
-
       var diags = ParseDiagnosticsGenerator.diagnostics(for: tree)
-      print(DiagnosticsFormatter.annotatedSource(tree: tree, diags: diags, colorize: colorize))
+      let annotatedSource = DiagnosticsFormatter.annotatedSource(
+        tree: tree,
+        diags: diags,
+        colorize: colorize || TerminalHelper.isConnectedToTerminal
+      )
+
+      print(annotatedSource)
 
       if foldSequences {
         diags += foldAllSequences(tree).1

Tests/SwiftDiagnosticsTest/DiagnosticsFormatterTests.swift

@@ -101,7 +101,7 @@ final class DiagnosticsFormatterTests: XCTestCase {
 
     let expectedOutput = """
       1 │ var foo = bar +
-        ∣                ╰─ \u{001B}[1;31mexpected expression in variable\u{001B}[0;0m
+        ∣                ╰─ \u{001B}[1;31merror: expected expression in variable\u{001B}[0;0m
 
       """
     AssertStringsEqualWithDiff(expectedOutput, annotate(source: source, colorize: true))
@@ -113,9 +113,9 @@ final class DiagnosticsFormatterTests: XCTestCase {
       """
     let expectedOutput = """
       1 │ foo.[].[].[]
-        ∣     │  │  ╰─ \u{001B}[1;31mexpected name in member access\u{001B}[0;0m
-        ∣     │  ╰─ \u{001B}[1;31mexpected name in member access\u{001B}[0;0m
-        ∣     ╰─ \u{001B}[1;31mexpected name in member access\u{001B}[0;0m
+        ∣     │  │  ╰─ \u{001B}[1;31merror: expected name in member access\u{001B}[0;0m
+        ∣     │  ╰─ \u{001B}[1;31merror: expected name in member access\u{001B}[0;0m
+        ∣     ╰─ \u{001B}[1;31merror: expected name in member access\u{001B}[0;0m
 
       """
     AssertStringsEqualWithDiff(expectedOutput, annotate(source: source, colorize: true))