Add a VSCode devcontainer definition #916
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| ## Using VSCode devcontainers | ||
|
|
||
| Official tutorial: https://code.visualstudio.com/docs/devcontainers/tutorial | ||
|
|
||
| ### Recommended Settings for macOS | ||
|
|
||
| Some of these are defaults: | ||
| - Recommended settings for macOS (some of these are defaults): | ||
| - General: | ||
| - "Choose file sharing implementation for your containers": VirtioFS (better IO performance) | ||
| - Resources: | ||
| - CPUs: Allow docker to use most or all of your CPUs | ||
| - Memory: Allow docker to use most or all of your memory |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| FROM swiftlang/swift:nightly-main-jammy | ||
|
|
||
| RUN \ | ||
| # Disable apt interactive prompts for this RUN command | ||
| export DEBIAN_FRONTEND="noninteractive" && \ | ||
| # Update apt package list | ||
| apt-get update && \ | ||
| # Install sourcekit-lsp dependencies | ||
| apt-get install -y libsqlite3-dev libncurses5-dev python3 | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| // Reference: https://containers.dev/implementors/json_reference/ | ||
| { | ||
| "name": "SourceKit-LSP", | ||
| "dockerFile": "Dockerfile", | ||
|
|
||
|
There was a problem hiding this comment. Is it worthwhile using the "features": {
"ghcr.io/devcontainers/features/common-utils:2": {
"installZsh": "false",
"username": "vscode",
"userUid": "1000",
"userGid": "1000",
"upgradePackages": "false"
},
"ghcr.io/devcontainers/features/git:1": {
"version": "os-provided",
"ppa": "false"
},
},
"remoteUser": "vscode"I also include the There was a problem hiding this comment. Happy to add this but just curious what the downsides are of running as root? I'd also want to make sure that this is indeed something that is relevant to the project, and not just something the user can set in their own There was a problem hiding this comment. I guess it's a security issue. All of Microsoft's language images have a vscode user. And they use the common-utils feature to set it up. So there shouldn't be any issues. I guess in theory you shouldn't need the git feature as git is already in the swift image. There was a problem hiding this comment. I would prefer to keep the There was a problem hiding this comment. I'm not an expert, but AFAICT the "not running as root" stuff is more to do with software in the container making bad assumptions and not running properly as root than anything to do with security. |
||
| // Allow the processes in the container to attach a debugger | ||
| "capAdd": [ "SYS_PTRACE" ], | ||
| "securityOpt": [ "seccomp=unconfined" ], | ||
|
|
||
| "mounts": [ | ||
| // Use a named volume for the build products for optimal performance (https://code.visualstudio.com/remote/advancedcontainers/improve-performance#_use-a-targeted-named-volume) | ||
| "source=${localWorkspaceFolderBasename}-build,target=${containerWorkspaceFolder}/.build,type=volume", | ||
| // Do the same for experimental background indexing | ||
| "source=${localWorkspaceFolderBasename}-index-build,target=${containerWorkspaceFolder}/.index-build,type=volume" | ||
| ], | ||
| "customizations": { | ||
| "vscode": { | ||
| "extensions": [ | ||
| "sswg.swift-lang" | ||
| ], | ||
| "settings": { | ||
| "lldb.library": "/usr/lib/liblldb.so", | ||
| "swift.buildArguments": [ | ||
| "-Xcxx", | ||
| "-I/usr/lib/swift", | ||
| "-Xcxx", | ||
| "-I/usr/lib/swift/Block" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be 6.0? @ahoppen what are your thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have strong thoughts, but when I put this together I believe the guidance was that I should be using a "recent nightly". This should follow whatever the guidance is currently.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ahoppen can make the call. I guess if it is for development maybe it should stay at main
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should use the latest
mainbecause themainbranch of SourceKit-LSP might be using features from sourcekitd, that are only available inmain. When running SourceKit-LSP tests with an older version of sourcekitd, those tests would be skipped.