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

Standardize repo name to erb_lint #360

Merged
merged 10 commits into from
Sep 6, 2024
Merged

Standardize repo name to erb_lint #360

merged 10 commits into from
Sep 6, 2024

Conversation

george-ma
Copy link
Contributor

Context

Someone pointed out that the erb_lint gem has inconsistent naming.

  • The repo is named erb-lint https://github.com/Shopify/erb-lint
  • The gem in RubyGems is named erb_lint
  • The config file that gets created is .erb-lint.yml
  • The executable for the gem is 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 of erb_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 of erb_lint. We're choosing erb_lint as its the gem name (.gemspec) which is the hardest to change

Proposed Changes

Note: I did not change the name defined in dev.yml to erb_lint because of:
image

Next steps:

exe/erblint Outdated Show resolved Hide resolved
lib/erb_lint/cli.rb Outdated Show resolved Hide resolved
Copy link
Contributor

@jenshenny jenshenny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks George!

README.md Show resolved Hide resolved
lib/erb_lint/cli.rb Show resolved Hide resolved
exe/erblint Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
exe/erblint Show resolved Hide resolved
exe/erblint Outdated Show resolved Hide resolved
spec/erb_lint/cli_spec.rb Outdated Show resolved Hide resolved
Copy link
Contributor

@jenshenny jenshenny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I added a deprecator for .erb-linters.

I also tophatted all of the deprecations and works as expected.
Screenshot 2024-08-13 at 12 32 44 PM
Screenshot 2024-08-13 at 12 34 16 PM

Screenshot 2024-08-13 at 12 33 34 PM

I'll reorganize the commits before this is merged.

@andyw8 andyw8 removed their request for review August 20, 2024 12:58
@george-ma george-ma merged commit c502d90 into main Sep 6, 2024
11 checks passed
@george-ma george-ma deleted the gm/make-name-consistent branch September 6, 2024 01:15
@runephilosof-abtion
Copy link

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.

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

Successfully merging this pull request may close these issues.

5 participants