Repository navigation
Conversation
Add a section to Protocol.md describing the request keys, the response format and how to exercise the request with sourcekitd-test. Part of swiftlang#44725
This file contains hidden or 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
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.
Adds a "Related Identifiers" section to
tools/SourceKit/docs/Protocol.mdand a row for it in the table of contents. The section follows the format of the existing sections (Cursor Info, Expression Type) and covers:key.primary_file/key.sourcefile,key.offset,key.compilerargs,key.include_non_editable_base_namesandkey.cancel_on_subsequent_request. These come fromhandleRequestRelatedIdentsinRequests.cpp.key.resultsentries withkey.offset,key.lengthandkey.nametype(thesource.syntacticrename.*UIDs), pluskey.name. These come fromfindRelatedIdents.sourcekitd-test -req=related-idents. The example input and output are copied fromtest/SourceKit/RelatedIdents/related_idents.swift(theCHECK1case), so they match what the tool actually prints.This is a documentation-only change.
Part of #44725. That issue tracks documenting the remaining SourceKit request types, and I plan to cover the others in separate small PRs.