Allow creation of non-existent directory during swift package init
#8401
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
Running `swift package init --package-path <dir-does-not-exists>` results in an error when SPM attempts to change directories in to the directory that doesn't exist. Add a new boolean to the `_SwiftCommand` protocol that lets commands opt in to creating the directory at `--package-path` if it doesn't exist. Opt in `InitCommand` to this behaviour. Issue: swiftlang#8393
plemarquand
requested review from
bnbarham,
MaxDesiatov,
jakepetroules,
xedin,
dschaefer2,
shawnhyam,
bripeticca,
owenv,
bkhouri,
cmcgee1024 and
daveyc123
as code owners
plemarquand
changed the title
swift package initswift package init
bkhouri
approved these changes
Mar 21, 2025
There was a problem hiding this comment.
Looks good to me, though I would not close #8393 as one of the expected behaviours is not currently implemented.
swift package init --package-path <dir> should:
- create the directory, and populate the package if it does not exists
- should populate the package if the directory exists and is empty
- prompt the user for action if the directory exists and is non-empty
- should error if
<dir>exists as a file
|
@swift-ci test |
jakepetroules
approved these changes
Mar 21, 2025
cmcgee1024
approved these changes
Mar 21, 2025
|
@swift-ci test |
|
@swift-ci test linux |
dschaefer2
approved these changes
Mar 24, 2025
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Running
swift package init --package-path <dir-does-not-exists>results in an error when SwiftPM attempts to change directories in to the directory that doesn't exist.Motivation:
It is rare that a user wants to do a
swift package initin a folder that already has content. A typical pattern is tomkdir mypackage && cd my package && swift package init. SwiftPM already has a--package-pathflag indicating the package folder that the command should operate on, but attempting to use this to create a folder that doesn't exist duringswift package initresults in an error when SwiftPM attempts to chdir to the --package-path that doesn't exist.Modifications:
Add a new boolean to the
_SwiftCommandprotocol that lets commands opt in to creating the directory at--package-pathif it doesn't exist. Opt inInitCommandto this behaviour.Result:
swift package init --package-path ./mypackagesuccessfully initializes a package in./mypackage, even if./mypackagedoesn't exist.Issue: #8393