Skip to content
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

Package.swift: make package name consistent with repo name #6525

Closed
wants to merge 1 commit into from

Conversation

MaxDesiatov
Copy link
Contributor

Rest of SwiftPM packages provided by Apple follow a dash-case naming scheme consistent with repository name, usually with swift- prefix.

This shouldn't have any impact on SwiftPM clients, since this name argument of Package initializer is only used for display purposes and not for package resolution.

Rest of SwiftPM packages provided by Apple follow a dash-case naming scheme consistent with repository name, usually with `swift-` prefix.

This shouldn't have any impact on SwiftPM clients, since this `name` argument of `Package` initializer is only used for display purposes and not for package resolution.
@MaxDesiatov
Copy link
Contributor Author

@swift-ci smoke test

Copy link
Contributor

@neonichu neonichu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't follow the bad practice of the other Apple repos here. The recommended practice is naming both your package and your repository the same as your primary library product (in our case SwiftPM). Ideally, we would be able to rename the repository to a proper name, but just because that is out of the question shouldn't mean we go further down the bad path.

@tayloraswift
Copy link
Member

The recommended practice is naming both your package and your repository the same as your primary library product (in our case SwiftPM).

i’m not sure where you are getting this recommendation from (i don’t recall any package naming guidelines existing at all), but i maintain several packages that have more than one “primary” library product. at some point, we will need to decouple package names from repository names, if only to support more than one package per repository. but i don’t think naming packages after products generalizes.

@neonichu
Copy link
Contributor

neonichu commented May 9, 2023

but i maintain several packages that have more than one “primary” library product.

That's fine, I'm not saying that is the only way to name your package, but SwiftPM's package has its name for a reason.

@MaxDesiatov MaxDesiatov deleted the maxd/package-name branch July 26, 2023 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants