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

Use kabob case for repo name #50

Open
beauremus opened this issue May 26, 2023 · 9 comments
Open

Use kabob case for repo name #50

beauremus opened this issue May 26, 2023 · 9 comments

Comments

@beauremus
Copy link
Member

For consistency, we should use kabob case for the repo name. I think all our other repos are kabob case and it's the default for GitHub.

@beauremus
Copy link
Member Author

By kabob case, I mean to use hyphens between words. parameter-page-app rather than snake case with underscores parameter_page_app.

@cnlklink
Copy link
Contributor

Will this conflict with the requirement Flutter has that the working directory use underscores instead of hyphens? I think that's why @rneswold chose this name.

@rneswold
Copy link
Contributor

Good question. @beauremus is only suggesting renaming the repo name, though.

@beauremus
Copy link
Member Author

Do you have documentation on the working directory requirement? I can't seem to find it.
A workaround is that git allows you to name your directory anything you want.

@cnlklink
Copy link
Contributor

Sorry, it's a Dart package name requirement not a Flutter requirement. Although, if you do flutter create new-flutter-project you'll get an error:

PS C:\Users\jdiamond\Desktop\Workspace> flutter create new-flutter-project
"new-flutter-project" is not a valid Dart package name.

See https://dart.dev/tools/pub/pubspec#name for more information.

This is an annoying inconsistency.

@cnlklink
Copy link
Contributor

What we could do is make the repo parameter-page and inside the repo a directory parameter_page_app?

@beauremus
Copy link
Member Author

I found suggestions to use flutter create like this flutter create --project-name=t_t t-t.

In my experience, tools like flutter create munge this for you automatically. So, if everyone else is comfortable recommending flutter create --project-name=parameter_page parameter-page then that seems like the solution to me.

@beauremus
Copy link
Member Author

Can we assume this restriction is to avoid parsing ambiguous minus signs? Otherwise, this seems needlessly restrictive. Also, I'm pretty sure other languages get around this...

@cnlklink
Copy link
Contributor

I think what they're trying to achieve consistency in naming too (on pub.dev) - it's just opposite of our convention!

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

No branches or pull requests

3 participants