Add quick switcher between iOS and macOS targets #381

complexspaces · 2022-07-31T20:35:28Z

This PR adds a command palette action to the extension that allows a user to quickly switch between the macOS and iOS SDK targets. It's only available if the host is macOS because the iOS SDK is not (officially) available for distribution on other operating systems.

The goal of these changes are to make the extension a more reasonable replacement for XCode by getting closer to the cross-compiling convenience that XCode offers through its UI.

demo.mov

swift-server-bot · 2022-07-31T20:35:30Z

Can one of the admins verify this patch?

swift-server-bot · 2022-07-31T20:35:30Z

Can one of the admins verify this patch?

swift-server-bot · 2022-07-31T20:35:30Z

Can one of the admins verify this patch?

swift-server-bot · 2022-07-31T20:35:30Z

Can one of the admins verify this patch?

complexspaces · 2022-07-31T20:38:03Z

I was hoping that this would work in the context of a standalone Swift file (no SPM package present), but it doesn't seem to. I don't know if this is because my changes are wrong or because the extension doesn't currently support this. Single files seem to only work for the host's SDK.

stevapple · 2022-07-31T20:57:06Z

@complexspaces Thanks for your PR and I think it’s a good idea.

As for cross-compiling a standalone file, I didn’t add the support because scripts are mostly intended to be run on the host machine directly, but it’s certainly useful to cross-compile a file without running it immediately. Perhaps we can add an action to generate a task.json entry for the current script?

I initially designed the cross-compilation ability with swift build arguments, but it ends up making the build command too long and introducing divergence between SwiftPM and SourceKit-LSP. Recently I’ve thought about redesigning the feature with autogenerated destination.json by the plugin. If you have any suggestions you could just point out.

adam-fowler

Thank you for the contribution. In general this looks good. A few comments

package.json

src/commands.ts

adam-fowler · 2022-08-01T16:24:13Z

src/utilities/utilities.ts

+ *
+ * @param indirect whether to pass the flags by -Xswiftc
+ */
+export function swiftDriverTargetFlags(indirect = false): string[] {


Not sure about setting the target command line parameter based on the sdk parameter. It seems a little fragile although I don't see a quick and easy way to set it otherwise.

I agree that this is a bit fragile, but I wasn't sure of another way to do this without exposing SDK versioning information to the user as well, something that wouldn't necessary 95% of the time because XCode's SDK uses symlinks.

What do you think about adding/removing the target parameter from the build arguments setting when you choose the platform? It would be clearer to the user what is happening. The current version is adding hidden arguments which might confuse the user. I don't have an issue with exposing the underlying details to the user

EDIT: forget this. It's just as clunky

If we move to using destination files that'll make this a lot simpler

adam-fowler · 2022-08-01T16:24:30Z

src/toolchain/toolchain.ts

@@ -46,6 +46,11 @@ interface SwiftTargetInfo {
    [name: string]: string | object | undefined;
 }

+export enum DarwinCompatibleTarget {


do we want to support building for the simulator as well as device.

I wasn't sure about how to expose the simulator, hence why I didn't add it to start. Do you think it should be (in the switcher UI), labeled something like iOS (Simulator)? I have not personally written any code that required simulator guards so I can't speak for how useful this is.

We can give this a miss just now

Sorry, I'm not familiar with that phrase 😓. Does "give this a miss" (here and other instances in this PR) mean to not worry about it for now?

"give this a miss" means "lets not bother"

complexspaces · 2022-08-03T01:48:39Z

As for cross-compiling a standalone file, I didn’t add the support because scripts are mostly intended to be run on the host machine directly, but it’s certainly useful to cross-compile a file without running it immediately. Perhaps we can add an action to generate a task.json entry for the current script?

@stevapple My use case is probably fairly unique, but I have a large code repository where individual Swift files are compiled (mostly) on their own into standalone static libraries before being linked into larger Rust library builds. If it helps, the organization looks like this:

.
├── rust-crate-1/
│   ├── src/
│   │   ├── lib.rs
│   │   └── swift/
│   │       └── Supporting.swift
│   └── Cargo.toml
└── rust-crate-2/
    ├── src/
    │   ├── lib.rs
    │   └── swift/
    │       └── Supporting.Swift
    └── Cargo.toml

One of my goals with this PR was to support a structure like this where an IDE such as XCode is unable to work with individual files. It works OK with just macOS today, but we have the need to also have iOS-specific Swift code that uses things like UIKit. So, I'm not looking to ever run the file directly, but just to get a smooth editing experience. Does that make sense for the most part? Given that, I don't think a task.json would be the correct approach.

src/commands.ts

adam-fowler · 2022-08-06T09:09:35Z

src/utilities/utilities.ts

+ *
+ * @param indirect whether to pass the flags by -Xswiftc
+ */
+export function swiftDriverTargetFlags(indirect = false): string[] {


What do you think about adding/removing the target parameter from the build arguments setting when you choose the platform? It would be clearer to the user what is happening. The current version is adding hidden arguments which might confuse the user. I don't have an issue with exposing the underlying details to the user

EDIT: forget this. It's just as clunky

adam-fowler · 2022-08-06T09:09:42Z

src/toolchain/toolchain.ts

@@ -46,6 +46,11 @@ interface SwiftTargetInfo {
    [name: string]: string | object | undefined;
 }

+export enum DarwinCompatibleTarget {


We can give this a miss just now

src/commands.ts

package.json

adam-fowler · 2022-08-06T09:11:06Z

src/utilities/utilities.ts

+ *
+ * @param indirect whether to pass the flags by -Xswiftc
+ */
+export function swiftDriverTargetFlags(indirect = false): string[] {


If we move to using destination files that'll make this a lot simpler

adam-fowler · 2022-08-09T16:25:20Z

I stole your quickPick in #384. It works really well. Hopefully we can combine the work from both #384 and this PR.

adam-fowler · 2022-08-09T16:31:08Z

src/toolchain/toolchain.ts

+                break;
+        }
+
+        const { stdout } = await execFile("xcrun", ["--sdk", sdkType, "--show-sdk-path"]);


Can you include the following as an argument in the execFile call. Means we can pass DEVELOPER_DIR to the xcrun call and get the sdk from non-default Xcode installs

options: { env: {...process.env, ...configuration.swiftEnvironmentVariables}, }

Sure, no problem. That seems reasonable to me. I've added the environment variable forwarding to my changes.

adam-fowler · 2022-08-14T15:48:38Z

@swift-server-bot test this please

complexspaces · 2022-08-14T17:42:22Z

Thank you for working with me on this one, I'm happy to see it merged 🎉

adam-fowler · 2022-08-14T18:50:31Z

@complexspaces Although I just noticed after merging, building doesn't work. I know you can't build a complete iOS package, but it is still useful to build.

By the way thanks for your contribution.

adam-fowler reviewed Aug 1, 2022

View reviewed changes

complexspaces force-pushed the ios-sdk-switcher branch 2 times, most recently from e7c96bc to 09862e4 Compare August 3, 2022 04:24

adam-fowler reviewed Aug 6, 2022

View reviewed changes

adam-fowler reviewed Aug 9, 2022

View reviewed changes

stevapple mentioned this pull request Aug 9, 2022

[WIP] Fully support cross-compilation model based on destination.json #386

Closed

Add quick switcher between iOS and macOS targets

3102d30

complexspaces force-pushed the ios-sdk-switcher branch from 09862e4 to 3102d30 Compare August 12, 2022 01:44

adam-fowler approved these changes Aug 14, 2022

View reviewed changes

adam-fowler merged commit 70f7585 into swiftlang:main Aug 14, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add quick switcher between iOS and macOS targets #381

Add quick switcher between iOS and macOS targets #381

complexspaces commented Jul 31, 2022

swift-server-bot commented Jul 31, 2022

swift-server-bot commented Jul 31, 2022

swift-server-bot commented Jul 31, 2022

swift-server-bot commented Jul 31, 2022

complexspaces commented Jul 31, 2022

stevapple commented Jul 31, 2022

adam-fowler left a comment

adam-fowler Aug 1, 2022

complexspaces Aug 3, 2022

adam-fowler Aug 6, 2022 •

edited

Loading

adam-fowler Aug 6, 2022

adam-fowler Aug 1, 2022

complexspaces Aug 3, 2022

adam-fowler Aug 6, 2022

complexspaces Aug 12, 2022

adam-fowler Aug 14, 2022

complexspaces commented Aug 3, 2022

adam-fowler Aug 6, 2022 •

edited

Loading

adam-fowler Aug 6, 2022

adam-fowler Aug 6, 2022

adam-fowler commented Aug 9, 2022

adam-fowler Aug 9, 2022

complexspaces Aug 12, 2022

adam-fowler commented Aug 14, 2022

complexspaces commented Aug 14, 2022

adam-fowler commented Aug 14, 2022 •

edited

Loading

Add quick switcher between iOS and macOS targets #381

Add quick switcher between iOS and macOS targets #381

Conversation

complexspaces commented Jul 31, 2022

swift-server-bot commented Jul 31, 2022

swift-server-bot commented Jul 31, 2022

swift-server-bot commented Jul 31, 2022

swift-server-bot commented Jul 31, 2022

complexspaces commented Jul 31, 2022

stevapple commented Jul 31, 2022

adam-fowler left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adam-fowler Aug 6, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

complexspaces commented Aug 3, 2022

adam-fowler Aug 6, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adam-fowler commented Aug 9, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adam-fowler commented Aug 14, 2022

complexspaces commented Aug 14, 2022

adam-fowler commented Aug 14, 2022 • edited Loading

adam-fowler Aug 6, 2022 •

edited

Loading

adam-fowler Aug 6, 2022 •

edited

Loading

adam-fowler commented Aug 14, 2022 •

edited

Loading