1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 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
//
//===----------------------------------------------------------------------===//
import LSPLogging
import LSPTestSupport
import LanguageServerProtocol
import SKTestSupport
import SourceKitLSP
import XCTest
final class FormattingTests: XCTestCase {
func testFormatting() async throws {
try await SkipUnless.toolchainContainsSwiftFormat()
let testClient = try await TestSourceKitLSPClient()
let uri = DocumentURI(for: .swift)
let positions = testClient.openDocument(
"""
struct S {
1️⃣var foo: 2️⃣ 3️⃣Int
4️⃣var bar: Int
}5️⃣
""",
uri: uri
)
let response = try await testClient.send(
DocumentFormattingRequest(
textDocument: TextDocumentIdentifier(uri),
options: FormattingOptions(tabSize: 3, insertSpaces: true)
)
)
let edits = try XCTUnwrap(response)
XCTAssertEqual(
edits,
[
TextEdit(range: Range(positions["1️⃣"]), newText: " "),
TextEdit(range: positions["2️⃣"]..<positions["3️⃣"], newText: ""),
TextEdit(range: Range(positions["4️⃣"]), newText: " "),
TextEdit(range: Range(positions["5️⃣"]), newText: "\n"),
]
)
}
func testFormattingNoEdits() async throws {
try await SkipUnless.toolchainContainsSwiftFormat()
let testClient = try await TestSourceKitLSPClient()
let uri = DocumentURI(for: .swift)
testClient.openDocument(
"""
struct S {
var foo: Int
}
""",
uri: uri
)
let response = try await testClient.send(
DocumentFormattingRequest(
textDocument: TextDocumentIdentifier(uri),
options: FormattingOptions(tabSize: 2, insertSpaces: true)
)
)
let edits = try XCTUnwrap(response)
XCTAssertEqual(edits.count, 0)
}
func testConfigFileOnDisk() async throws {
try await SkipUnless.toolchainContainsSwiftFormat()
// We pick up an invalid swift-format configuration file and thus don't set the user-provided options.
let project = try await MultiFileTestProject(files: [
".swift-format": """
{
"version": 1,
"indentation": {
"spaces": 1
}
}
""",
"test.swift": """
struct Root {
1️⃣var bar = 123
}
""",
])
let (uri, positions) = try project.openDocument("test.swift")
let response = try await project.testClient.send(
DocumentFormattingRequest(
textDocument: TextDocumentIdentifier(uri),
options: FormattingOptions(tabSize: 2, insertSpaces: true)
)
)
XCTAssertEqual(
response,
[
TextEdit(range: Range(positions["1️⃣"]), newText: " ")
]
)
}
func testConfigFileInParentDirectory() async throws {
try await SkipUnless.toolchainContainsSwiftFormat()
// We pick up an invalid swift-format configuration file and thus don't set the user-provided options.
let project = try await MultiFileTestProject(files: [
".swift-format": """
{
"version": 1,
"indentation": {
"spaces": 1
}
}
""",
"sub/test.swift": """
struct Root {
1️⃣var bar = 123
}
""",
])
let (uri, positions) = try project.openDocument("test.swift")
let response = try await project.testClient.send(
DocumentFormattingRequest(
textDocument: TextDocumentIdentifier(uri),
options: FormattingOptions(tabSize: 2, insertSpaces: true)
)
)
XCTAssertEqual(
response,
[
TextEdit(range: Range(positions["1️⃣"]), newText: " ")
]
)
}
func testConfigFileInNestedDirectory() async throws {
try await SkipUnless.toolchainContainsSwiftFormat()
// We pick up an invalid swift-format configuration file and thus don't set the user-provided options.
let project = try await MultiFileTestProject(files: [
".swift-format": """
{
"version": 1,
"indentation": {
"spaces": 1
}
},
""",
"sub/.swift-format": """
{
"version": 1,
"indentation": {
"spaces": 3
}
}
""",
"sub/test.swift": """
struct Root {
1️⃣var bar = 123
}
""",
])
let (uri, positions) = try project.openDocument("test.swift")
let response = try await project.testClient.send(
DocumentFormattingRequest(
textDocument: TextDocumentIdentifier(uri),
options: FormattingOptions(tabSize: 2, insertSpaces: true)
)
)
XCTAssertEqual(
response,
[
TextEdit(range: Range(positions["1️⃣"]), newText: " ")
]
)
}
func testInvalidConfigurationFile() async throws {
try await SkipUnless.toolchainContainsSwiftFormat()
// We pick up an invalid swift-format configuration file and thus don't set the user-provided options.
// The swift-format default is 2 spaces.
let project = try await MultiFileTestProject(files: [
".swift-format": "",
"test.swift": """
struct Root {
1️⃣var bar = 123
}
""",
])
let (uri, _) = try project.openDocument("test.swift")
await assertThrowsError(
try await project.testClient.send(
DocumentFormattingRequest(
textDocument: TextDocumentIdentifier(uri),
options: FormattingOptions(tabSize: 3, insertSpaces: true)
)
)
)
}
func testInsertAndRemove() async throws {
try await SkipUnless.toolchainContainsSwiftFormat()
let testClient = try await TestSourceKitLSPClient()
let uri = DocumentURI(for: .swift)
let positions = testClient.openDocument(
"""
1️⃣public 2️⃣extension Example {
3️⃣func function() {}
}
""",
uri: uri
)
let response = try await testClient.send(
DocumentFormattingRequest(
textDocument: TextDocumentIdentifier(uri),
options: FormattingOptions(tabSize: 2, insertSpaces: true)
)
)
let edits = try XCTUnwrap(response)
XCTAssertEqual(
edits,
[
TextEdit(range: positions["1️⃣"]..<positions["2️⃣"], newText: ""),
TextEdit(range: Range(positions["3️⃣"]), newText: "public "),
]
)
}
func testMultiLineStringInsertion() async throws {
try await SkipUnless.toolchainContainsSwiftFormat()
let testClient = try await TestSourceKitLSPClient()
let uri = DocumentURI(for: .swift)
let positions = testClient.openDocument(
#"""
_ = [
Node(
documentation: """
1️⃣A
2️⃣B
3️⃣C
4️⃣""",
children: [
Child(
documentation: """
5️⃣A
6️⃣ 7️⃣\#("")
8️⃣ 9️⃣ 🔟"""
)
]
)
]
"""#,
uri: uri
)
let response = try await testClient.send(
DocumentFormattingRequest(
textDocument: TextDocumentIdentifier(uri),
options: FormattingOptions(tabSize: 2, insertSpaces: true)
)
)
let edits = try XCTUnwrap(response)
XCTAssertEqual(
edits,
[
TextEdit(range: Range(positions["1️⃣"]), newText: " "),
TextEdit(range: Range(positions["2️⃣"]), newText: " "),
TextEdit(range: Range(positions["3️⃣"]), newText: " "),
TextEdit(range: Range(positions["4️⃣"]), newText: " "),
TextEdit(range: Range(positions["5️⃣"]), newText: " "),
TextEdit(range: Range(positions["6️⃣"]), newText: "\n"),
TextEdit(range: positions["7️⃣"]..<positions["8️⃣"], newText: ""),
TextEdit(range: positions["9️⃣"]..<positions["🔟"], newText: ""),
]
)
}
}
|
