VSC w/ ESP-IDF: how do I configure LSP to have autocompletion for bridged headers?

[3Qax (Jakub Towarek)]

Hi I wonder if it's somehow possible to have autocompletion I get for regular Swift code:

but for the C functions imported in BridgingHeader.h, like led_driver_set_brightness() or led_driver_set_saturation(). Per Using SourceKit-LSP with Embedded Projects I've attempted to specify -import-bridging-header to the LSP like so, but I couldn't get it working.

.vscode/settings.json:

"swift.buildArguments": ["-import-bridging-header", "/Users/[redacted]/swift-matter-examples/led-blink/main/BridgingHeader.h"]

or via .sourcekit-lsp/config.json:

{
  "swiftPM": {
    "swiftCompilerFlags": "-import-bridging-header", "/Users/[redacted]/swift-matter-examples/led-blink/main/BridgingHeader.h"]
  }
}

Not sure if that matters, but I am able to successfully compile and upload the blink example to my ESP32C6. As far as I remember, in Xcode the autocomplete does suggest things imported through bridging header, so my guess is that it should be possible. Any help would be greatly appraciated.

[tiye]

any updates after the new release of VS Code extension?

[Amm0]

IDK don't know if this works on the embedded headers, but if you add something like this with your SDK name, it might work same as Static Linux build:

{
  "swiftPM": {
    "swiftSDK": "x86_64-swift-linux-musl"
  }
}

in VSCode project, named .sourcekit-lsp/config.json

[MisutaaAsriel]

@bnbarham

The problem you're running into here is that with the current setup, sourcekit-lsp has no way to know what settings to use for a particular file (so eg. main.swift here).

sourcekit-lsp has a few ways to retrieve this information - either through SwiftPM, a compilation databases, or a custom BSP server.

The second is what you're looking for in this case.

Unfortunately, there's no simple way to produce compile_commands.json with Make (with CMake you can set CMAKE_EXPORT_COMPILE_COMMANDS). You could probably get away with using compile_flags.txt today, but I would recommend just manually crafting compile_commads.json instead:

1. Remove swift.sourcekit-lsp.serverArguments from .vscode/settings.json - these are arguments to provide to the language server (sourcekit-lsp) on launch, not compilation arguments.
2. Remove .sourcekit-lsp/config.json - swiftPM is specifically for configuring SwiftPM projects further, which you don't have here.
3. Add a compile_commands.json next to your makefile:

[
  {
    "directory": "<Absolute path to project root>",
    "command": "swiftc <Relative path to main swift file> -enable-experimental-feature Embedded <Flags go here>",
    "file": "<Relative path to main swift file>"
  }
]

4. Open the workspace in VS Code

I asked a similar question here elsewhere in regards to another project that had a similar structure, albeit it uses makefiles instead of cmake.

TL:DR it appears that what we were trying was for SwiftPM project, which we are not using.

In your case, you appear to be using CMAKE, so you can seemingly, in fact, achieve autocomplete using CMAKE_EXPORT_COMPILE_COMMANDS to create the compilation database.

For those using makefiles, you apparently need to craft the compilation database json yourself.