Skip to content

Commit 139f6c7

Browse files
committed
Note that sourcekit/workspace/symbolInfo may return other URL schemes in the future
1 parent 3dca024 commit 139f6c7

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

Documentation/Open Quickly.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,8 @@ When `sourcekit/workspace/symbolInfo` returns a `WorkspaceSymbol` for an SDK or
139139

140140
> [!NOTE]
141141
> The `file://path/to/module.{swiftinterface,swiftmodule}?module=<moduleName>` URL format is intended to become a general-purpose format used throughout sourcekit-lsp wherever a module file location with associated module name needs to be represented. It is currently only produced by `sourcekit/workspace/symbolInfo`.
142+
>
143+
> In the future, `sourcekit/workspace/symbolInfo` may return other URL schemes. Clients should treat the location URI as opaque and pass it back to the server via `workspaceSymbol/resolve` without attempting to parse or interpret it.
142144
143145
`DocumentURI` equality and hashing use the filesystem path (via `withUnsafeFileSystemRepresentation`), which strips query parameters, so the URL with `?module=` compares equal to the clean path for all index and build-system lookups.
144146

0 commit comments

Comments
 (0)