Merge pull request swiftlang#12 from allevato/take-source-as-string

Add lint/format APIs that take source text directly.

Author: allevato

Sources/SwiftFormat/SwiftFormatter.swift

@@ -61,19 +61,40 @@ public final class SwiftFormatter {
     try format(syntax: sourceFile, assumingFileURL: url, to: &outputStream)
   }
 
+  /// Formats the given Swift source code and writes the result to an output stream.
+  ///
+  /// - Parameters:
+  ///   - source: The Swift source code to be formatted.
+  ///   - url: A file URL denoting the filename/path that should be assumed for this syntax tree,
+  ///     which is associated with any diagnostics emitted during formatting. If this is nil, a
+  ///     dummy value will be used.
+  ///   - outputStream: A value conforming to `TextOutputStream` to which the formatted output will
+  ///     be written.
+  /// - Throws: If an unrecoverable error occurs when formatting the code.
+  public func format<Output: TextOutputStream>(
+    source: String, assumingFileURL url: URL?, to outputStream: inout Output
+  ) throws {
+    let sourceFile = try SyntaxParser.parse(source: source)
+    try format(syntax: sourceFile, assumingFileURL: url, to: &outputStream)
+  }
+
   /// Formats the given Swift syntax tree and writes the result to an output stream.
   ///
   /// - Parameters:
   ///   - syntax: The Swift syntax tree to be converted to source code and formatted.
-  ///   - url: A file URL denoting the filename/path that should be assumed for this syntax tree.
+  ///   - url: A file URL denoting the filename/path that should be assumed for this syntax tree,
+  ///     which is associated with any diagnostics emitted during formatting. If this is nil, a
+  ///     dummy value will be used.
   ///   - outputStream: A value conforming to `TextOutputStream` to which the formatted output will
   ///     be written.
   /// - Throws: If an unrecoverable error occurs when formatting the code.
   public func format<Output: TextOutputStream>(
-    syntax: SourceFileSyntax, assumingFileURL url: URL, to outputStream: inout Output
+    syntax: SourceFileSyntax, assumingFileURL url: URL?, to outputStream: inout Output
   ) throws {
+    let assumedURL = url ?? URL(fileURLWithPath: "source")
+
     let context = Context(
-      configuration: configuration, diagnosticEngine: diagnosticEngine, fileURL: url,
+      configuration: configuration, diagnosticEngine: diagnosticEngine, fileURL: assumedURL,
       sourceFileSyntax: syntax)
     let pipeline = FormatPipeline(context: context)
     let transformedSyntax = pipeline.visit(syntax)
@@ -89,6 +110,4 @@ public final class SwiftFormatter {
       printTokenStream: debugOptions.contains(.dumpTokenStream))
     outputStream.write(printer.prettyPrint())
   }
-
-  // TODO: Add an overload of `format` that takes the source text directly.
 }

Sources/SwiftFormat/SwiftLinter.swift

@@ -57,13 +57,22 @@ public final class SwiftLinter {
     try lint(syntax: sourceFile, assumingFileURL: url)
   }
 
+  /// Lints the given Swift source code.
+  ///
+  /// - Parameters:
+  ///   - source: The Swift source code to be linted.
+  ///   - url: A file URL denoting the filename/path that should be assumed for this source code.
+  /// - Throws: If an unrecoverable error occurs when formatting the code.
+  public func lint(source: String, assumingFileURL url: URL) throws {
+    let sourceFile = try SyntaxParser.parse(url)
+    try lint(syntax: sourceFile, assumingFileURL: url)
+  }
+
   /// Lints the given Swift syntax tree.
   ///
   /// - Parameters:
   ///   - syntax: The Swift syntax tree to be converted to be linted.
   ///   - url: A file URL denoting the filename/path that should be assumed for this syntax tree.
-  ///   - outputStream: A value conforming to `TextOutputStream` to which the formatted output will
-  ///     be written.
   /// - Throws: If an unrecoverable error occurs when formatting the code.
   public func lint(syntax: SourceFileSyntax, assumingFileURL url: URL) throws {
     let context = Context(
@@ -82,6 +91,4 @@ public final class SwiftLinter {
     let ws = WhitespaceLinter(user: syntax.description, formatted: formatted, context: context)
     ws.lint()
   }
-
-  // TODO: Add an overload of `lint` that takes the source text directly.
 }