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.

Sign up for GitHub

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

Jump to bottom

Prefer Primer::Beta::Button in ERBLint::Linters::ButtonComponentMigrationCounter #1782

Merged
merged 3 commits into from
Jan 25, 2023
Merged

Prefer Primer::Beta::Button in ERBLint::Linters::ButtonComponentMigrationCounter #1782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f5fa8f
Replace deprecated Primer::ButtonComponent in linter
jdennes Jan 25, 2023
ebbd0de
Fix linter test
jdennes Jan 25, 2023
2b7cd6b
Add changeset
jdennes Jan 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fluffy-rivers-search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/view-components': patch
---

Prefer Primer::Beta::Button in ERBLint::Linters::ButtonComponentMigrationCounter
4 changes: 2 additions & 2 deletions lib/primer/view_components/linters/button_component_migration_counter.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ class ButtonComponentMigrationCounter < BaseLinter
# CloseButton component has preference when this class is seen in conjunction with `btn`.
DISALLOWED_CLASSES = %w[close-button].freeze
CLASSES = %w[btn btn-link].freeze
MESSAGE = "We are migrating buttons to use [Primer::ButtonComponent](https://primer.style/view-components/components/button), please try to use that instead of raw HTML."
MESSAGE = "We are migrating buttons to use [Primer::Beta::Button](https://primer.style/view-components/components/beta/button), please try to use that instead of raw HTML."
ARGUMENT_MAPPER = ArgumentMappers::Button
COMPONENT = "Primer::ButtonComponent"
COMPONENT = "Primer::Beta::Button"
end
end
end
20 changes: 10 additions & 10 deletions test/lib/erblint/button_component_migration_counter_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,28 @@ def test_suggests_how_to_use_the_component_with_arguments
@file = "<button class=\"btn btn-sm btn-primary\">Button</button>"
@linter.run(processed_source)

assert_includes(offenses.first.message, "render Primer::ButtonComponent.new(size: :small, scheme: :primary)")
assert_includes(offenses.first.message, "render Primer::Beta::Button.new(size: :small, scheme: :primary)")
end

def test_suggests_how_to_use_the_component_as_link
@file = "<button class=\"btn-link\">Button</button>"
@linter.run(processed_source)

assert_includes(offenses.first.message, "render Primer::ButtonComponent.new(scheme: :link)")
assert_includes(offenses.first.message, "render Primer::Beta::Button.new(scheme: :link)")
end

def test_suggest_when_button_is_disabled
@file = "<button class=\"btn\" disabled>Button</button>"
@linter.run(processed_source)

assert_includes(offenses.first.message, "render Primer::ButtonComponent.new(disabled: true)")
assert_includes(offenses.first.message, "render Primer::Beta::Button.new(disabled: true)")
end

def test_suggest_using_the_tag_system_argument
@file = "<a class=\"btn\">Button</a>"
@linter.run(processed_source)

assert_includes(offenses.first.message, "render Primer::ButtonComponent.new(tag: :a)")
assert_includes(offenses.first.message, "render Primer::Beta::Button.new(tag: :a)")
end

def test_autocorrects
Expand Down Expand Up @@ -74,19 +74,19 @@ def test_autocorrects

expected = <<~HTML
<%# erblint:counter ButtonComponentMigrationCounter 1 %>
<%= render Primer::ButtonComponent.new(scheme: :primary) do %>
<%= render Primer::Beta::Button.new(scheme: :primary) do %>
button 1
<button invalid-attr class="btn">
Can't be autocorrected
</button>
<%= render Primer::ButtonComponent.new(scheme: :danger) do %>
<%= render Primer::Beta::Button.new(scheme: :danger) do %>
button 2
<%= render Primer::ButtonComponent.new(scheme: :outline) do %>
<%= render Primer::Beta::Button.new(scheme: :outline) do %>
button 3
<a>not a button</a>
<%= render Primer::ButtonComponent.new(tag: :summary, size: :small) do %>
<%= render Primer::Beta::Button.new(tag: :summary, size: :small) do %>
summary
<%= render Primer::ButtonComponent.new(tag: :a, test_selector: "test selector") do %>
<%= render Primer::Beta::Button.new(tag: :a, test_selector: "test selector") do %>
a
<% end %>
<% end %>
Expand All @@ -107,7 +107,7 @@ def test_autocorrects_attributes
HTML

expected = <<~HTML
<%= render Primer::ButtonComponent.new(href: "href", value: "value", name: "name", tabindex: "tabindex") do %>
<%= render Primer::Beta::Button.new(href: "href", value: "value", name: "name", tabindex: "tabindex") do %>
button
<% end %>
HTML
Expand Down