guides icon indicating copy to clipboard operation
guides copied to clipboard

Published 20 hours ago • verified publisher icon swift-server

Document using Swift with VSCode

Open tomerd opened this issue 4 years ago • 6 comments

  • installing directly
  • dev containter
  • document any issues to make this easier, and pursue fixing / reporting to swift team as appropriate

tomerd avatar Jul 07 '21 16:07 tomerd

Initial set up stuff:

Install VSCode Install the following extensions:

  • CodeLLDB
  • Maintained Swift Development Environment
  • Swift Language
  • Swift Test Explorer

Open the settings for Swift SDE and set the language server mode to sourcekit-lsp and set the path to SourceKit to your Xcode installations version of the LSP, in my case it was /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/sourcekit-lsp Under the Swift build parameters, pass -Xswiftc -Xfrontend -Xswiftc -serialize-debugging-options as a second option to align it with the test extension

Optional - set all the key shortcuts you use in Xcode to the same behaviours in VSCode

0xTim avatar Aug 18 '21 14:08 0xTim

cc @toddvarland ☝️

0xTim avatar Aug 18 '21 15:08 0xTim

Does DocC help?

VineFiner avatar Sep 22 '21 13:09 VineFiner

@VineFiner How would DocC help?

0xTim avatar Sep 22 '21 13:09 0xTim

How does swift server provide its own api documentation? Are there any best practices. I know OpenAPIKit

VineFiner avatar Sep 22 '21 14:09 VineFiner

I'm confused, what's API documentation got to do with a VSCode guide?

0xTim avatar Sep 22 '21 15:09 0xTim