Update calls to deprecated diagnostic properties

Author: d-ronnqvist

Sources/SwiftDocCUtilities/Action/Actions/Convert/ConvertFileWritingConsumer.swift

@@ -253,8 +253,8 @@ private extension Digest.Diagnostic {
         self.start = (diagnostic.range?.lowerBound).map { Location(line: $0.line, column: $0.column) }
         self.source = rootURL.flatMap { diagnostic.source?.relative(to: $0) }
         self.severity = diagnostic.severity
-        self.summary = diagnostic.localizedSummary
-        self.explanation = diagnostic.localizedExplanation
+        self.summary = diagnostic.summary
+        self.explanation = diagnostic.explanation
         self.notes = diagnostic.notes.map {
             Note(location: Location(line: $0.range.lowerBound.line, column: $0.range.lowerBound.column), message: $0.message)
         }

Tests/SwiftDocCTests/Diagnostics/DiagnosticTests.swift

@@ -22,13 +22,13 @@ class DiagnosticTests: XCTestCase {
     func testLocalizedSummary() {
         let expectedDump = "This is a test diagnostic"
 
-        XCTAssertEqual(expectedDump, basicDiagnostic.localizedSummary)
+        XCTAssertEqual(expectedDump, basicDiagnostic.summary)
     }
 
     func testLocalizedExplanation() {
-        XCTAssertNil(nonexistentDiagnostic.localizedExplanation)
-        guard let explanation = basicDiagnostic.localizedExplanation else {
-            XCTFail("basicDiagnostic.localizedExplanation was nil.")
+        XCTAssertNil(nonexistentDiagnostic.explanation)
+        guard let explanation = basicDiagnostic.explanation else {
+            XCTFail("basicDiagnostic.explanation was nil.")
             return
         }
         let expectedDump = """

Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift

@@ -649,7 +649,7 @@ class DocumentationContextTests: XCTestCase {
 
         XCTAssertEqual(problemWithDuplicate.count, 1)
 
-        let localizedSummary = try XCTUnwrap(problemWithDuplicate.first?.diagnostic.localizedSummary)
+        let localizedSummary = try XCTUnwrap(problemWithDuplicate.first?.diagnostic.summary)
         XCTAssertEqual(localizedSummary, "Redeclaration of 'TestTutorial.tutorial'; this file will be skipped")
 
     }
@@ -661,10 +661,10 @@ class DocumentationContextTests: XCTestCase {
 
         XCTAssertEqual(problemWithDuplicateReference.count, 2)
 
-        let localizedSummary = try XCTUnwrap(problemWithDuplicateReference.first?.diagnostic.localizedSummary)
+        let localizedSummary = try XCTUnwrap(problemWithDuplicateReference.first?.diagnostic.summary)
         XCTAssertEqual(localizedSummary, "Redeclaration of \'overview.md\'; this file will be skipped")
 
-        let localizedSummarySecond = try XCTUnwrap(problemWithDuplicateReference[1].diagnostic.localizedSummary)
+        let localizedSummarySecond = try XCTUnwrap(problemWithDuplicateReference[1].diagnostic.summary)
         XCTAssertEqual(localizedSummarySecond, "Redeclaration of \'overview.md\'; this file will be skipped")
     }
 
@@ -1172,12 +1172,12 @@ class DocumentationContextTests: XCTestCase {
         XCTAssertNotNil(context.problems
             .map { $0.diagnostic }
             .filter { $0.identifier == "org.swift.docc.DuplicateMarkdownTitleSymbolReferences"
-                && $0.localizedSummary.contains("'/mykit'") }
+                && $0.summary.contains("'/mykit'") }
         )
         XCTAssertNotNil(context.problems
             .map { $0.diagnostic }
             .filter { $0.identifier == "org.swift.docc.DuplicateMarkdownTitleSymbolReferences"
-                && $0.localizedSummary.contains("'/myprotocol'") }
+                && $0.summary.contains("'/myprotocol'") }
         )
     }
 
@@ -1760,7 +1760,7 @@ let expected = """
         if let unmatchedSidecarDiagnostic = unmatchedSidecarProblem?.diagnostic {
             XCTAssertTrue(sidecarFilesForUnknownSymbol.contains(unmatchedSidecarDiagnostic.source?.standardizedFileURL), "One of the files should be the diagnostic source")
             XCTAssertEqual(unmatchedSidecarDiagnostic.range, SourceLocation(line: 1, column: 3, source: unmatchedSidecarProblem?.diagnostic.source)..<SourceLocation(line: 1, column: 26, source: unmatchedSidecarProblem?.diagnostic.source))
-            XCTAssertEqual(unmatchedSidecarDiagnostic.localizedSummary, "No symbol matched 'MyKit/UnknownSymbol'. This documentation will be ignored.")
+            XCTAssertEqual(unmatchedSidecarDiagnostic.summary, "No symbol matched 'MyKit/UnknownSymbol'. This documentation will be ignored.")
             XCTAssertEqual(unmatchedSidecarDiagnostic.severity, .information)
 
             XCTAssertEqual(unmatchedSidecarDiagnostic.notes.count, 1)
@@ -1791,7 +1791,7 @@ let expected = """
         let curationDiagnostics =  context.problems.filter({ $0.diagnostic.identifier == "org.swift.docc.ArticleUncurated" }).map(\.diagnostic)
         let sidecarDiagnostic = try XCTUnwrap(curationDiagnostics.first(where: { $0.source?.standardizedFileURL == unknownSymbolSidecarURL.standardizedFileURL }))
         XCTAssertNil(sidecarDiagnostic.range)
-        XCTAssertEqual(sidecarDiagnostic.localizedSummary, "You haven't curated 'doc://org.swift.docc.example/documentation/Test-Bundle/UncuratedArticle'")
+        XCTAssertEqual(sidecarDiagnostic.summary, "You haven't curated 'doc://org.swift.docc.example/documentation/Test-Bundle/UncuratedArticle'")
         XCTAssertEqual(sidecarDiagnostic.severity, .information)
     }
 
@@ -2573,7 +2573,7 @@ let expected = """
         let identifier = "org.swift.docc.DuplicateMarkdownTitleSymbolReferences"
         let duplicateMarkdownProblems = context.problems.filter({ $0.diagnostic.identifier == identifier })
         XCTAssertEqual(duplicateMarkdownProblems.count, 2)
-        XCTAssertEqual(duplicateMarkdownProblems.first?.diagnostic.localizedSummary, "Multiple occurrences of \'/documentation/MyKit/MyClass/myFunction()\' found")
+        XCTAssertEqual(duplicateMarkdownProblems.first?.diagnostic.summary, "Multiple occurrences of \'/documentation/MyKit/MyClass/myFunction()\' found")
     }
 
     /// This test verifies that collision nodes and children of collision nodes are correctly

Tests/SwiftDocCTests/Infrastructure/DocumentationCuratorTests.swift

@@ -128,7 +128,7 @@ class DocumentationCuratorTests: XCTestCase {
             SourceLocation(line: 12, column: 4, source: moduleCurationProblem?.diagnostic.source)..<SourceLocation(line: 12, column: 13, source: moduleCurationProblem?.diagnostic.source)
         )
         XCTAssertEqual(
-            moduleCurationProblem?.diagnostic.localizedSummary,
+            moduleCurationProblem?.diagnostic.summary,
             "Linking to \'doc://org.swift.docc.example/documentation/MyKit\' from a Topics group in \'doc://org.swift.docc.example/documentation/MyKit/MyClass/myFunction()\' isn't allowed"
         )
 
@@ -140,7 +140,7 @@ class DocumentationCuratorTests: XCTestCase {
             SourceLocation(line: 13, column: 4, source: moduleCurationProblem?.diagnostic.source)..<SourceLocation(line: 13, column: 20, source: moduleCurationProblem?.diagnostic.source)
         )
         XCTAssertEqual(
-            cyclicReferenceProblem?.diagnostic.localizedSummary,
+            cyclicReferenceProblem?.diagnostic.summary,
             "A symbol can't link to itself from within its Topics group in \'doc://org.swift.docc.example/documentation/MyKit/MyClass/myFunction()\'"
         )
     }

Tests/SwiftDocCTests/Infrastructure/ExternalReferenceResolverTests.swift

@@ -775,7 +775,7 @@ Document @1:1-1:35
             TopicReferenceResolutionResult.success(ResolvedTopicReference(bundleIdentifier: "com.external.testbundle", path: "/resolved", fragment: nil, sourceLanguage: .swift))
         )
 
-        XCTAssert(context.problems.contains(where: { $0.diagnostic.localizedSummary.contains("Unit test: External resolve error.")}),
+        XCTAssert(context.problems.contains(where: { $0.diagnostic.summary.contains("Unit test: External resolve error.")}),
                   "The external reference resolver error message is included in that problem's error summary.")
 
         // Get MyKit symbol

Tests/SwiftDocCTests/Infrastructure/ReferenceResolverTests.swift

@@ -338,7 +338,7 @@ class ReferenceResolverTests: XCTestCase {
 
         let diagnostics = context.problems.filter({ $0.diagnostic.source?.standardizedFileURL == uncuratedArticleFile.standardizedFileURL }).map(\.diagnostic)
         let diagnostic = try XCTUnwrap(diagnostics.first(where: { $0.identifier == "org.swift.docc.ArticleUncurated" }))
-        XCTAssertEqual(diagnostic.localizedSummary, "You haven't curated 'doc://org.swift.docc.example/documentation/Test-Bundle/UncuratedArticle'")
+        XCTAssertEqual(diagnostic.summary, "You haven't curated 'doc://org.swift.docc.example/documentation/Test-Bundle/UncuratedArticle'")
 
         let referencingFileDiagnostics = context.problems.map(\.diagnostic).filter({ $0.source?.standardizedFileURL == referencingArticleURL.standardizedFileURL })
         XCTAssertEqual(referencingFileDiagnostics.filter({ $0.identifier == "org.swift.docc.unresolvedTopicReference" }).count, 1)

Tests/SwiftDocCTests/Model/SemaToRenderNodeTests.swift

@@ -1951,7 +1951,7 @@ Document
         XCTAssertNotNil(context.problems.first(where: { problem -> Bool in
 
             return problem.diagnostic.identifier == "org.swift.docc.InvalidDocumentationLink"
-                && problem.diagnostic.localizedSummary.contains("https://external.com/link")
+                && problem.diagnostic.summary.contains("https://external.com/link")
         }))
     }
 
@@ -2696,7 +2696,7 @@ Document
             return p.diagnostic.identifier == "org.swift.docc.unresolvedResource"
         }
         XCTAssertFalse(missingResources.contains(where: { p -> Bool in
-            return p.diagnostic.localizedSummary == "Resource 'my-inherited-image.png' couldn't be found"
+            return p.diagnostic.summary == "Resource 'my-inherited-image.png' couldn't be found"
         }))
 
         let myFuncReference = ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/SideKit/SideClass/Element/inherited()", sourceLanguage: .swift)
@@ -2899,7 +2899,7 @@ Document
 
         // Verify that we don't reference resolve inherited docs.
         XCTAssertFalse(context.diagnosticEngine.problems.contains(where: { problem in
-            problem.diagnostic.localizedSummary.contains("my-inherited-image.png")
+            problem.diagnostic.summary.contains("my-inherited-image.png")
         }))
 
         let myFuncReference = ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/SideKit/SideClass/Element/inherited()", sourceLanguage: .swift)

Tests/SwiftDocCTests/Semantics/General Purpose Analyses/HasOnlySequentialHeadingsTests.swift

@@ -70,7 +70,7 @@ some more *stuff*
         var problems: [Problem] = []
         Semantic.Analyses.HasOnlySequentialHeadings<TutorialArticle>(severityIfFound: .warning, startingFromLevel: 2).analyze(containerDirective, children: document.children, source: nil, for: bundle, in: context, problems: &problems)
 
-        XCTAssertEqual(problems.map { $0.diagnostic.localizedSummary },
+        XCTAssertEqual(problems.map { $0.diagnostic.summary },
                        [
                         "This heading doesn't meet or exceed the minimum allowed heading level (2)",
                         "This heading doesn't meet or exceed the minimum allowed heading level (2)",
@@ -91,7 +91,7 @@ some more *stuff*
         var problems: [Problem] = []
         Semantic.Analyses.HasOnlySequentialHeadings<TutorialArticle>(severityIfFound: .warning, startingFromLevel: 2).analyze(containerDirective, children: document.children, source: nil, for: bundle, in: context, problems: &problems)
 
-        XCTAssertEqual(problems.map { $0.diagnostic.localizedSummary },
+        XCTAssertEqual(problems.map { $0.diagnostic.summary },
                        [
                         "This heading doesn't sequentially follow the previous heading",
                         "This heading doesn't sequentially follow the previous heading",

Tests/SwiftDocCTests/Semantics/MetadataTests.swift

@@ -126,7 +126,7 @@ class MetadataTests: XCTestCase {
         var problems = [Problem]()
         let metadata = Metadata(from: directive, source: nil, for: bundle, in: context, problems: &problems)
         XCTAssertNotNil(metadata)
-        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.localizedSummary })")
+        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.summary })")
 
         XCTAssertEqual(metadata?.displayName?.name, "Custom Name")
     }
@@ -165,7 +165,7 @@ class MetadataTests: XCTestCase {
         var problems = [Problem]()
         let article = Article(from: document, source: nil, for: bundle, in: context, problems: &problems)
         XCTAssertNotNil(article, "An Article value can be created with a Metadata child.")
-        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.localizedSummary })")
+        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.summary })")
 
         var analyzer = SemanticAnalyzer(source: nil, context: context, bundle: bundle)
         _ = analyzer.visit(document)
@@ -189,7 +189,7 @@ class MetadataTests: XCTestCase {
         XCTAssertNotNil(article, "An Article value can be created with a Metadata child with a DisplayName child.")
         XCTAssertNotNil(article?.metadata?.displayName, "The Article has the parsed DisplayName metadata.")
 
-        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.localizedSummary })")
+        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.summary })")
 
         var analyzer = SemanticAnalyzer(source: nil, context: context, bundle: bundle)
         _ = analyzer.visit(document)
@@ -218,7 +218,7 @@ class MetadataTests: XCTestCase {
         let problem = try XCTUnwrap(problems.first)
 
         XCTAssertEqual(problem.diagnostic.identifier, "org.swift.docc.Article.DisplayName.NotSupported")
-        XCTAssertEqual(problem.diagnostic.localizedSummary, "A 'DisplayName' directive is only supported in documentation extension files. To customize the display name of an article, change the content of the level-1 heading.")
+        XCTAssertEqual(problem.diagnostic.summary, "A 'DisplayName' directive is only supported in documentation extension files. To customize the display name of an article, change the content of the level-1 heading.")
 
         XCTAssertEqual(problem.possibleSolutions.count, 1)
         let solution = try XCTUnwrap(problem.possibleSolutions.first)

Tests/SwiftDocCTests/Semantics/RedirectedTests.swift

@@ -58,7 +58,7 @@ class RedirectedTests: XCTestCase {
               XCTAssertEqual(1, problems.count)
               XCTAssertEqual(problems.first?.diagnostic.identifier, "org.swift.docc.HasArgument.from.ConversionFailed")
               XCTAssertEqual(
-                  problems.first?.diagnostic.localizedSummary,
+                  problems.first?.diagnostic.summary,
                   "Cannot convert '\(pathWithInvalidCharacter)' to type 'URL'"
               )
           }
@@ -134,7 +134,7 @@ class RedirectedTests: XCTestCase {
         var problems = [Problem]()
         let technology = Technology(from: directive, source: nil, for: bundle, in: context, problems: &problems)
         XCTAssertNotNil(technology, "A Technology value can be created with a Redirected child.")
-        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.localizedSummary })")
+        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.summary })")
 
         var analyzer = SemanticAnalyzer(source: nil, context: context, bundle: bundle)
         _ = analyzer.visit(document)
@@ -166,7 +166,7 @@ class RedirectedTests: XCTestCase {
         var problems = [Problem]()
         let volume = Volume(from: directive, source: nil, for: bundle, in: context, problems: &problems)
         XCTAssertNotNil(volume, "A Volume value can be created with a Redirected child.")
-        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.localizedSummary })")
+        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.summary })")
     }
 
     func testTutorialAndSectionsSupportsRedirect() throws {
@@ -231,7 +231,7 @@ class RedirectedTests: XCTestCase {
         var problems = [Problem]()
         let tutorial = Tutorial(from: directive, source: nil, for: bundle, in: context, problems: &problems)
         XCTAssertNotNil(tutorial, "A Tutorial value can be created with a Redirected child.")
-        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.localizedSummary })")
+        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.summary })")
 
         var analyzer = SemanticAnalyzer(source: nil, context: context, bundle: bundle)
         _ = analyzer.visit(document)
@@ -259,7 +259,7 @@ class RedirectedTests: XCTestCase {
         var problems = [Problem]()
         let article = TutorialArticle(from: directive, source: nil, for: bundle, in: context, problems: &problems)
         XCTAssertNotNil(article, "A TutorialArticle value can be created with a Redirected child.")
-        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.localizedSummary })")
+        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.summary })")
 
         var analyzer = SemanticAnalyzer(source: nil, context: context, bundle: bundle)
         _ = analyzer.visit(document)
@@ -308,7 +308,7 @@ class RedirectedTests: XCTestCase {
         var problems = [Problem]()
         let article = Resources(from: directive, source: nil, for: bundle, in: context, problems: &problems)
         XCTAssertNotNil(article, "A Resources value can be created with a Redirected child.")
-        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.localizedSummary })")
+        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.summary })")
     }
 
     func testArticleSupportsRedirect() throws {
@@ -329,7 +329,7 @@ class RedirectedTests: XCTestCase {
         var problems = [Problem]()
         let article = Article(from: document, source: nil, for: bundle, in: context, problems: &problems)
         XCTAssertNotNil(article, "An Article value can be created with a Redirected child.")
-        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.localizedSummary })")
+        XCTAssert(problems.isEmpty, "There shouldn't be any problems. Got:\n\(problems.map { $0.diagnostic.summary })")
 
         var analyzer = SemanticAnalyzer(source: nil, context: context, bundle: bundle)
         _ = analyzer.visit(document)