Make formatting use config file by default

Author: Trzyipolkostkicukru

Sources/SourceKit/sourcekitd/SwiftLanguageServer.swift

@@ -694,11 +694,20 @@ extension SwiftLanguageServer {
     }
     let options = req.params.options
     self.queue.async {
-      var config = SwiftFormatConfiguration.Configuration()
-      config.indentation = options.insertSpaces ? .spaces(options.tabSize) : .tabs(1)
-      config.tabWidth = options.tabSize
+      let configuration: SwiftFormatConfiguration.Configuration
+      // try to load swift-format configuration from a ".swift-format" file
+      // if it fails, use values provided by the lsp
+      if let configUrl = Configuration.url(forConfigurationFileApplyingTo: file),
+        let config = try? Configuration(contentsOf: configUrl) {
+          configuration = config
+      } else {
+        var config = SwiftFormatConfiguration.Configuration()
+        config.indentation = options.insertSpaces ? .spaces(options.tabSize) : .tabs(1)
+        config.tabWidth = options.tabSize
+        configuration = config
+      }
 
-      let formatter = SwiftFormat.SwiftFormatter(configuration: config)
+      let formatter = SwiftFormat.SwiftFormatter(configuration: configuration)
       do {
         let lines = try LineTable(String(contentsOf: file))
         guard let lastLine = lines.last else {

Tests/INPUTS/Formatting/.swift-format

@@ -0,0 +1,4 @@
+This file is intentionally an invalid swift-format configuration file. It is used to test 
+the behavior when program cannot find a valid file. We cannot just left this directory blank, 
+because swift-format searches for the configuration in parent directories, and it's possible 
+that user has another configuration file somewhere outside the Tests.

Tests/INPUTS/Formatting/Root.swift

@@ -0,0 +1,4 @@
+/*Root*/
+struct Root {
+var bar = 123
+}

Tests/INPUTS/Formatting/a.swift

@@ -0,0 +1,6 @@
+{
+    "version": 1,
+    "indentation": {
+        "spaces": 1
+    },
+}

Tests/INPUTS/Formatting/directory/.swift-format

@@ -0,0 +1,4 @@
+/*Directory*/
+struct Directory {
+var bar = 123
+}

Tests/INPUTS/Formatting/directory/Directory.swift

@@ -0,0 +1,6 @@
+{
+    "version": 1,
+    "indentation": {
+        "spaces": 4
+    },
+}

Tests/INPUTS/Formatting/directory/NestedWithConfig/.swift-format

@@ -0,0 +1,4 @@
+/*NestedWithConfig*/
+struct NestedWithConfig {
+var bar = 123
+}

Tests/INPUTS/Formatting/directory/NestedWithConfig/NestedWithConfig.swift

@@ -0,0 +1,4 @@
+/*NestedWithoutConfig*/
+struct NestedWithoutConfig {
+var bar = 123
+}

Tests/INPUTS/Formatting/directory/NestedWithoutConfig/NestedWithoutConfig.swift

@@ -1 +1,8 @@
-{"sources": ["a.swift"]}
+{
+  "sources": [
+    "Root.swift", 
+    "Directory/Directory.swift", 
+    "Directory/NestedWithConfig/NestedWithConfig.swift", 
+    "Directory/NestedWithoutConfig/NestedWithoutConfig.swift"
+  ]
+}

Tests/INPUTS/Formatting/project.json

@@ -15,39 +15,46 @@ import SKTestSupport
 import XCTest
 import ISDBTestSupport
 
+
+// Note that none of the indentation values choosen are equal to the default
+// indentation level, which is two spaces.
 final class FormattingTests: XCTestCase {
   var workspace: SKTibsTestWorkspace! = nil
 
   func initialize() throws {
-    workspace = try staticSourceKitTibsWorkspace(name: "Formatting")!
+    workspace = try XCTUnwrap(staticSourceKitTibsWorkspace(name: "Formatting"))
     try workspace.buildAndIndex()
-    try workspace.openDocument(workspace.testLoc("a.swift").url, language: .swift)
+    try workspace.openDocument(workspace.testLoc("Root").url, language: .swift)
+    try workspace.openDocument(workspace.testLoc("Directory").url, language: .swift)
+    try workspace.openDocument(workspace.testLoc("NestedWithConfig").url, language: .swift)
+    try workspace.openDocument(workspace.testLoc("NestedWithoutConfig").url, language: .swift)
   }
   override func tearDown() {
     workspace = nil
   }
 
-  func performFormattingRequest(file url: URL, options: FormattingOptions) -> [TextEdit]? {
+  func performFormattingRequest(file url: URL, options: FormattingOptions) throws -> [TextEdit]? {
     let request = DocumentFormattingRequest(
       textDocument: TextDocumentIdentifier(url), 
       options: options
     )
-    return try! workspace.sk.sendSync(request)!
+    return try workspace.sk.sendSync(request)
   }
 
   func testSpaces() throws {
     XCTAssertNoThrow(try initialize())
-    let url = workspace.testLoc("a.swift").url
+    let url = workspace.testLoc("Root").url
     let options = FormattingOptions(tabSize: 3, insertSpaces: true)
     let edits = try XCTUnwrap(performFormattingRequest(file: url, options: options))
     XCTAssertEqual(edits.count, 1)
     let firstEdit = try XCTUnwrap(edits.first)
     XCTAssertEqual(firstEdit.range.lowerBound, Position(line: 0, utf16index: 0))
     XCTAssertEqual(firstEdit.range.upperBound, Position(line: 3, utf16index: 1))
     // var bar needs to be indented with three spaces
+    // which is the value from lsp
     XCTAssertEqual(firstEdit.newText, #"""
-    /*a.swift*/
-    struct Foo {
+    /*Root*/
+    struct Root {
        var bar = 123
     }
 
@@ -56,20 +63,81 @@ final class FormattingTests: XCTestCase {
 
   func testTabs() throws {
     try initialize()
-    let url = workspace.testLoc("a.swift").url
+    let url = workspace.testLoc("Root").url
     let options = FormattingOptions(tabSize: 3, insertSpaces: false)
     let edits = try XCTUnwrap(performFormattingRequest(file: url, options: options))
     XCTAssertEqual(edits.count, 1)
     let firstEdit = try XCTUnwrap(edits.first)
     XCTAssertEqual(firstEdit.range.lowerBound, Position(line: 0, utf16index: 0))
     XCTAssertEqual(firstEdit.range.upperBound, Position(line: 3, utf16index: 1))
     // var bar needs to be indented with a tab
+    // which is the value from lsp
     XCTAssertEqual(firstEdit.newText, #"""
-    /*a.swift*/
-    struct Foo {
+    /*Root*/
+    struct Root {
     \#tvar bar = 123
     }
 
     """#)
   }
+
+  func testConfigFile() throws {
+    XCTAssertNoThrow(try initialize())
+    let url = workspace.testLoc("Directory").url
+    let options = FormattingOptions(tabSize: 3, insertSpaces: true)
+    let edits = try XCTUnwrap(performFormattingRequest(file: url, options: options))
+    XCTAssertEqual(edits.count, 1)
+    let firstEdit = try XCTUnwrap(edits.first)
+    XCTAssertEqual(firstEdit.range.lowerBound, Position(line: 0, utf16index: 0))
+    XCTAssertEqual(firstEdit.range.upperBound, Position(line: 3, utf16index: 1))
+    // var bar needs to be indented with one space
+    // which is the value from ".swift-format" in "Directory"
+    XCTAssertEqual(firstEdit.newText, #"""
+    /*Directory*/
+    struct Directory {
+     var bar = 123
+    }
+
+    """#)
+  }
+  
+  func testConfigFileInParentDirectory() throws {
+    XCTAssertNoThrow(try initialize())
+    let url = workspace.testLoc("NestedWithoutConfig").url
+    let options = FormattingOptions(tabSize: 3, insertSpaces: true)
+    let edits = try XCTUnwrap(performFormattingRequest(file: url, options: options))
+    XCTAssertEqual(edits.count, 1)
+    let firstEdit = try XCTUnwrap(edits.first)
+    XCTAssertEqual(firstEdit.range.lowerBound, Position(line: 0, utf16index: 0))
+    XCTAssertEqual(firstEdit.range.upperBound, Position(line: 3, utf16index: 1))
+    // var bar needs to be indented with one space
+    // which is the value from ".swift-format" in "Directory"
+    XCTAssertEqual(firstEdit.newText, #"""
+    /*NestedWithoutConfig*/
+    struct NestedWithoutConfig {
+     var bar = 123
+    }
+
+    """#)
+  }
+
+  func testConfigFileInNestedDirectory() throws {
+    XCTAssertNoThrow(try initialize())
+    let url = workspace.testLoc("NestedWithConfig").url
+    let options = FormattingOptions(tabSize: 3, insertSpaces: true)
+    let edits = try XCTUnwrap(performFormattingRequest(file: url, options: options))
+    XCTAssertEqual(edits.count, 1)
+    let firstEdit = try XCTUnwrap(edits.first)
+    XCTAssertEqual(firstEdit.range.lowerBound, Position(line: 0, utf16index: 0))
+    XCTAssertEqual(firstEdit.range.upperBound, Position(line: 3, utf16index: 1))
+    // var bar needs to be indented with four spaces
+    // which is the value from ".swift-format" in "NestedWithConfig"
+    XCTAssertEqual(firstEdit.newText, #"""
+    /*NestedWithConfig*/
+    struct NestedWithConfig {
+        var bar = 123
+    }
+
+    """#)
+  }
 }