-
Notifications
You must be signed in to change notification settings - Fork 62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Set swift.swiftSDK for target platforms #1390
Open
rbenegal
wants to merge
2
commits into
swiftlang:main
Choose a base branch
from
rbenegal:fix-target-platform-selection-sdk
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the VS Code Swift open source project | ||
| // | ||
| // Copyright (c) 2021-2025 the VS Code Swift project authors | ||
| // Licensed under Apache License v2.0 | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // See CONTRIBUTORS.txt for the list of VS Code Swift project authors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import { expect } from "chai"; | ||
| import * as vscode from "vscode"; | ||
| import { | ||
| mockObject, | ||
| mockGlobalObject, | ||
| mockGlobalModule, | ||
| MockedObject, | ||
| mockFn, | ||
| instance, | ||
| } from "../../MockUtils"; | ||
| import { | ||
| DarwinCompatibleTarget, | ||
| SwiftToolchain, | ||
| getDarwinTargetTriple, | ||
| } from "../../../src/toolchain/toolchain"; | ||
| import { WorkspaceContext } from "../../../src/WorkspaceContext"; | ||
| import { switchPlatform } from "../../../src/commands/switchPlatform"; | ||
| import { StatusItem } from "../../../src/ui/StatusItem"; | ||
| import configuration from "../../../src/configuration"; | ||
|
|
||
| suite("Switch Target Platform Unit Tests", () => { | ||
| const mockedConfiguration = mockGlobalModule(configuration); | ||
| const windowMock = mockGlobalObject(vscode, "window"); | ||
| const mockSwiftToolchain = mockGlobalModule(SwiftToolchain); | ||
| let mockContext: MockedObject<WorkspaceContext>; | ||
| let mockedStatusItem: MockedObject<StatusItem>; | ||
|
|
||
| setup(() => { | ||
| mockedStatusItem = mockObject<StatusItem>({ | ||
| start: mockFn(), | ||
| end: mockFn(), | ||
| }); | ||
| mockContext = mockObject<WorkspaceContext>({ | ||
| statusItem: instance(mockedStatusItem), | ||
| }); | ||
| }); | ||
|
|
||
| test("Call Switch Platform and switch to iOS", async () => { | ||
| const selectedItem = { value: DarwinCompatibleTarget.iOS, label: "iOS" }; | ||
| windowMock.showQuickPick.resolves(selectedItem); | ||
| mockSwiftToolchain.getSDKForTarget.resolves(""); | ||
| expect(mockedConfiguration.swiftSDK).to.equal(""); | ||
|
|
||
| await switchPlatform(instance(mockContext)); | ||
|
|
||
| expect(windowMock.showQuickPick).to.have.been.calledOnce; | ||
| expect(windowMock.showWarningMessage).to.have.been.calledOnceWithExactly( | ||
| "Selecting the iOS target platform will provide code editing support, but compiling with a iOS SDK will have undefined results." | ||
| ); | ||
| expect(mockedStatusItem.start).to.have.been.called; | ||
| expect(mockedStatusItem.end).to.have.been.called; | ||
| expect(mockedConfiguration.swiftSDK).to.equal( | ||
| getDarwinTargetTriple(DarwinCompatibleTarget.iOS) | ||
| ); | ||
| }); | ||
|
|
||
| test("Call Switch Platform and switch to macOS", async () => { | ||
| const selectedItem = { value: undefined, label: "macOS" }; | ||
| windowMock.showQuickPick.resolves(selectedItem); | ||
| mockSwiftToolchain.getSDKForTarget.resolves(""); | ||
| expect(mockedConfiguration.swiftSDK).to.equal(""); | ||
|
|
||
| await switchPlatform(instance(mockContext)); | ||
|
|
||
| expect(windowMock.showQuickPick).to.have.been.calledOnce; | ||
| expect(windowMock.showWarningMessage).to.not.have.been.called; | ||
| expect(mockedStatusItem.start).to.have.been.called; | ||
| expect(mockedStatusItem.end).to.have.been.called; | ||
| expect(mockedConfiguration.swiftSDK).to.equal(""); | ||
| }); | ||
| }); |
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.
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.
Not sure if we should keep
configuration.sdkfor toolchains less than 6.1 or if we should just avoid setting it entirely since it doesn't provide any code editing support from SourceKit-LSP. Also it seems like we'll need eitherconfiguration.sdkorconfiguration.swiftSDKset, but not both together.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'm leaning towards just hiding this command altogether on unsupported toolchain and OS combinations instead of showing a warning notification. The setting description in the
package.jsonshould probably have a warning about this as well.I'm not entirely sure of the difference between the two, but I'm guessing
configuration.sdkis for older Swift versions that don't support the--swift-sdkoption? In which case we could even change the behaviour of this command depending on the Swift version.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.
Thank you, yes good points, seems like it only makes sense to really show the option for supported combinations (currently only Darwin-based platforms). Potentially in the future it would make sense to have a list of common target-triples for other platforms as well to enable convenient switching.
It doesn't look like setting
configuration.sdkmakes much difference for any code editing/SourceKit support functionality. Perhaps it did something for much older toolchains, but it doesn't seem to do much in terms of code editing support for 5.10 or 6 at least. Probably better to avoid setting it to something automatically to prevent confusion.