Delay removing the deprecated 'diagnostics.json file by 1 minor release

d-ronnqvist · d-ronnqvist · commit e1d8bb615501 · 2025-07-31T11:11:46.000+02:00
diff --git a/Sources/SwiftDocC/Infrastructure/ConvertOutputConsumer.swift b/Sources/SwiftDocC/Infrastructure/ConvertOutputConsumer.swift
@@ -16,8 +16,8 @@ import Foundation
 /// or store them in memory.
 public protocol ConvertOutputConsumer {
     /// Consumes an array of problems that were generated during a conversion.
-    @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")
-    func consume(problems: [Problem]) throws
+    @available(*, deprecated, message: "This deprecated API will be removed after 6.3 is released")
+    func _deprecated_consume(problems: [Problem]) throws
     
     /// Consumes a render node that was generated during a conversion.
     /// > Warning: This method might be called concurrently.
@@ -62,7 +62,7 @@ public extension ConvertOutputConsumer {
 
 // Default implementation so that conforming types don't need to implement deprecated API.
 public extension ConvertOutputConsumer {
-    func consume(problems: [Problem]) throws {}
+    func _deprecated_consume(problems: [Problem]) throws {}
 }
 
 // A package-internal protocol that callers can cast to when they need to call `_consume(problems:)` for backwards compatibility (until `consume(problems:)` is removed).
@@ -84,7 +84,7 @@ package struct _Deprecated<Consumer: ConvertOutputConsumer>: _DeprecatedConsumeP
     }
     
     // This needs to be deprecated to be able to call `consume(problems:)` without a deprecation warning.
-    @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")
+    @available(*, deprecated, message: "This deprecated API will be removed after 6.3 is released")
     package func _consume(problems: [Problem]) throws {
         var problems = problems
         
@@ -94,15 +94,15 @@ package struct _Deprecated<Consumer: ConvertOutputConsumer>: _DeprecatedConsumeP
                     severity: .warning,
                     identifier: "org.swift.docc.DeprecatedDiagnosticsDigets",
                     summary: """
-                    The 'diagnostics.json' digest file is deprecated and will be removed after 6.2 is released. \
+                    The 'diagnostics.json' digest file is deprecated and will be removed after 6.3 is released. \
                     Pass a `--diagnostics-file <diagnostics-file>` to specify a custom location where DocC will write a diagnostics JSON file with more information.
                     """)
                 ),
                 at: 0
             )
         }
         
-        try consumer.consume(problems: problems)
+        try consumer._deprecated_consume(problems: problems)
     }
 }
 
diff --git a/Sources/SwiftDocC/SwiftDocC.docc/Resources/Diagnostics.json b/Sources/SwiftDocC/SwiftDocC.docc/Resources/Diagnostics.json
@@ -1,7 +1,7 @@
 {
     "openapi": "3.0.0",
     "info": {
-        "description": "Specification of the deprecated DocC diagnostics.json digest file. This deprecated file will be removed after 6.2 is released.",
+        "description": "Specification of the deprecated DocC diagnostics.json digest file. This deprecated file will be removed after 6.3 is released.",
         "version": "0.1.0",
         "title": "Diagnostics"
     },
diff --git a/Sources/SwiftDocCUtilities/Action/Actions/Convert/ConvertFileWritingConsumer.swift b/Sources/SwiftDocCUtilities/Action/Actions/Convert/ConvertFileWritingConsumer.swift
@@ -50,8 +50,8 @@ struct ConvertFileWritingConsumer: ConvertOutputConsumer, ExternalNodeConsumer {
         self.assetPrefixComponent = bundleID?.rawValue.split(separator: "/").joined(separator: "-")
     }
     
-    @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")
-    func consume(problems: [Problem]) throws {
+    @available(*, deprecated, message: "This deprecated API will be removed after 6.3 is released")
+    func _deprecated_consume(problems: [Problem]) throws {
         let diagnostics = problems.map { problem in
             Digest.Diagnostic(diagnostic: problem.diagnostic, rootURL: bundleRootFolder)
         }
@@ -251,7 +251,7 @@ enum Digest {
         let downloads: [DownloadReference]
     }
     
-    @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")
+    @available(*, deprecated, message: "This deprecated API will be removed after 6.3 is released")
     struct Diagnostic: Codable {
         struct Location: Codable {
             let line: Int
@@ -270,7 +270,7 @@ enum Digest {
     }
 }
 
-@available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")
+@available(*, deprecated, message: "This deprecated API will be removed after 6.3 is released")
 private extension Digest.Diagnostic {
     init(diagnostic: Diagnostic, rootURL: URL?) {
         self.start = (diagnostic.range?.lowerBound).map { Location(line: $0.line, column: $0.column) }
diff --git a/Tests/SwiftDocCTests/DeprecatedDiagnosticsDigestWarningTests.swift b/Tests/SwiftDocCTests/DeprecatedDiagnosticsDigestWarningTests.swift
@@ -66,14 +66,14 @@ class DeprecatedDiagnosticsDigestWarningTests: XCTestCase {
         let deprecationWarning = try XCTUnwrap(outputConsumer.problems.first?.diagnostic)
         
         XCTAssertEqual(deprecationWarning.identifier, "org.swift.docc.DeprecatedDiagnosticsDigets")
-        XCTAssertEqual(deprecationWarning.summary, "The 'diagnostics.json' digest file is deprecated and will be removed after 6.2 is released. Pass a `--diagnostics-file <diagnostics-file>` to specify a custom location where DocC will write a diagnostics JSON file with more information.")
+        XCTAssertEqual(deprecationWarning.summary, "The 'diagnostics.json' digest file is deprecated and will be removed after 6.3 is released. Pass a `--diagnostics-file <diagnostics-file>` to specify a custom location where DocC will write a diagnostics JSON file with more information.")
     }
 }
 
 private class TestOutputConsumer: ConvertOutputConsumer, ExternalNodeConsumer {
     var problems: [Problem] = []
     
-    func consume(problems: [Problem]) throws {
+    func _deprecated_consume(problems: [Problem]) throws {
         self.problems.append(contentsOf: problems)
     }
     
diff --git a/Tests/SwiftDocCUtilitiesTests/ConvertActionTests.swift b/Tests/SwiftDocCUtilitiesTests/ConvertActionTests.swift
@@ -609,7 +609,7 @@ class ConvertActionTests: XCTestCase {
                     start: nil,
                     source: nil,
                     severity: .warning,
-                    summary: "The 'diagnostics.json' digest file is deprecated and will be removed after 6.2 is released. Pass a `--diagnostics-file <diagnostics-file>` to specify a custom location where DocC will write a diagnostics JSON file with more information.",
+                    summary: "The 'diagnostics.json' digest file is deprecated and will be removed after 6.3 is released. Pass a `--diagnostics-file <diagnostics-file>` to specify a custom location where DocC will write a diagnostics JSON file with more information.",
                     explanation: nil,
                     notes: []
                 ),
@@ -672,7 +672,7 @@ class ConvertActionTests: XCTestCase {
                     start: nil,
                     source: nil,
                     severity: .warning,
-                    summary: "The 'diagnostics.json' digest file is deprecated and will be removed after 6.2 is released. Pass a `--diagnostics-file <diagnostics-file>` to specify a custom location where DocC will write a diagnostics JSON file with more information.",
+                    summary: "The 'diagnostics.json' digest file is deprecated and will be removed after 6.3 is released. Pass a `--diagnostics-file <diagnostics-file>` to specify a custom location where DocC will write a diagnostics JSON file with more information.",
                     explanation: nil,
                     notes: []
                 ),
@@ -764,7 +764,7 @@ class ConvertActionTests: XCTestCase {
                     start: nil,
                     source: nil,
                     severity: .warning,
-                    summary: "The 'diagnostics.json' digest file is deprecated and will be removed after 6.2 is released. Pass a `--diagnostics-file <diagnostics-file>` to specify a custom location where DocC will write a diagnostics JSON file with more information.",
+                    summary: "The 'diagnostics.json' digest file is deprecated and will be removed after 6.3 is released. Pass a `--diagnostics-file <diagnostics-file>` to specify a custom location where DocC will write a diagnostics JSON file with more information.",
                     explanation: nil,
                     notes: []
                 ),

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"openapi": "3.0.0",`
`3`	`3`	`"info": {`
`4`		`- "description": "Specification of the deprecated DocC diagnostics.json digest file. This deprecated file will be removed after 6.2 is released.",`
	`4`	`+ "description": "Specification of the deprecated DocC diagnostics.json digest file. This deprecated file will be removed after 6.3 is released.",`
`5`	`5`	`"version": "0.1.0",`
`6`	`6`	`"title": "Diagnostics"`
`7`	`7`	`},`
Original file line number	Diff line number	Diff line change
`@@ -50,8 +50,8 @@ struct ConvertFileWritingConsumer: ConvertOutputConsumer, ExternalNodeConsumer {`
`50`	`50`	`self.assetPrefixComponent = bundleID?.rawValue.split(separator: "/").joined(separator: "-")`
`51`	`51`	`}`
`52`	`52`
`53`		`- @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")`
`54`		`- func consume(problems: [Problem]) throws {`
	`53`	`+ @available(*, deprecated, message: "This deprecated API will be removed after 6.3 is released")`
	`54`	`+ func _deprecated_consume(problems: [Problem]) throws {`
`55`	`55`	`let diagnostics = problems.map { problem in`
`56`	`56`	`Digest.Diagnostic(diagnostic: problem.diagnostic, rootURL: bundleRootFolder)`
`57`	`57`	`}`
`@@ -251,7 +251,7 @@ enum Digest {`
`251`	`251`	`let downloads: [DownloadReference]`
`252`	`252`	`}`
`253`	`253`
`254`		`- @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")`
	`254`	`+ @available(*, deprecated, message: "This deprecated API will be removed after 6.3 is released")`
`255`	`255`	`struct Diagnostic: Codable {`
`256`	`256`	`struct Location: Codable {`
`257`	`257`	`let line: Int`
`@@ -270,7 +270,7 @@ enum Digest {`
`270`	`270`	`}`
`271`	`271`	`}`
`272`	`272`
`273`		`-@available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")`
	`273`	`+@available(*, deprecated, message: "This deprecated API will be removed after 6.3 is released")`
`274`	`274`	`private extension Digest.Diagnostic {`
`275`	`275`	`init(diagnostic: Diagnostic, rootURL: URL?) {`
`276`	`276`	`self.start = (diagnostic.range?.lowerBound).map { Location(line: $0.line, column: $0.column) }`
Original file line number	Diff line number	Diff line change
`@@ -66,14 +66,14 @@ class DeprecatedDiagnosticsDigestWarningTests: XCTestCase {`
`66`	`66`	`let deprecationWarning = try XCTUnwrap(outputConsumer.problems.first?.diagnostic)`
`67`	`67`
`68`	`68`	`XCTAssertEqual(deprecationWarning.identifier, "org.swift.docc.DeprecatedDiagnosticsDigets")`
`69`		- XCTAssertEqual(deprecationWarning.summary, "The 'diagnostics.json' digest file is deprecated and will be removed after 6.2 is released. Pass a `--diagnostics-file <diagnostics-file>` to specify a custom location where DocC will write a diagnostics JSON file with more information.")
	`69`	+ XCTAssertEqual(deprecationWarning.summary, "The 'diagnostics.json' digest file is deprecated and will be removed after 6.3 is released. Pass a `--diagnostics-file <diagnostics-file>` to specify a custom location where DocC will write a diagnostics JSON file with more information.")
`70`	`70`	`}`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`private class TestOutputConsumer: ConvertOutputConsumer, ExternalNodeConsumer {`
`74`	`74`	`var problems: [Problem] = []`
`75`	`75`
`76`		`- func consume(problems: [Problem]) throws {`
	`76`	`+ func _deprecated_consume(problems: [Problem]) throws {`
`77`	`77`	`self.problems.append(contentsOf: problems)`
`78`	`78`	`}`
`79`	`79`