Add new functions for working with link completion in editor integrations #1129
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
mayaepps
approved these changes
Dec 19, 2024
Sources/SwiftDocC/DocumentationService/Convert/Symbol Link Resolution/LinkCompletionTools.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/DocumentationService/Convert/Symbol Link Resolution/LinkCompletionTools.swift
Outdated
Show resolved
Hide resolved
Tests/SwiftDocCTests/Infrastructure/Symbol Link Resolution/LinkCompletionToolsTests.swift
Show resolved
Hide resolved
- Iterate over identifiers instead of over disambiguations - Add test to verify that order of parameters matter - Use optional chaining instead of optional `map`.
|
@swift-ci please test |
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://141689095
Summary
This adds new functions for working with link completion in editor integrations. It also deprecates the old types and API.
The implementation for the new API calls the same code that DocC uses to parse links, compute disambiguation, and match symbols against written link strings, so its behavior will be much closer to how DocC behaves when building documentation than the old, now deprecated API, was.
Dependencies
None.
Testing
Call the new API. It should behave like the examples in the added tests.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded