Add Snippet support with SwiftBuild #9089

bkhouri · 2025-09-04T17:32:42Z

Snippets are treated as executable targets with the native build system.

This change updates the PIF Builder to support snippet, giving Snippet support with the Swift Build build system.

Depends on: swiftlang/swift-build#775
Depends on: #9115
Fixes: #9040
issue: rdar://158630024
issue: rdar://147705448

bkhouri · 2025-09-04T18:39:35Z

@swift-ci test

owenv · 2025-09-04T21:21:34Z

What's here looks good, I just have a few follow up questions

The proposal says:

Snippet targets automatically depend on any library targets declared in their host package, so snippets are free to import those modules.
Are those dependencies getting captured in the PIF right now? Would be good to have a test that imports of API from the package works

It also says:

Snippet targets will be built by default when running swift build --build-snippets. This is consistent with how building tests is an explicit choice, like when running swift test or swift build --build-tests.

Right now, PIFBuilder.buildAggregateProject is adding snippets to the "all-including-tests" target AFAICT, which will cause the snippets to build with just swift test. We might need to add a new aggregate which pulls in snippets that clients can opt into

bkhouri · 2025-09-08T14:42:04Z

With the current implementation, Snippets are build when running swift build command. I'll augment the testBasicBuildSnippets to verify the expected Snippet executables existing the build output directory.

Also, the --build-snippets option is not available with swift build

❯ swift --version               
Apple Swift version 6.2-dev (LLVM fa1f889407fc8ca, Swift 687e09da65c8813)
Target: arm64-apple-macosx26.0
Build config: +assertions

❯ swift build --help | grep snip 

❯

Build Snippets sample

``` ++ swift run swift-build --package-path Fixtures/Miscellaneous/Plugins/PluginsAndSnippets --build-system swiftbuild --show-bin-path Building for debugging... [1/1] Write swift-version-7F702FD1CBFC1C8A.txt Build of product 'swift-build' complete! (0.51s) + BIN_DIR=/Users/bkhouri/Documents/git/public/swiftlang/swift-package-manager/Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/.build/arm64-apple-macosx/Products/Debug + echo 'Binary Directory: /Users/bkhouri/Documents/git/public/swiftlang/swift-package-manager/Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/.build/arm64-apple-macosx/Products/Debug' Binary Directory: /Users/bkhouri/Documents/git/public/swiftlang/swift-package-manager/Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/.build/arm64-apple-macosx/Products/Debug + swift run swift-package --package-path Fixtures/Miscellaneous/Plugins/PluginsAndSnippets --build-system swiftbuild completion-tool list-snippets Building for debugging... [1/1] Write swift-version-7F702FD1CBFC1C8A.txt Build of product 'swift-package' complete! (0.48s) ContainsMain MySnippet main + swift run swift-package reset --package-path Fixtures/Miscellaneous/Plugins/PluginsAndSnippets Building for debugging... [1/1] Write swift-version-7F702FD1CBFC1C8A.txt Build of product 'swift-package' complete! (0.46s) + ls -lh /Users/bkhouri/Documents/git/public/swiftlang/swift-package-manager/Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/.build/arm64-apple-macosx/Products/Debug ls: /Users/bkhouri/Documents/git/public/swiftlang/swift-package-manager/Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/.build/arm64-apple-macosx/Products/Debug: No such file or directory + swift run swift-build --package-path Fixtures/Miscellaneous/Plugins/PluginsAndSnippets --build-system swiftbuild Building for debugging... [1/1] Write swift-version-7F702FD1CBFC1C8A.txt Build of product 'swift-build' complete! (0.48s) Building for debugging...

95% [===============================================================================================================================================================================================================-----------]
main-product 53 / 55
100% [=========================================================================================================================================================================================================================]

Build complete! (2.37 secs.)

ls -lh /Users/bkhouri/Documents/git/public/swiftlang/swift-package-manager/Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/.build/arm64-apple-macosx/Products/Debug
total 240
-rwxr-xr-x 1 bkhouri staff 37K Sep 8 10:41 ContainsMain
drwxr-xr-x 6 bkhouri staff 192B Sep 8 10:41 ContainsMain.swiftmodule
-rwxr-xr-x 1 bkhouri staff 36K Sep 8 10:41 MySnippet
drwxr-xr-x 6 bkhouri staff 192B Sep 8 10:41 MySnippet.swiftmodule
drwxr-xr-x@ 2 bkhouri staff 64B Sep 8 10:41 PackageFrameworks
-rwxr-xr-x 1 bkhouri staff 36K Sep 8 10:41 main
drwxr-xr-x 6 bkhouri staff 192B Sep 8 10:41 main.swiftmodule

</p>
</details>

bkhouri · 2025-09-08T17:07:42Z

@swift-ci test

bkhouri · 2025-09-08T17:38:29Z

@swift-ci test macOS

bkhouri · 2025-09-08T17:38:40Z

@swift-ci test windows

owenv

@bkhouri and I discussed a bit offline. It looks like --build-snippets wasn't implemented as proposed, so the swift build behavior here mirrors the native build system correctly, we just want to ensure we have test coverage that snippets' dependencies on library targets are being wired up correctly

bkhouri · 2025-09-08T18:30:03Z

: Augment the tests to ensure a Snippet can import a library target.

bkhouri · 2025-09-08T22:24:39Z

The linux self hosted pipeline failed as a result of a build timeout during test execution

13:39:06  ◇ Passing 2 arguments buildSystem → .swiftbuild, configuration → .debug to generatedMainIsExistentialAnyClean(buildSystem:configuration:)
16:21:13  Cancelling nested steps due to timeout

The windows self-hosted pipeline failed due to known issues. They have been marked withKnownIssue.

@swift-ci test

bkhouri · 2025-09-08T22:25:27Z

@swift-ci test windows

bkhouri · 2025-09-09T13:14:33Z

@swift-ci test self hosted

bkhouri · 2025-09-09T18:45:39Z

@swift-ci test self hosted

bkhouri · 2025-09-09T19:00:07Z

@swift-ci test self hosted

bkhouri · 2025-09-10T17:45:48Z

@swift-ci test self hosted

dschaefer2 · 2025-09-12T14:12:53Z

Package.swift

        .target(
            name: "SwiftBuildSupport",
            dependencies: [
+                "Build",


Just taking a quick look, and I see it's still in draft. The "Build" target is the native build system. We shouldn't have SwiftBuildSupport depending on it since it'll be removed eventually. Common things should go in SPMBuildCore.

Snippets are treated as executable targets with the native build system. This change updates the PIF Builder to support snippet, giving Snippet support with the Swift Build build system. Also update the `testCommandPluginCancellation` in PluginTests as it was not properly handling the task cancellations. Depends on: swiftlang/swift-build#775 Fixes: swiftlang#9040 issue: rdar://158630024 issue: rdar://147705448

bkhouri · 2025-09-15T15:05:47Z

@swift-ci test

bkhouri · 2025-09-15T15:26:47Z

@swift-ci test windows

bkhouri requested review from bripeticca, cmcgee1024, daveyc123, dschaefer2, jakepetroules, owenv, plemarquand and shawnhyam as code owners September 4, 2025 17:32

bkhouri marked this pull request as draft September 4, 2025 17:34

bkhouri marked this pull request as ready for review September 4, 2025 18:39

bkhouri force-pushed the t/main/gh9040_snippets branch from 02f2f9f to 4431162 Compare September 8, 2025 17:07

owenv requested changes Sep 8, 2025

View reviewed changes

bkhouri force-pushed the t/main/gh9040_snippets branch from 4431162 to 6eb953c Compare September 8, 2025 22:23

bkhouri self-assigned this Sep 9, 2025

bkhouri added swift build Changes impacting `swift build` swiftbuild backend labels Sep 9, 2025

bkhouri force-pushed the t/main/gh9040_snippets branch from 6eb953c to ecaddca Compare September 9, 2025 13:14

bkhouri marked this pull request as draft September 9, 2025 13:14

bkhouri force-pushed the t/main/gh9040_snippets branch from ecaddca to ad15784 Compare September 9, 2025 18:45

owenv approved these changes Sep 9, 2025

View reviewed changes

bkhouri force-pushed the t/main/gh9040_snippets branch from ad15784 to f944f47 Compare September 9, 2025 18:59

dschaefer2 reviewed Sep 12, 2025

View reviewed changes

bkhouri force-pushed the t/main/gh9040_snippets branch from f944f47 to 8533c40 Compare September 15, 2025 15:05

bkhouri marked this pull request as ready for review September 15, 2025 19:16

bkhouri enabled auto-merge (squash) September 15, 2025 19:16

bkhouri merged commit a9e72ad into swiftlang:main Sep 15, 2025
6 checks passed

Add Snippet support with SwiftBuild #9089

Add Snippet support with SwiftBuild #9089

Uh oh!

Conversation

bkhouri commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bkhouri commented Sep 4, 2025

Uh oh!

owenv commented Sep 4, 2025

Uh oh!

bkhouri commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bkhouri commented Sep 8, 2025

Uh oh!

bkhouri commented Sep 8, 2025

Uh oh!

bkhouri commented Sep 8, 2025

Uh oh!

owenv left a comment

Choose a reason for hiding this comment

Uh oh!

bkhouri commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bkhouri commented Sep 8, 2025

Uh oh!

bkhouri commented Sep 8, 2025

Uh oh!

bkhouri commented Sep 9, 2025

Uh oh!

bkhouri commented Sep 9, 2025

Uh oh!

bkhouri commented Sep 9, 2025

Uh oh!

bkhouri commented Sep 10, 2025

Uh oh!

dschaefer2 Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

bkhouri commented Sep 15, 2025

Uh oh!

bkhouri commented Sep 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bkhouri commented Sep 4, 2025 •

edited

Loading

bkhouri commented Sep 8, 2025 •

edited

Loading

bkhouri commented Sep 8, 2025 •

edited

Loading