Support resolving code file references in ConvertService #570
Conversation
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
|
@swift-ci please test |
ethan-kusters
approved these changes
May 4, 2023
| @@ -74,6 +76,21 @@ public struct RenderNodeTranslator: SemanticVisitor { | |||
| return assetReference | |||
| } | |||
|
|
|||
| private func fileContents(with fileReference: ResourceReference) -> String? { | |||
| // Check if the file is a local asset that can be read directly from the context | |||
| if let fileData = try? context.resource(with: fileReference) { | |||
There was a problem hiding this comment.
Nit: It looks like this logic is duplicated at least once – should we consider moving this to a specific method in the DocumentationContext?
There was a problem hiding this comment.
Twice is below my threshold for duplication of something this small. I'm also thinking that this behavior would probably conceptually be more relevant to the asset manager or the data provider but moving it to either of those places would be bigger than this.
|
@swift-ci please test |
d-ronnqvist
added a commit
to d-ronnqvist/swift-docc
that referenced
this pull request
May 5, 2023
* Support resolving code file references in ConvertService rdar://107965493 * Support highlighting lines in resolved file assets
d-ronnqvist
added a commit
that referenced
this pull request
May 9, 2023
d-ronnqvist
added a commit
to d-ronnqvist/swift-docc
that referenced
this pull request
May 9, 2023
* Support resolving code file references in ConvertService rdar://107965493 * Support highlighting lines in resolved file assets
d-ronnqvist
added a commit
that referenced
this pull request
May 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Bug/issue #, if applicable: rdar://107965493
Summary
This enables convert service requests to resolve file assets that are references in the tutorial steps. This is done by asking the context to resolve the file asset if its data doesn't already exist.
Dependencies
None
Testing
In a client that uses
ConvertService:@Codereferences result in DocC returning a render node with file references for those code files with line highlights for the differences between the files' content.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded