You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 :/
The text was updated successfully, but these errors were encountered:
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
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.
Currently, the gem is named
yard-sorbet
, but the require path isyard_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 :/
The text was updated successfully, but these errors were encountered: