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

Rename gem to yard_sorbet to match require path, gem naming guidelines #3

Closed
andrewhamon opened this issue Jan 19, 2020 · 3 comments
Closed

Comments

@andrewhamon
Copy link
Contributor

andrewhamon commented Jan 19, 2020

Currently, the gem is named yard-sorbet, but the require path is yard_sorbet. Gem naming guidlines recommend that multiword gem names be named using underscores, not hyphens.

You could perhaps instead rename the file paths to use hyphens, which would have the added bonus of making yard --plugin sorbet work correctly (currently it doesn't, because yard adds a hyphenated rather than underscored prefix), but would continue to violate naming best practices.

It's rather unfortunate that the yard plugin prefix encourages improperly named gems :/

@andrewhamon
Copy link
Contributor Author

I speculatively opened a PR that does the opposite of the title of this issue -- it renames files so that the require path matches the gem name (and matches the convention expected by yard). See #2

@dduugg
Copy link
Owner

dduugg commented Jan 21, 2020

Hi @andrewhamon, thanks for the PR. I agree the right approach is to standardize on the hyphenated name. Browsing the search results in RubyGems.org suggests this is the prevailing style.

@dduugg
Copy link
Owner

dduugg commented Jan 22, 2020

Resolved in #3

@dduugg dduugg closed this as completed Jan 22, 2020
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

2 participants