Outside requirements

[adam-fowler]

Outside requirements

This is a list of issues added to other projects that would improve the VS Code Swift extension. I will try to keep this up to date as new requirements/bugs appear or are resolved.

Features

• Custom LSP request to return all tests and their location Add custom request to return a list of all the tests in a project with locations sourcekit-lsp#611
• Run formatter on CodeAction text. It is assumed by sourcekitd that CodeAction text will be formatted by another process. SourceKit-LSP should be doing this formatting. [SR-16106] Once SourceKit-LSP supports formatting, run formatter on text inserted by CodeActions sourcekit-lsp#496
• To support Rename Symbol in VS Code we need to support LSP RenameRequest [SR-16104] SourceKit-LSP: Add support for RenameRequest sourcekit-lsp#498
• SourceKit-LSP not aware of changes from other files. This is difficult to resolve but can be mitigated with LSP textDocument/diagnostic support. [SR-16080] SourceKit-LSP isn't aware of changes in other files sourcekit-lsp#500
• Jump to definition for stdlib/Foundation. This is a very involved task which could result in a fair amount of work from both extension and SourceKit-LSP Add support for jump to definition for stdlib/Foundation symbols sourcekit-lsp#618
• Add custom snippet folder to package describe, so VS Code extension can catch new snippets without having to keep running swift package describe Add snippet folder to swift package describe output swift-package-manager#5750
• Add cross compilation arguments to source kit-lsp Align the set of cross-compilation arguments with SwiftPM sourcekit-lsp#601

Bugs

• Reword confusing error https://github.com/apple/sourcekit-lsp/issues/503
• Cannot support sanitizers while this occurs. Hang when swapping sanitizers [SR-16079] swiftpm-xctest-helper crashes when swapping sanitizers swift-package-manager#4339
• Cannot skip tests when listing tests (Swift 5.8) Cannot skip build when listing tests swift-package-manager#5739
• Listing tests outputs error message (Swift 5.8) Listing tests with empty LinuxMain.swift outputs error message (Swift 5.8) swift-package-manager#5744
• LLDB Python scripts are broken on Linux. This can break the finding of the Swift version of LLDB. Running Python scripts inside LLDB on Ubuntu 20.04 is broken llvm-project#4770
• Jump to definition requires reload after build Jump to definition requires a reload after build sourcekit-lsp#620
• workspace-state.json isn't updated when dependency removed. If it was we could use it as a source of truth for project dependencies Removing a dependency from the Package.swift does not remove it from workspace-state.json swift-package-manager#5727

[stevapple]

Perhaps give swiftlang/sourcekit-lsp#601 a shot as it’s one of the main blockers for #386. It’s hard to pass all the configurations to SK-LSP, but much easier if we can use destination file directly.

Also wants to mention how CLion deals with corelib/stdlib jump-to-definitions: it preloads all the available modules, generates .swift files with public interface and documentation, and caches them to disk. This is, however, very very time-consuming, but we can see if it’s possible to do it for a single module instantly (to achieve an Xcode-like UX).

[adam-fowler]

Added swiftlang/sourcekit-lsp#601

[adam-fowler]

I added #408 for generating module interface files