Closed george-ma closed 2 months ago
Please release a new version with this change, since the main
README now tells you to run erb_lint
while that has not been released.
Someone pointed out that the erb_lint gem has inconsistent naming.
That would be me in #322. Thanks for taking care of this!
Context
Someone pointed out that the
erb_lint
gem has inconsistent naming.erb-lint
https://github.com/Shopify/erb-linterb_lint
.erb-lint.yml
erblint
RubyGems will block anything less than 4 edits away to an existing gem over 10M downloads.
So even though this gem cannot be typosquatted due to RubyGems restrictions (eg. publishing a gem named
erb-lint
instead oferb_lint
), it'd be good to make changes to unify on a naming in the repo.What is this PR?
This PR aims to resolve the inconsistencies seen above and patches references to
erb-lint
in favor oferb_lint
. We're choosingerb_lint
as its the gem name (.gemspec
) which is the hardest to changeProposed Changes
.erb_lint.yml
or.erb-lint.yml
and warn that the latter will be going away soon and urge folks to rename their yaml file today. https://github.com/Shopify/erb-lint/blob/f82b3f7473dd1a0a966638c7f28b6ea213198b6a/lib/erb_lint/cli.rb#L16erb_lint
and whenerblint
is called, we could similarly warn about its usage and just call theerb_lint
one under the hood. https://github.com/Shopify/erb-lint/blob/main/exe/erblintNote: I did not change the name defined in
dev.yml
toerb_lint
because of:Next steps:
erb_lint
.