Formally deprecate the old diagnostics.json digest file #1163
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| /* | ||
| This source file is part of the Swift.org open source project | ||
|
|
||
| Copyright (c) 2025 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 Foundation | ||
| import SwiftDocC | ||
| import SwiftDocCTestUtilities | ||
| import XCTest | ||
|
|
||
| class DeprecatedDiagnosticsDigestWarningTests: XCTestCase { | ||
| func testNoDeprecationWarningWhenThereAreNoOtherWarnings() throws { | ||
| let catalog = Folder(name: "unit-test.docc", content: [ | ||
| TextFile(name: "Root.md", utf8Content: """ | ||
| # Root | ||
|
|
||
| An empty root page | ||
| """) | ||
| ]) | ||
| let (bundle, context) = try loadBundle(catalog: catalog) | ||
|
|
||
| let outputConsumer = TestOutputConsumer() | ||
|
|
||
| _ = try ConvertActionConverter.convert( | ||
| bundle: bundle, | ||
| context: context, | ||
| outputConsumer: outputConsumer, | ||
| sourceRepository: nil, | ||
| emitDigest: true, | ||
| documentationCoverageOptions: .noCoverage | ||
| ) | ||
|
|
||
| XCTAssert(outputConsumer.problems.isEmpty, "Unexpected problems: \(outputConsumer.problems.map(\.diagnostic.summary).joined(separator: "\n"))") | ||
| } | ||
|
|
||
| func testDeprecationWarningWhenThereAreOtherWarnings() throws { | ||
| let catalog = Folder(name: "unit-test.docc", content: [ | ||
| TextFile(name: "Root.md", utf8Content: """ | ||
| # Root | ||
|
|
||
| An empty root page | ||
|
|
||
| This link will result in a warning: ``NotFound``. | ||
| """) | ||
| ]) | ||
| let (bundle, context) = try loadBundle(catalog: catalog) | ||
|
|
||
| let outputConsumer = TestOutputConsumer() | ||
|
|
||
| _ = try ConvertActionConverter.convert( | ||
| bundle: bundle, | ||
| context: context, | ||
| outputConsumer: outputConsumer, | ||
| sourceRepository: nil, | ||
| emitDigest: true, | ||
| documentationCoverageOptions: .noCoverage | ||
| ) | ||
|
|
||
| XCTAssertEqual(outputConsumer.problems.count, 2, "Unexpected problems: \(outputConsumer.problems.map(\.diagnostic.summary).joined(separator: "\n"))") | ||
|
|
||
| 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.") | ||
| } | ||
| } | ||
|
|
||
| private class TestOutputConsumer: ConvertOutputConsumer { | ||
| var problems: [Problem] = [] | ||
|
|
||
| func consume(problems: [Problem]) throws { | ||
| self.problems.append(contentsOf: problems) | ||
| } | ||
|
|
||
| func consume(renderNode: RenderNode) throws { } | ||
| func consume(assetsInBundle bundle: DocumentationBundle) throws { } | ||
| func consume(linkableElementSummaries: [LinkDestinationSummary]) throws { } | ||
| func consume(indexingRecords: [IndexingRecord]) throws { } | ||
| func consume(assets: [RenderReferenceType: [RenderReference]]) throws { } | ||
| func consume(benchmarks: Benchmark) throws { } | ||
| func consume(documentationCoverageInfo: [CoverageDataEntry]) throws { } | ||
| func consume(renderReferenceStore: RenderReferenceStore) throws { } | ||
| func consume(buildMetadata: BuildMetadata) throws { } | ||
| func consume(linkResolutionInformation: SerializableLinkResolutionInformation) throws { } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because
ConvertOutputConsumeris a public protocol I had to get a bit creative to be able to still call its deprecated API without introducing deprecation warnings in the DocC code.