Cleanup and rewrite the README

Author: CodaFi

.travis.yml

@@ -8,7 +8,7 @@ matrix:
     osx_image: xcode8.2
     script:
     - swift test
-    - os: linux
+  - os: linux
     language: generic
     sudo: required
     dist: trusty

README.md

@@ -1,2 +1,67 @@
 # FileCheck
+[![Build Status](https://travis-ci.org/trill-lang/FileCheck.svg?branch=master)](https://travis-ci.org/trill-lang/FileCheck)
+
 A standalone Swift version of LLVM's flexible pattern matching file verifier
+
+## Introduction
+
+FileCheck is a utility for verifying the contents of two files match (for example,
+one from standard input, and one residing on disk).  This implementation of
+FileCheck emphasizes its use as a tool for checking output generated by programs
+against an expected set of strings that can be specified inline next to the
+`print` statement that generated it.
+
+The primary API in this package is the `fileCheckOutput` function, which comes
+with a number of convenient optional parameters to modify the behavior of the
+verification process.  For example, here is a self-contained test that verifies 
+the output of FizzBuzz:
+
+```swift
+assert(fileCheckOutput(withPrefixes: ["FIZZBUZZ"]) {
+  for i in (1..<10) {
+    var out = ""
+    if i % 3 == 0 {
+      out += "Fizz"
+    }
+    if i % 5 == 0 {
+      out += "Buzz"
+    }
+    if out.isEmpty {
+      out += "\(i)"
+    }
+    // FIZZBUZZ: 1
+    // FIZZBUZZ-NEXT: 2
+    // FIZZBUZZ-NEXT: Fizz
+    // FIZZBUZZ-NEXT: 4
+    // FIZZBUZZ-NEXT: Buzz
+    // FIZZBUZZ-NEXT: Fizz
+    // FIZZBUZZ-NEXT: 7
+    // FIZZBUZZ-NEXT: 8
+    // FIZZBUZZ-NEXT: Fizz
+    print(out)
+  }
+})
+```
+
+Executing this test in any file will cause FileCheck to read it in
+from disk and verify the output of the program against the check-strings in the 
+comments.
+
+## Setup
+
+**Using The Swift Package Manager**
+
+- Add FileCheck to your `Package.swift` file's dependencies section:
+
+```swift
+.Package(url: "https://github.com/trill-lang/FileCheck.git", versions: Version(0,0,1)..<Version(1,0,0))
+```
+
+## Authors
+
+- Harlan Haskins ([@harlanhaskins](https://github.com/harlanhaskins))
+- Robert Widmann ([@CodaFi](https://github.com/CodaFi))
+
+## License
+
+This project is released under the MIT license, a copy of which is available in this repo.

Sources/FileCheck/ANSIColor.swift

@@ -2,78 +2,117 @@ import Foundation
 
 /// Represents a stream that can write text with a specific set of ANSI colors
 protocol ColoredStream: TextOutputStream {
-    mutating func write(_ string: String, with: [ANSIColor])
+  mutating func write(_ string: String, with: [ANSIColor])
 }
 
 extension ColoredStream {
-    /// Default conformance to TextOutputStream
-    mutating func write(_ string: String) {
-        write(string, with: [])
-    }
+  /// Default conformance to TextOutputStream
+  mutating func write(_ string: String) {
+    write(string, with: [])
+  }
 }
 
 /// An output stream that prints to an underlying stream including ANSI color
 /// codes.
 class ColoredANSIStream<StreamTy: TextOutputStream>: ColoredStream {
 
-    typealias StreamType = StreamTy
+  typealias StreamType = StreamTy
 
-    var currentColors = [ANSIColor]()
-    var stream: StreamType
-    let colored: Bool
+  var currentColors = [ANSIColor]()
+  var stream: StreamType
+  let colored: Bool
 
-    /// Creates a new ColoredANSIStream that prints to an underlying stream.
-    ///
-    /// - Parameters:
-    ///   - stream: The underlying stream
-    ///   - colored: Whether to provide any colors or to pass text through
-    ///              unmodified. Set this to false and ColoredANSIStream is
-    ///              a transparent wrapper.
-    init(_ stream: inout StreamType, colored: Bool = true) {
-        self.stream = stream
-        self.colored = colored
-    }
+  /// Creates a new ColoredANSIStream that prints to an underlying stream.
+  ///
+  /// - Parameters:
+  ///   - stream: The underlying stream
+  ///   - colored: Whether to provide any colors or to pass text through
+  ///              unmodified. Set this to false and ColoredANSIStream is
+  ///              a transparent wrapper.
+  init(_ stream: inout StreamType, colored: Bool = true) {
+    self.stream = stream
+    self.colored = colored
+  }
 
-    /// Initializes with a stream, always colored.
-    ///
-    /// - Parameter stream: The underlying stream receiving writes.
-    required init(_ stream: inout StreamType) {
-        self.stream = stream
-        self.colored = true
-    }
+  /// Initializes with a stream, always colored.
+  ///
+  /// - Parameter stream: The underlying stream receiving writes.
+  required init(_ stream: inout StreamType) {
+    self.stream = stream
+    self.colored = true
+  }
 
-    /// Adds a color to the in-progress colors.
-    func addColor(_ color: ANSIColor) {
-        guard colored else { return }
-        stream.write(color.rawValue)
-        currentColors.append(color)
-    }
+  /// Adds a color to the in-progress colors.
+  func addColor(_ color: ANSIColor) {
+    guard colored else { return }
+    stream.write(color.rawValue)
+    currentColors.append(color)
+  }
 
-    /// Resets this stream back to the default color.
-    func reset() {
-        if currentColors.isEmpty { return }
-        stream.write(ANSIColor.reset.rawValue)
-        currentColors = []
-    }
+  /// Resets this stream back to the default color.
+  func reset() {
+    if currentColors.isEmpty { return }
+    stream.write(ANSIColor.reset.rawValue)
+    currentColors = []
+  }
 
-    /// Sets the current ANSI color codes to the passed-in colors.
-    func setColors(_ colors: [ANSIColor]) {
-        guard colored else { return }
-        reset()
-        for color in colors {
-            stream.write(color.rawValue)
-        }
-        currentColors = colors
+  /// Sets the current ANSI color codes to the passed-in colors.
+  func setColors(_ colors: [ANSIColor]) {
+    guard colored else { return }
+    reset()
+    for color in colors {
+      stream.write(color.rawValue)
     }
+    currentColors = colors
+  }
 
-    /// Writes the string to the output with the provided colors.
-    ///
-    /// - Parameters:
-    ///   - string: The string to write
-    ///   - colors: The colors used on the string
-    func write(_ string: String, with colors: [ANSIColor]) {
-        self.setColors(colors)
-        stream.write(string)
-        self.reset()
+  /// Writes the string to the output with the provided colors.
+  ///
+  /// - Parameters:
+  ///   - string: The string to write
+  ///   - colors: The colors used on the string
+  func write(_ string: String, with colors: [ANSIColor]) {
+    self.setColors(colors)
+    stream.write(string)
+    self.reset()
+  }
+}
+
+/// Represents the possible ANSI color codes.
+enum ANSIColor: String {
+  case black = "\u{001B}[30m"
+  case red = "\u{001B}[31m"
+  case green = "\u{001B}[32m"
+  case yellow = "\u{001B}[33m"
+  case blue = "\u{001B}[34m"
+  case magenta = "\u{001B}[35m"
+  case cyan = "\u{001B}[36m"
+  case white = "\u{001B}[37m"
+  case bold = "\u{001B}[1m"
+  case reset = "\u{001B}[0m"
+
+  func name() -> String {
+    switch self {
+    case .black: return "Black"
+    case .red: return "Red"
+    case .green: return "Green"
+    case .yellow: return "Yellow"
+    case .blue: return "Blue"
+    case .magenta: return "Magenta"
+    case .cyan: return "Cyan"
+    case .white: return "White"
+    case .bold: return "Bold"
+    case .reset: return "Reset"
     }
+  }
+
+  static func all() -> [ANSIColor] {
+    return [.black, .red, .green,
+            .yellow, .blue, .magenta,
+            .cyan, .white, .bold, .reset]
+  }
+}
+
+func + (left: ANSIColor, right: String) -> String {
+  return left.rawValue + right
 }

Sources/FileCheck/ColoredStream.swift

@@ -27,7 +27,6 @@ func diagnose(_ kind : DiagnosticKind, at loc : CheckLoc, with message : String,
   }
 }
 
-
 enum DiagnosticKind: String {
   case error
   case warning

Sources/FileCheck/Diagnostics.swift

@@ -214,7 +214,7 @@ private func findCheckType(in buf : UnsafeBufferPointer<CChar>, with prefix : St
     length: buf.count - (prefix.utf8.count + 1),
     encoding: .utf8,
     freeWhenDone: false
-    )!
+  )!
   if rest.hasPrefix("NEXT:") {
     return .next
   }
@@ -243,7 +243,8 @@ private func findCheckType(in buf : UnsafeBufferPointer<CChar>, with prefix : St
     "NOT-NEXT:",
     "SAME-NOT:",
     "NOT-SAME:",
-    ]
+  ]
+
   if badNotPrefixes.reduce(false, { (acc, s) in acc || rest.hasPrefix(s) }) {
     return .badNot
   }
@@ -493,12 +494,12 @@ private func check(input b : String, against checkStrings : [CheckString], optio
 
       checkRegion = checkRegion.substring(from: checkRegion.index(checkRegion.startIndex, offsetBy: NSMaxRange(range)))
     }
-
+    
     if j == checkStrings.count {
       break
     }
   }
-
+  
   // Success if no checks failed.
   return !failedChecks
 }

Sources/FileCheck/FileCheck.swift

@@ -1,6 +1,6 @@
 import XCTest
 
-@testable import LLVMTests
+@testable import FileCheckTests
 
 #if !os(macOS)
 XCTMain([