Support different toolchains per folder #1478
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
plemarquand
force-pushed
the
toolchain-per-folder
branch
2 times, most recently
from
635a376 to
bf2f81e
Compare
plemarquand
requested review from
0xTim,
adam-fowler and
award999
as code owners
plemarquand
force-pushed
the
toolchain-per-folder
branch
from
4b5b441 to
205dd97
Compare
cmcgee1024
reviewed
Apr 8, 2025
Member
cmcgee1024
left a comment
cmcgee1024
left a comment
There was a problem hiding this comment.
This all looks good from my perspective. I'm not sure about the vscode specifics, and the failing test.
plemarquand
force-pushed
the
toolchain-per-folder
branch
from
205dd97 to
312b629
Compare
plemarquand
force-pushed
the
toolchain-per-folder
branch
from
312b629 to
24258bb
Compare
With the introduction of swiftly's `.swift-version` file the active toolchain can now be per-folder instead of global. If the user has multiple different packages open they may each be using a different toolchain as defined by their `.swift-version` file. In order to support this new paradigm the `toolchain` has been moved from `WorkspaceContext` to `FolderContext`. Each time a folder (package) is added to the workspace a new toolchain is created, as it might be different from folder to folder. The toolchain created respects the `.swift-version` file. If the toolchain specified in the `.swift-version` file is not installed an error message is shown prompting the user to install the version with swiftly. There is still a `globalToolchain` on the `WorkspaceContext` which refers to the globally available toolchain. This would be the toolchain used when you run `swift` outside of a workspace folder. This is mainly used as a fallback toolchain for when there are no workspace folders. It is generally advisable to use the toolchain provided on the `FolderContext` to ensure you don't end up using mismatched versions. This PR also refactors the `LanguageClientManager` so that one instance of sourcekit-lsp is started per-toolchain, coordinating startup so that the server from a given toolchain starts up when a folder using that toolchain is added to the workspace. While this PR adds support for .swift-version files, there is still quite a bit of work to do to make using swiftly with the VS Code Swift extension a nicer experience including: Installing swiftly directly from the extension, downloading missing toolchains automatically, listing/picking/downloading toolchains via `swiftly list`, a smoother toolchain switching experience that would optionally write the `.swift-version` file, and more.
plemarquand
force-pushed
the
toolchain-per-folder
branch
from
2694545 to
54cee28
Compare
matthewbastien
requested changes
Apr 22, 2025
Member
matthewbastien
left a comment
matthewbastien
left a comment
There was a problem hiding this comment.
Overall it looks great, thanks! Some minor issues here and there as well as a general question about prompting when there are multiple folders/SourceKit-LSP clients.
plemarquand
force-pushed
the
toolchain-per-folder
branch
from
2c90b2f to
eb44590
Compare
plemarquand
force-pushed
the
toolchain-per-folder
branch
from
ebd020d to
12381cb
Compare
plemarquand
force-pushed
the
toolchain-per-folder
branch
from
45100b5 to
1e7af5d
Compare
…toolchain version in it
matthewbastien
approved these changes
Apr 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With the introduction of swiftly's
.swift-versionfile the active toolchain can now be per-folder instead of global. If the user has multiple different packages open they may each be using a different toolchain as defined by their.swift-versionfile.In order to support this new paradigm the
toolchainhas been moved fromWorkspaceContexttoFolderContext. Each time a folder (package) is added to the workspace a new toolchain is created, as it might be different from folder to folder.The toolchain created respects the
.swift-versionfile. If the toolchain specified in the.swift-versionfile is not installed an error message is shown prompting the user to install the version with swiftly.There is still a
globalToolchainon theWorkspaceContextwhich refers to the globally available toolchain. This would be the toolchain used when you runswiftoutside of a workspace folder. This is mainly used as a fallback toolchain for when there are no workspace folders.It is generally advisable to use the toolchain provided on the
FolderContextto ensure you don't end up using mismatched versions.This PR also refactors the
LanguageClientManagerso that one instance of sourcekit-lsp is started per-toolchain, coordinating startup so that the server from a given toolchain starts up when a folder using that toolchain is added to the workspace.While this PR adds support for .swift-version files, there is still quite a bit of work to do to make using swiftly with the VS Code Swift extension a nicer experience including: Installing swiftly directly from the extension, downloading missing toolchains automatically, listing/picking/downloading toolchains via
swiftly list, a smoother toolchain switching experience that would optionally write the.swift-versionfile, and more.