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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2018 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 LSPTestSupport
import LanguageServerProtocol
import SKTestSupport
import XCTest
final class HoverTests: XCTestCase {
func testBasic() async throws {
try await SkipUnless.sourcekitdReturnsRawDocumentationResponse()
try await assertHover(
"""
/// This is a doc comment for S.
///
/// Details.
struct 1️⃣S {}
""",
expectedContent: """
```swift
struct S
```
This is a doc comment for S.
Details.
"""
)
}
func testHoverTriggeredFromComment() async throws {
let testClient = try await TestSourceKitLSPClient()
let url = URL(fileURLWithPath: "/\(UUID())/a.swift")
let uri = DocumentURI(url)
let positions = testClient.openDocument(
"""
/// Thi1️⃣s is a doc comment for S.
///
/// Details.
struct S {}
""",
uri: uri
)
let response = try await testClient.send(
HoverRequest(textDocument: TextDocumentIdentifier(url), position: positions["1️⃣"])
)
XCTAssertNil(response)
}
func testMultiCursorInfoResultsHover() async throws {
try await assertHover(
"""
struct Foo {
init() {}
}
_ = 1️⃣Foo()
""",
expectedContent: """
## Multiple results
```swift
struct Foo
```
---
```swift
init()
```
"""
)
}
func testMultiCursorInfoResultsHoverWithDocumentation() async throws {
try await SkipUnless.sourcekitdReturnsRawDocumentationResponse()
try await assertHover(
"""
/// A struct
struct Foo {
/// The initializer
init() {}
}
_ = 1️⃣Foo()
""",
expectedContent: """
## Multiple results
```swift
struct Foo
```
A struct
---
```swift
init()
```
The initializer
"""
)
}
func testHoverNameEscapingOnFunction() async throws {
try await SkipUnless.sourcekitdReturnsRawDocumentationResponse()
try await assertHover(
"""
/// this is **bold** documentation
func 1️⃣test(_ a: Int, _ b: Int) { }
""",
expectedContent: ##"""
```swift
func test(_ a: Int, _ b: Int)
```
this is **bold** documentation
"""##
)
}
func testHoverNameEscapingOnOperator() async throws {
try await SkipUnless.sourcekitdReturnsRawDocumentationResponse()
try await assertHover(
"""
/// this is *italic* documentation
func 1️⃣*%*(lhs: String, rhs: String) { }
""",
expectedContent: ##"""
```swift
func *%* (lhs: String, rhs: String)
```
this is *italic* documentation
"""##
)
}
func testPrecondition() async throws {
try await SkipUnless.sourcekitdReturnsRawDocumentationResponse()
try await assertHover(
"""
/// Eat an apple
///
/// - Precondition: Must have an apple
func 1️⃣eatApple() {}
""",
expectedContent: """
```swift
func eatApple()
```
Eat an apple
- Precondition: Must have an apple
"""
)
}
}
private func assertHover(
_ markedSource: String,
expectedContent: String,
file: StaticString = #file,
line: UInt = #line
) async throws {
let testClient = try await TestSourceKitLSPClient()
let uri = DocumentURI(for: .swift)
let positions = testClient.openDocument(markedSource, uri: uri)
let response = try await testClient.send(
HoverRequest(textDocument: TextDocumentIdentifier(uri), position: positions["1️⃣"])
)
let hover = try XCTUnwrap(response, file: file, line: line)
XCTAssertNil(hover.range, file: file, line: line)
guard case .markupContent(let content) = hover.contents else {
XCTFail("hover.contents is not .markupContents", file: file, line: line)
return
}
XCTAssertEqual(content.kind, .markdown, file: file, line: line)
XCTAssertEqual(content.value, expectedContent, file: file, line: line)
}
|
