This repository has been archived by the owner on Nov 30, 2022. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make require name match the gem name
In order to require this gem you currently must use `"yard_sorbet"` When you omit the yard prefix, yard automatically adds `yard-` to the beginning of the plugin name. Because the file naming in this gem, that means that the plugin will fail to load when running `yard doc --plugin sorbet` and instead only works correctly by using the underscored version of the gem name: `yard doc --plugin yard_sorbet`. By changing the file names to use hyphens, `--plugin sorbet` as well as `--plugin yard-sorbet` (i.e. the actual gem name) correctly work. n.b. this will break any existing usages of `--plugin yard_sorbet` Unfortunately, this is against the recommended gem naming guidelines at https://guides.rubygems.org/name-your-gem/ but ultimately I think this is the most user friendly option short of modifying yard to attempt both `yard-` and `yard_` prefixes.
- Loading branch information