Rename .erb-linters folder to .erb_linters (#3521)

Copilot · jonrohan · web-flow · commit 72a68d7832a0 · 2025-06-10T13:07:49.000-07:00
Co-authored-by: copilot-swe-agent[bot] &lt;198982749+Copilot@users.noreply.github.com&gt;
Co-authored-by: Jon Rohan &lt;rohan@github.com&gt;
Co-authored-by: jonrohan &lt;54012+jonrohan@users.noreply.github.com&gt;
diff --git a/.changeset/happy-garlics-train.md b/.changeset/happy-garlics-train.md
@@ -0,0 +1,5 @@
+---
+"@primer/view-components": patch
+---
+
+Rename .erb-linters folder to .erb_linters
diff --git a/.erb_lint.yml b/.erb_lint.yml
diff --git a/.erb_linters/erblint-github.rb b/.erb_linters/erblint-github.rb
diff --git a/.erb_linters/linters.rb b/.erb_linters/linters.rb
diff --git a/.erb_linters/reporters/github_reporter.rb b/.erb_linters/reporters/github_reporter.rb
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -127,7 +127,7 @@
       "label": "erblint: autofix erblint errors",
       "type": "shell",
       "group": "build",
-      "command": "bundle exec erblint -a app/components",
+      "command": "bundle exec erb_lint -a app/components",
       "presentation": {
         "reveal": "always",
         "panel": "dedicated"
diff --git a/docs/contributors/deprecations.md b/docs/contributors/deprecations.md
@@ -47,7 +47,7 @@ options.
   * Optional
   * Type: boolean
   * Default: false
-  * Whether or not this deprecations can be autocorrected with `erblint -a`
+  * Whether or not this deprecations can be autocorrected with `erb_lint -a`
 
 * replacement:
   * Optional
diff --git a/docs/contributors/linting.md b/docs/contributors/linting.md
@@ -24,21 +24,21 @@ Primer/NoTagMemoize:
 
 ### erb-lint
 
-To get access to our ERB linters, create a `.erb-linters/primer.rb` file with:
+To get access to our ERB linters, create a `.erb_linters/primer.rb` file with:
 
 ```rb
 require "primer/view_components/linters"
 ```
 
-Then, you can enable them in `.erb-lint.yml`. E.g.:
+Then, you can enable them in `.erb_lint.yml`. E.g.:
 
 ```yml
 linters:
   ButtonComponentMigrationCounter:
     enabled: true
 ```
 
-If you also want to add our cops when linting ERB, you can modify your `.erb-lint.yml` to have:
+If you also want to add our cops when linting ERB, you can modify your `.erb_lint.yml` to have:
 
 ```yml
 linters:
diff --git a/docs/contributors/updating-components.md b/docs/contributors/updating-components.md
@@ -24,10 +24,10 @@ If the change requires a lot of updates or you’re unsure of the consequences o
    To use your linter run:
 
    ```bash
-   bin/bundle exec erblint --enable-linters LinterName -a app/views app/components app/packages
+   bin/bundle exec erb_lint --enable-linters LinterName -a app/views app/components app/packages
    ```
 
-   You can also enable your linter globally by adding it to [`.erb-lint.yml`](https://github.com/github/github/blob/master/.erb-lint.yml).
+   You can also enable your linter globally by adding it to [`.erb_lint.yml`](https://github.com/github/github/blob/master/.erb_lint.yml).
 
    If the migrations result in a lot of changes it’s best to split them up into multiple pull requests. [Here’s an example script for drafting pull requests by codeowners](https://github.com/primer/view_components/pull/972#discussion_r784217378).
 
diff --git a/lib/primer/view_components/linters/autocorrectable.rb b/lib/primer/view_components/linters/autocorrectable.rb
@@ -25,7 +25,7 @@ def correction(args)
       def message(args, processed_source)
         return self.class::MESSAGE if args.nil?
 
-        "#{self.class::MESSAGE}\nTry using:\n\n#{correction(args)}\n\nYou can also run erblint in autocorrect mode:\n\nbundle exec erblint -a #{processed_source.filename}\n"
+        "#{self.class::MESSAGE}\nTry using:\n\n#{correction(args)}\n\nYou can also run erb_lint in autocorrect mode:\n\nbundle exec erb_lint -a #{processed_source.filename}\n"
       end
     end
   end
diff --git a/script/erblint b/script/erblint
@@ -1,6 +1,6 @@
 #! /bin/bash
 
-bundle exec erblint \
+bundle exec erb_lint \
     app/**/*.html.erb \
     lib/**/*.html.erb \
     previews/**/*.html.erb \
diff --git a/test/lib/erblint/linter_config_works_test.rb b/test/lib/erblint/linter_config_works_test.rb
@@ -6,7 +6,7 @@ class LinterConfigWorksTest < ErblintTestCase
   # The ability to share rules and configs from other gems in erb_lint is not well-documented.
   # This test validates that our recommended setup works.
   def test_asserts_recommended_setup_works
-    erb_lint_config = ERBLint::RunnerConfig.new(file_loader.yaml(".erb-lint.yml"), file_loader)
+    erb_lint_config = ERBLint::RunnerConfig.new(file_loader.yaml(".erb_lint.yml"), file_loader)
 
     rules_enabled_in_accessibility_config = 0
     erb_lint_config.to_hash["linters"].each do |linter|

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@primer/view-components": patch
 +---
++
 +Rename .erb-linters folder to .erb_linters