File: DiagnosticConsoleWriterDefaultFormattingTest.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (595 lines) | stat: -rw-r--r-- 27,587 bytes parent folder | download
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2024 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 Swift project authors
*/

import XCTest
import Markdown
@testable import SwiftDocC
import SwiftDocCTestUtilities

class DiagnosticConsoleWriterDefaultFormattingTest: XCTestCase {

    class Logger: TextOutputStream {
        var output = ""

        func write(_ string: String) {
            output += string
        }
    }

    func testSeverityHighlight() {
        let source = URL(fileURLWithPath: "/path/to/file.md")
        let range = SourceLocation(line: 1, column: 8, source: source)..<SourceLocation(line: 10, column: 21, source: source)
        let identifier = "org.swift.docc.test-identifier"
        let summary = "Test diagnostic summary"
        let explanation = "Test diagnostic explanation."
        let expectedPath = "--> /path/to/file.md:1:8-10:21"

        do {
            let logger = Logger()
            let consumer = DiagnosticConsoleWriter(logger, highlight: true)
            let diagnostic = Diagnostic(source: source, severity: .error, range: range, identifier: identifier, summary: summary, explanation: explanation)
            let problem = Problem(diagnostic: diagnostic, possibleSolutions: [])
            consumer.receive([problem])
            try? consumer.flush()
            XCTAssertEqual(logger.output, """
            \u{001B}[1;31merror: \(summary)\u{001B}[0;0m
            \(explanation)
            \(expectedPath)
            """)
        }

        do {
            let logger = Logger()
            let consumer = DiagnosticConsoleWriter(logger, highlight: true)
            let diagnostic = Diagnostic(source: source, severity: .warning, range: range, identifier: identifier, summary: summary, explanation: explanation)
            let problem = Problem(diagnostic: diagnostic, possibleSolutions: [])
            consumer.receive([problem])
            try? consumer.flush()
            XCTAssertEqual(logger.output, """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
            \(expectedPath)
            """)
        }

        do {
            let logger = Logger()
            let consumer = DiagnosticConsoleWriter(logger, highlight: true)
            let diagnostic = Diagnostic(source: source, severity: .hint, range: range, identifier: identifier, summary: summary, explanation: explanation)
            let problem = Problem(diagnostic: diagnostic, possibleSolutions: [])
            consumer.receive([problem])
            try? consumer.flush()
            XCTAssertEqual(logger.output, """
            \u{001B}[1;39mnotice: \(summary)\u{001B}[0;0m
            \(explanation)
            \(expectedPath)
            """)
        }

        do {
            let logger = Logger()
            let consumer = DiagnosticConsoleWriter(logger, highlight: true)
            let diagnostic = Diagnostic(source: source, severity: .information, range: range, identifier: identifier, summary: summary, explanation: explanation)
            let problem = Problem(diagnostic: diagnostic, possibleSolutions: [])
            consumer.receive([problem])
            try? consumer.flush()
            XCTAssertEqual(logger.output, """
            \u{001B}[1;39mnote: \(summary)\u{001B}[0;0m
            \(explanation)
            \(expectedPath)
            """)
        }
    }

    func testDisplaysRelativePath() {
        let baseURL = URL(fileURLWithPath: "/path/to")
        let source = URL(fileURLWithPath: "/path/to/file.md")
        let range = SourceLocation(line: 1, column: 8, source: source)..<SourceLocation(line: 10, column: 21, source: source)
        let identifier = "org.swift.docc.test-identifier"
        let summary = "Test diagnostic summary"
        let explanation = "Test diagnostic explanation."

        let logger = Logger()
        let consumer = DiagnosticConsoleWriter(logger, baseURL: baseURL, highlight: true)
        let diagnostic = Diagnostic(source: source, severity: .warning, range: range, identifier: identifier, summary: summary, explanation: explanation)
        let problem = Problem(diagnostic: diagnostic, possibleSolutions: [])
        consumer.receive([problem])
        try? consumer.flush()
        XCTAssertEqual(logger.output, """
        \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
        \(explanation)
        --> file.md:1:8-10:21
        """)
    }

    func testDisplaysNotes() {
        let source = URL(fileURLWithPath: "/path/to/file.md")
        let range = SourceLocation(line: 1, column: 8, source: source)..<SourceLocation(line: 10, column: 21, source: source)
        let identifier = "org.swift.docc.test-identifier"
        let summary = "Test diagnostic summary"
        let explanation = "Test diagnostic explanation."

        let logger = Logger()
        let consumer = DiagnosticConsoleWriter(logger, highlight: true)

        let noteSource = URL(fileURLWithPath: "/path/to/other/file.md")
        let noteRange = SourceLocation(line: 1, column: 1, source: noteSource)..<SourceLocation(line: 1, column: 20, source: noteSource)

        let diagnostic = Diagnostic(
            source: source,
            severity: .warning,
            range: range,
            identifier: identifier,
            summary: summary,
            explanation: explanation,
            notes: [DiagnosticNote(source: noteSource, range: noteRange, message: "This is a note")]
        )
        let problem = Problem(diagnostic: diagnostic, possibleSolutions: [])
        consumer.receive([problem])
        try? consumer.flush()

        XCTAssertEqual(logger.output, """
        \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
        \(explanation)
        /path/to/other/file.md:1:1: This is a note
        --> /path/to/file.md:1:8-10:21
        """)
    }

    func testDisplaysMultipleDiagnosticsSorted() {
        let identifier = "org.swift.docc.test-identifier"
        let firstProblem = {
            let source = URL(fileURLWithPath: "/path/to/file.md")
            let range = SourceLocation(line: 1, column: 8, source: source)..<SourceLocation(line: 10, column: 21, source: source)

            return Problem(
                diagnostic: Diagnostic(
                    source: source,
                    severity: .warning,
                    range: range,
                    identifier: identifier,
                    summary: "First diagnostic summary",
                    explanation: "First diagnostic explanation",
                    notes: []
                ),
                possibleSolutions: []
            )
        }()
        let secondProblem = {
            let source = URL(fileURLWithPath: "/path/to/file.md")
            let range = SourceLocation(line: 12, column: 1, source: source)..<SourceLocation(line: 12, column: 10, source: source)

            return Problem(
                diagnostic: Diagnostic(
                    source: source,
                    severity: .warning,
                    range: range,
                    identifier: identifier,
                    summary: "Second diagnostic summary",
                    explanation: "Second diagnostic explanation",
                    notes: []
                ),
                possibleSolutions: []
            )
        }()

        let thirdProblem = {
            let source = URL(fileURLWithPath: "/path/to/other/file.md")

            return Problem(
                diagnostic: Diagnostic(
                    source: source,
                    severity: .warning,
                    range: nil,
                    identifier: identifier,
                    summary: "Third diagnostic summary",
                    explanation: "Third diagnostic explanation",
                    notes: []
                ),
                possibleSolutions: []
            )
        }()

        let logger = Logger()
        let consumer = DiagnosticConsoleWriter(logger, highlight: true)

        consumer.receive([firstProblem, secondProblem, thirdProblem])
        try? consumer.flush()
        XCTAssertEqual(logger.output, """
        \u{001B}[1;33mwarning: First diagnostic summary\u{001B}[0;0m
        First diagnostic explanation
        --> /path/to/file.md:1:8-10:21

        \u{001B}[1;33mwarning: Second diagnostic summary\u{001B}[0;0m
        Second diagnostic explanation
        --> /path/to/file.md:12:1-12:10

        \u{001B}[1;33mwarning: Third diagnostic summary\u{001B}[0;0m
        Third diagnostic explanation
        --> /path/to/other/file.md
        """)
    }

    func testDisplaysSource() {
        let identifier = "org.swift.docc.test-identifier"
        let summary = "Test diagnostic summary"
        let explanation = "Test diagnostic explanation."
        let baseURL =  Bundle.module.url(
            forResource: "TestBundle", withExtension: "docc", subdirectory: "Test Bundles")!
        let source = baseURL.appendingPathComponent("TestTutorial.tutorial")
        let range = SourceLocation(line: 44, column: 59, source: source)..<SourceLocation(line: 44, column: 138, source: source)

        let logger = Logger()
        let consumer = DiagnosticConsoleWriter(logger, baseURL: baseURL, highlight: true)

        let diagnostic = Diagnostic(source: source, severity: .warning, range: range, identifier: identifier, summary: summary, explanation: explanation)
        let problem = Problem(diagnostic: diagnostic, possibleSolutions: [])
        consumer.receive([problem])
        try? consumer.flush()
        
        XCTAssertEqual(logger.output, """
        \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
        \(explanation)
          --> TestTutorial.tutorial:44:59-44:138
        42 |          ut labore et dolore magna aliqua. Phasellus faucibus scelerisque eleifend donec pretium.
        43 |          Ultrices dui sapien eget mi proin sed libero enim. Quis auctor elit sed vulputate mi sit amet.
        44 +          This section link refers to this section itself: \u{001B}[1;32m<doc:/tutorials/Test-Bundle/TestTutorial#Create-a-New-AR-Project-%F0%9F%92%BB>.\u{001B}[0;0m
        45 |          This is an external link to Swift documentation: [Swift Documentation](https://swift.org/documentation/).
        46 |          This section link refers to the next section in this file: <doc:/tutorials/Test-Bundle/TestTutorial#Initiate-ARKit-Plane-Detection>.
        """)
    }

    func testDisplaysSourceAndProperlyHighlightsRangesSpanningEmoji() throws {
        let fs = try TestFileSystem(folders: [
            Folder(name: "Something.docc", content: [
                Folder(name: "Nested folder", content: [
                    TextFile(name: "Article.md", utf8Content: """
                    # Title
                    
                    A short abstract with emoji 💻 in it.
                    
                    @Metadata {
                      @TechnologyRoot
                    }
                    
                    """)
                ])
            ])
        ])
        
        let summary = "Test diagnostic summary"
        let explanation = "Test diagnostic explanation."
        
        let bundle = try XCTUnwrap(fs.bundles().first)
        let baseURL = bundle.baseURL
        let source = try XCTUnwrap(bundle.markupURLs.first)
        let range = SourceLocation(line: 3, column: 18, source: source)..<SourceLocation(line: 3, column: 36, source: source)

        let logStorage = LogHandle.LogStorage()
        let consumer = DiagnosticConsoleWriter(LogHandle.memory(logStorage), baseURL: baseURL, highlight: true, fileManager: fs)

        let diagnostic = Diagnostic(source: source, severity: .warning, range: range, identifier: "org.swift.docc.test-identifier", summary: summary, explanation: explanation)
        consumer.receive([Problem(diagnostic: diagnostic, possibleSolutions: [])])
        try consumer.flush()
        
        XCTAssertEqual(logStorage.text, """
        \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
        \(explanation)
         --> Something.docc/Nested folder/Article.md:3:18-3:36
        1 | # Title
        2 |
        3 + A short abstract \u{001B}[1;32mwith emoji 💻 in\u{001B}[0;0m it.
        4 |
        5 | @Metadata {
        """)
    }

    func testDisplaysPossibleSolutionsSummary() {
        let identifier = "org.swift.docc.test-identifier"
        let summary = "Test diagnostic summary"
        let explanation = "Test diagnostic explanation."
        let baseURL =  Bundle.module.url(
            forResource: "TestBundle", withExtension: "docc", subdirectory: "Test Bundles")!
        let source = baseURL.appendingPathComponent("TestTutorial.tutorial")
        let diagnosticRange = SourceLocation(line: 44, column: 59, source: source)..<SourceLocation(line: 44, column: 138, source: source)
        let diagnostic = Diagnostic(source: source, severity: .warning, range: diagnosticRange, identifier: identifier, summary: summary, explanation: explanation)

        do { // Displays solutions with single replacement at the replacement's source.
            let logger = Logger()
            let consumer = DiagnosticConsoleWriter(logger, baseURL: baseURL, highlight: true)

            let solutionRange = SourceLocation(line: 44, column: 59, source: source)..<SourceLocation(line: 44, column: 60, source: source)
            let solution = Solution(
                summary: "Solution summary",
                replacements: [.init(range: solutionRange, replacement: "replacement")]
            )

            let otherSolutionRange = SourceLocation(line: 44, column: 62, source: source)..<SourceLocation(line: 44, column: 64, source: source)
            let otherSolution = Solution(
                summary: "Other solution summary",
                replacements: [.init(range: otherSolutionRange, replacement: "replacement")]
            )

            let problem = Problem(diagnostic: diagnostic, possibleSolutions: [solution, otherSolution])
            consumer.receive([problem])
            try? consumer.flush()

            XCTAssertEqual(logger.output, """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
              --> TestTutorial.tutorial:44:59-44:138
            42 |          ut labore et dolore magna aliqua. Phasellus faucibus scelerisque eleifend donec pretium.
            43 |          Ultrices dui sapien eget mi proin sed libero enim. Quis auctor elit sed vulputate mi sit amet.
            44 +          This section link refers to this section itself: \u{001B}[1;32m<doc:/tutorials/Test-Bundle/TestTutorial#Create-a-New-AR-Project-%F0%9F%92%BB>.\u{001B}[0;0m
               |                                                           │  ╰─\u{001B}[1;39msuggestion: Other solution summary\u{001B}[0;0m
               |                                                           ╰─\u{001B}[1;39msuggestion: Solution summary\u{001B}[0;0m
            45 |          This is an external link to Swift documentation: [Swift Documentation](https://swift.org/documentation/).
            46 |          This section link refers to the next section in this file: <doc:/tutorials/Test-Bundle/TestTutorial#Initiate-ARKit-Plane-Detection>.
            """)
        }

        do { // Displays solution without replacement at the beginning of the diagnostic range.
            let logger = Logger()
            let consumer = DiagnosticConsoleWriter(logger, baseURL: baseURL, highlight: true)

            let solution = Solution(summary: "Solution summary", replacements: [])

            let problem = Problem(diagnostic: diagnostic, possibleSolutions: [solution])
            consumer.receive([problem])
            try? consumer.flush()

            XCTAssertEqual(logger.output, """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
              --> TestTutorial.tutorial:44:59-44:138
            42 |          ut labore et dolore magna aliqua. Phasellus faucibus scelerisque eleifend donec pretium.
            43 |          Ultrices dui sapien eget mi proin sed libero enim. Quis auctor elit sed vulputate mi sit amet.
            44 +          This section link refers to this section itself: \u{001B}[1;32m<doc:/tutorials/Test-Bundle/TestTutorial#Create-a-New-AR-Project-%F0%9F%92%BB>.\u{001B}[0;0m
               |                                                           ╰─\u{001B}[1;39msuggestion: Solution summary\u{001B}[0;0m
            45 |          This is an external link to Swift documentation: [Swift Documentation](https://swift.org/documentation/).
            46 |          This section link refers to the next section in this file: <doc:/tutorials/Test-Bundle/TestTutorial#Initiate-ARKit-Plane-Detection>.
            """)
        }

        do { // Displays solution with many replacements at the beginning of the diagnostic range.
            let logger = Logger()
            let consumer = DiagnosticConsoleWriter(logger, baseURL: baseURL, highlight: true)

            let firstReplacement = Replacement(
                range: SourceLocation(line: 44, column: 60, source: source)..<SourceLocation(line: 44, column: 64, source: source),
                replacement: "first replacement"
            )
            let secondReplacement = Replacement(
                range: SourceLocation(line: 44, column: 68, source: source)..<SourceLocation(line: 44, column: 70, source: source),
                replacement: "second replacement"
            )
            let solution = Solution(summary: "Solution summary", replacements: [firstReplacement, secondReplacement])

            let problem = Problem(diagnostic: diagnostic, possibleSolutions: [solution])
            consumer.receive([problem])
            try? consumer.flush()

            XCTAssertEqual(logger.output, """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
              --> TestTutorial.tutorial:44:59-44:138
            42 |          ut labore et dolore magna aliqua. Phasellus faucibus scelerisque eleifend donec pretium.
            43 |          Ultrices dui sapien eget mi proin sed libero enim. Quis auctor elit sed vulputate mi sit amet.
            44 +          This section link refers to this section itself: \u{001B}[1;32m<doc:/tutorials/Test-Bundle/TestTutorial#Create-a-New-AR-Project-%F0%9F%92%BB>.\u{001B}[0;0m
               |                                                           ╰─\u{001B}[1;39msuggestion: Solution summary\u{001B}[0;0m
            45 |          This is an external link to Swift documentation: [Swift Documentation](https://swift.org/documentation/).
            46 |          This section link refers to the next section in this file: <doc:/tutorials/Test-Bundle/TestTutorial#Initiate-ARKit-Plane-Detection>.
            """)
        }
    }
    
    func testClampsDiagnosticRangeToSourceRange() throws {
        let fs = try TestFileSystem(folders: [
            Folder(name: "Something.docc", content: [
                TextFile(name: "Article.md", utf8Content: """
                # Title
                
                A very short article with only an abstract.
                """)
            ])
        ])
        
        let summary = "Test diagnostic summary"
        let explanation = "Test diagnostic explanation."
        
        let bundle = try XCTUnwrap(fs.bundles().first)
        let baseURL = bundle.baseURL
        let source = try XCTUnwrap(bundle.markupURLs.first)
        
        typealias Location = (line: Int, column: Int)
        func logMessageFor(start: Location, end: Location) throws -> String {
            let range = SourceLocation(line: start.line, column: start.column, source: source)..<SourceLocation(line: end.line, column: end.column, source: source)
            
            let logStorage = LogHandle.LogStorage()
            let consumer = DiagnosticConsoleWriter(LogHandle.memory(logStorage), baseURL: baseURL, highlight: true, fileManager: fs)
            
            let diagnostic = Diagnostic(source: source, severity: .warning, range: range, identifier: "org.swift.docc.test-identifier", summary: summary, explanation: explanation)
            consumer.receive([Problem(diagnostic: diagnostic, possibleSolutions: [])])
            try consumer.flush()
            
            // There are no lines before line 1
            return logStorage.text
        }
        
        // Highlight the "Title" word on line 1
        XCTAssertEqual(try logMessageFor(start: (line: 1, column: 3), end: (line: 1, column: 8)), """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
             --> Something.docc/Article.md:1:3-1:8
            1 + # \u{001B}[1;32mTitle\u{001B}[0;0m
            2 |
            3 | A very short article with only an abstract.
            """)
                       
        // Highlight the "short" word on line 3
        XCTAssertEqual(try logMessageFor(start: (line: 3, column: 8), end: (line: 3, column: 13)), """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
             --> Something.docc/Article.md:3:8-3:13
            1 | # Title
            2 |
            3 + A very \u{001B}[1;32mshort\u{001B}[0;0m article with only an abstract.
            """)
        
        // Extend the highlight beyond the end of that line
        XCTAssertEqual(try logMessageFor(start: (line: 3, column: 8), end: (line: 3, column: 100)), """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
             --> Something.docc/Article.md:3:8-3:100
            1 | # Title
            2 |
            3 + A very \u{001B}[1;32mshort article with only an abstract.\u{001B}[0;0m
            """)
        
        // Extend the highlight beyond the start of that line
        XCTAssertEqual(try logMessageFor(start: (line: 3, column: -4), end: (line: 3, column: 13)), """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
             --> Something.docc/Article.md:3:1-3:13
            1 | # Title
            2 |
            3 + \u{001B}[1;32mA very short\u{001B}[0;0m article with only an abstract.
            """)
        
        // Highlight a line before the start of the file
        XCTAssertEqual(try logMessageFor(start: (line: -4, column: 1), end: (line: -4, column: 5)), """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
            --> Something.docc/Article.md:1:1-1:5
            """)
        
        // Highlight a line after the end of the file
        XCTAssertEqual(try logMessageFor(start: (line: 100, column: 1), end: (line: 100, column: 5)), """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
            --> Something.docc/Article.md:100:1-100:5
            """)
        
        // Extended the highlighted lines before the start of the file
        XCTAssertEqual(try logMessageFor(start: (line: -4, column: 1), end: (line: 1, column: 5)), """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
            --> Something.docc/Article.md:1:1-1:5
            """)
        
        // Extended the highlighted lines after the end of the file
        XCTAssertEqual(try logMessageFor(start: (line: 1, column: 1), end: (line: 100, column: 5)), """
            \u{001B}[1;33mwarning: \(summary)\u{001B}[0;0m
            \(explanation)
            --> Something.docc/Article.md:1:1-100:5
            """)
    }
    
    func testEmitAdditionReplacementSolution() throws {
        func problemsLoggerOutput(possibleSolutions: [Solution]) -> String {
            let logger = Logger()
            let consumer = DiagnosticConsoleWriter(logger, highlight: true)
            let problem = Problem(diagnostic: Diagnostic(source: URL(fileURLWithPath: "/path/to/file.md"), severity: .warning, range: nil, identifier: "org.swift.docc.tests", summary: "Test diagnostic"), possibleSolutions: possibleSolutions)
            consumer.receive([problem])
            try? consumer.flush()
            return logger.output
        }
        let sourceLocation = SourceLocation(line: 1, column: 1, source: nil)
        let range = sourceLocation..<sourceLocation
        XCTAssertEqual(
            problemsLoggerOutput(possibleSolutions: [
                Solution(summary: "Create a sloth.", replacements: [
                    Replacement(
                        range: range,
                        replacement: """
                        var slothName = "slothy"
                        var slothDiet = .vegetarian
                        """
                    )
                ])
            ]),
            """
            \u{1B}[1;33mwarning: Test diagnostic\u{1B}[0;0m
            --> /path/to/file.md
            Create a sloth.
            suggestion:
            0 + var slothName = \"slothy\"
            1 + var slothDiet = .vegetarian
            """
        )
        
        XCTAssertEqual(
            problemsLoggerOutput(possibleSolutions: [
                Solution(summary: "Create a sloth.", replacements: [
                    Replacement(
                        range: range,
                        replacement: """
                        var slothName = "slothy"
                        var slothDiet = .vegetarian
                        """
                    ),
                    Replacement(
                        range: range,
                        replacement: """
                        var slothName = SlothGenerator().generateName()
                        var slothDiet = SlothGenerator().generateDiet()
                        """
                    )
                ])
            ]),
            """
            \u{1B}[1;33mwarning: Test diagnostic\u{1B}[0;0m
            --> /path/to/file.md
            Create a sloth.
            suggestion:
            0 + var slothName = "slothy"
            1 + var slothDiet = .vegetarian
            suggestion:
            0 + var slothName = SlothGenerator().generateName()
            1 + var slothDiet = SlothGenerator().generateDiet()
            """
        )
        
        XCTAssertEqual(
            problemsLoggerOutput(possibleSolutions: [
                Solution(summary: "Create a sloth.", replacements: [
                    Replacement(
                        range: range,
                        replacement: """
                        var slothName = "slothy"
                        var slothDiet = .vegetarian
                        """
                    ),
                ]),
                Solution(summary: "Create a bee.", replacements: [
                    Replacement(
                        range: range,
                        replacement: """
                        var beeName = "Bee"
                        var beeDiet = .vegetarian
                        """
                    )
                ])
            ]),
            """
            \u{1B}[1;33mwarning: Test diagnostic\u{1B}[0;0m
            --> /path/to/file.md
            Create a sloth.
            suggestion:
            0 + var slothName = "slothy"
            1 + var slothDiet = .vegetarian
            Create a bee.
            suggestion:
            0 + var beeName = "Bee"
            1 + var beeDiet = .vegetarian
            """
        )
    }
}