Investigate generating module interface from .swiftinterface and .swiftdoc files

[adam-fowler]

For jump to definition of symbols in stdlib or Foundation sourcekit-lsp returns a .swiftinterface file. We should look into generating a user readable swift interface from the .swiftinterface file and it's related .swiftdoc file.

[adam-fowler]

It seems sourcekitd has a request which will return the generated interface for a swift module from a .swiftmodule folder. Below is a possible route to implementing jump to interface

Before we start we should setup a textDocumentProvider for scheme "swiftmodule". This will send a custom request to SK-LSP to return a module interface based on the swiftmodule path sent to it and use the response as the documents contents.

1. Go to definition request is sent to SK-LSP
2. SK-LSP generates module interface text, works out position in generated text for definition and caches the text for later use.
3. SK-LSP returns swiftmodule path and position inside module interface text in response
4. VSCode Language client has middleware which catches this response and edits the file name to use scheme "swiftmodule"
5. Now we are using "swiftmodule" scheme the textDocumentProvider created above will trigger and send request to SK-LSP for the module interface
6. Given we have cached the module interface earlier in stage 2 this should be a simple returning the contents of the cache.

[ahoppen]

That sounds like good scheme to me. 👍

[adam-fowler]

This is now merged in sourcekit-lsp swiftlang/sourcekit-lsp#747
And vscode support is done here #538