Launch Swift extension if workspace has buildServer.json or compile_flags.txt

[ahoppen]

The VS Code extension currently check for the presence of Package.swift or compile_commands.json in isValidWorkspaceFolder. SourcKit-LSP can also handle compile_flags.txt (https://clang.llvm.org/docs/JSONCompilationDatabase.html#alternatives) or files that specify a build server by having buildServer.json in their project root. Such projects should also be considered valid workspaces, I think.

[aelam]

@ahoppen
if bsp is enabled i.e. buildServer.json
should some bsp request be sent from the client?

[ahoppen]

If buildServer.json exists in the workspace root, SourceKit-LSP will launch the BSP server and send the initialize request to it. I don’t know what you mean by client here. The editor should not send any request to the BSP server.

[aelam]

@ahoppen
Thanks for replying.

I checked the xcode-build-server, only build/initialize and build/initialized are sent.
I'm wondering how workspace/buildTargets is sent. is it sent from client. (i.e. vscode-swift if it supports bsp)

• build/initialize
• build/initialized
• workspace/buildTargets
  

[ahoppen]

This is because we changed the BSP integration between 6.0 and 6.1 (https://forums.swift.org/t/extending-functionality-of-build-server-protocol-with-sourcekit-lsp/74400 has the details). xcode-build-server is still using the old integration that uses textDocument/registerForChanges and build/sourceKitOptionsChanged instead of workspace/buildTargets, to the best of my knowledge. If the BSP server returns data.sourceKitOptionsProvider: true in the initialize request, we switch to the “new” integration using workspace/buildTargets. https://github.com/swiftlang/sourcekit-lsp/blob/main/Contributor%20Documentation/Implementing%20a%20BSP%20server.md has the details on how to implement a BSP server for SourceKit-LSP.

[aelam]

Thank you for your detailed explanation!

Initially, I assumed the client would send a workspace/buildTargets request.

If the BSP server returns data.sourceKitOptionsProvider: true in the initialize request, we switch to the “new” integration using workspace/buildTargets.

I am aware of the newer APIs, such as workspace/buildTargets. Following the guidance from the SourceKit-LSP documentation and reviewing the sourcekit-lsp codebase, I added data.sourceKitOptionsProvider: true here:
BuildInitializeRequest.swift#L92C25-L92C49.

However, I haven't observed any changes.
It seems the workspace/buildTargets request will never be triggered.

Currently, all I receive are these three messages:

• build/initialize
• build/initialized
• textDocument/registerForChanges (open/close file)

Would you know more details about how this works or if additional configuration is required?

[ahoppen]

Are you using SourceKit-LSP from Swift 6.1? SourceKit-LSP from a 6.0 toolchain only has the “old” BSP integration.

Also, since this discussion is not really related to the original issue, let’s move it to the Swift Forums. Can you open a topic in the SourceKit-LSP category?

[award999]

Verified with c047d4e