Move files when using package add-target on single target package
#8413
+261
−1
Conversation
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
Currently `swift package init --type executable` in a folder called `Example` creates a project with the following structure: ``` ./Example/Sources ./Example/Sources/main.swift ./Example/Package.swift ``` Following this up with a `swift package add-target Foo` produces a package that no longer builds. It now has the structure: ``` ./Example/Sources ./Example/Sources/main.swift ./Example/Sources/Foo/Foo.swift ./Example/Package.swift ``` Packages with multiple targets cannot have code directly in `./Sources`, and the user gets the error: `Source files for target Example should be located under 'Sources/Example'` To work around this in the AddTarget command we can check if a package is structured as a single target package with sources directly in `./Sources` and move these files into a new folder located at `./Sources/Example`. This allows the project to build after the new target has been added. Issue: swiftlang#8410
plemarquand
requested review from
bnbarham,
MaxDesiatov,
jakepetroules,
xedin,
dschaefer2,
shawnhyam,
bripeticca,
owenv,
bkhouri,
cmcgee1024 and
daveyc123
as code owners
MaxDesiatov
reviewed
Mar 26, 2025
MaxDesiatov
reviewed
Mar 26, 2025
Co-authored-by: Max Desiatov <[email protected]>
Co-authored-by: Max Desiatov <[email protected]>
|
@swift-ci please test |
MaxDesiatov
approved these changes
Mar 26, 2025
|
@swift-ci please test windows |
bripeticca
approved these changes
Mar 26, 2025
bkhouri
reviewed
Mar 26, 2025
| } | ||
| } | ||
|
|
||
| func testAddTargetWithoutManifestThrows() async throws { |
There was a problem hiding this comment.
suggestion (possibly-blocking): Although the current tests are great in validating the file system structure, can we add a test that validate the Package can still be built, and maybe even ensure the tests pass, if we run swift package add-target foo on an package containing a single source?
bkhouri
reviewed
Mar 26, 2025
| // Check if the package has a single target with that target's sources located | ||
| // directly in `./Sources`. If so, move the sources into a folder named after | ||
| // the target before adding a new target. | ||
| package static func moveSingleTargetSources( |
There was a problem hiding this comment.
suggestion (possibly-blocking): can we write automated test that validate this function in isolation, where we can test various code paths?
There was a problem hiding this comment.
I've added some unit tests to cover off this function
cmcgee1024
approved these changes
Mar 27, 2025
|
@swift-ci test |
|
@swift-ci please test windows |
|
@swift-ci please test self hosted windows |
|
@swift-ci test windows |
dschaefer2
approved these changes
Mar 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation:
Currently running
swift package init --type executablein a folder calledExamplecreates a project with the following structure:Following this up with a
swift package add-target Fooproduces a package that no longer builds. It now has the structure:Packages with multiple targets cannot have code directly in
./Sources, and the user gets the error:Source files for target Example should be located under 'Sources/Example'Modifications:
To work around this in the AddTarget command we can check if a package is structured as a single target package with sources directly in
./Sourcesand move these files into a new folder located at./Sources/Example.Result:
This allows the project to build after the new target has been added.
Issue: #8410