From dda690b080942ef0f8cfd7701838970fa2044768 Mon Sep 17 00:00:00 2001
From: Francis <francisfuzz@github.com>
Date: Wed, 12 Oct 2022 14:48:55 -0700
Subject: [PATCH 1/9] docs(README.md): include HardCodedString linter

---
 README.md | 42 ++++++++++++++++++++++--------------------
 1 file changed, 22 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 6c026dba..d78260ae 100644
--- a/README.md
+++ b/README.md
@@ -90,26 +90,28 @@ linters:
 
 ## Linters
 
-| Available Linters                                | Default  | Description |
-| ------------------------------------------------ |:--------:|-------------|
-| [AllowedScriptType](#AllowedScriptType)          | Yes      | prevents the addition of `<script>` tags that have `type` attributes that are not in a white-list of allowed values |
-| ClosingErbTagIndent                              | Yes      |             |
-| ExtraNewline                                     | Yes      |             |
-| [FinalNewline](#FinalNewline)                    | Yes      | warns about missing newline at the end of a ERB template |
-| [NoJavascriptTagHelper](#NoJavascriptTagHelper)  | Yes      | prevents the usage of Rails' `javascript_tag` |
-| ParserErrors                                     | Yes      |             |
-| PartialInstanceVariable                          | No       | detects instance variables in partials |
-| [RequireInputAutocomplete](#RequireInputAutocomplete)        | Yes       | warns about missing autocomplete attributes in input tags |
-| [RightTrim](#RightTrim)                          | Yes      | enforces trimming at the right of an ERB tag |
-| [SelfClosingTag](#SelfClosingTag)                | Yes      | enforces self closing tag styles for void elements |
-| [SpaceAroundErbTag](#SpaceAroundErbTag)          | Yes      | enforces a single space after `<%` and before `%>`|
-| SpaceIndentation                                 | Yes      |             |
-| SpaceInHtmlTag                                   | Yes      |             |
-| TrailingWhitespace                               | Yes      |             |
-| [DeprecatedClasses](#DeprecatedClasses)          | No       | warns about deprecated css classes |
-| [ErbSafety](#ErbSafety)                          | No       | detects unsafe interpolation of ruby data into various javascript contexts and enforce usage of safe helpers like `.to_json`. |
-| [Rubocop](#Rubocop)                              | No       | runs RuboCop rules on ruby statements found in ERB templates |
-| [RequireScriptNonce](#RequireScriptNonce)        | No       | warns about missing [Content Security Policy nonces](https://guides.rubyonrails.org/security.html#content-security-policy) in script tags |
+| Available Linters                                     | Default | Description                                                                                                                               |
+|-------------------------------------------------------|:-------:|-------------------------------------------------------------------------------------------------------------------------------------------|
+| [AllowedScriptType](#AllowedScriptType)               | Yes     | prevents the addition of `<script>` tags that have `type` attributes that are not in a white-list of allowed values                       |
+| ClosingErbTagIndent                                   | Yes     |                                                                                                                                           |
+| ExtraNewline                                          | Yes     |                                                                                                                                           |
+| [FinalNewline](#FinalNewline)                         | Yes     | warns about missing newline at the end of a ERB template                                                                                  |
+| [NoJavascriptTagHelper](#NoJavascriptTagHelper)       | Yes     | prevents the usage of Rails' `javascript_tag`                                                                                             |
+| ParserErrors                                          | Yes     |                                                                                                                                           |
+| PartialInstanceVariable                               | No      | detects instance variables in partials                                                                                                    |
+| [RequireInputAutocomplete](#RequireInputAutocomplete) | Yes     | warns about missing autocomplete attributes in input tags                                                                                 |
+| [RightTrim](#RightTrim)                               | Yes     | enforces trimming at the right of an ERB tag                                                                                              |
+| [SelfClosingTag](#SelfClosingTag)                     | Yes     | enforces self closing tag styles for void elements                                                                                        |
+| [SpaceAroundErbTag](#SpaceAroundErbTag)               | Yes     | enforces a single space after `<%` and before `%>`                                                                                        |
+| SpaceIndentation                                      | Yes     |                                                                                                                                           |
+| SpaceInHtmlTag                                        | Yes     |                                                                                                                                           |
+| TrailingWhitespace                                    | Yes     |                                                                                                                                           |
+| [DeprecatedClasses](#DeprecatedClasses)               | No      | warns about deprecated css classes                                                                                                        |
+| [ErbSafety](#ErbSafety)                               | No      | detects unsafe interpolation of ruby data into various javascript contexts and enforce usage of safe helpers like `.to_json`.             |
+| [Rubocop](#Rubocop)                                   | No      | runs RuboCop rules on ruby statements found in ERB templates                                                                              |
+| [RequireScriptNonce](#RequireScriptNonce)             | No      | warns about missing [Content Security Policy nonces](https://guides.rubyonrails.org/security.html#content-security-policy) in script tags |
+| HardCodedString                                       | No      | warns if there is a visible hardcoded string in the DOM (does not check for a hardcoded string nested inside a JavaScript tag)            |
+
 
 ### DeprecatedClasses
 

From 1607aacc17af818f9e34335ec0871a859869aded Mon Sep 17 00:00:00 2001
From: Francis <15894826+francisfuzz@users.noreply.github.com>
Date: Mon, 17 Oct 2022 22:51:18 +0000
Subject: [PATCH 2/9] docs: add HardCodedString usage + opts

---
 README.md | 44 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 43 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d78260ae..64978743 100644
--- a/README.md
+++ b/README.md
@@ -110,7 +110,7 @@ linters:
 | [ErbSafety](#ErbSafety)                               | No      | detects unsafe interpolation of ruby data into various javascript contexts and enforce usage of safe helpers like `.to_json`.             |
 | [Rubocop](#Rubocop)                                   | No      | runs RuboCop rules on ruby statements found in ERB templates                                                                              |
 | [RequireScriptNonce](#RequireScriptNonce)             | No      | warns about missing [Content Security Policy nonces](https://guides.rubyonrails.org/security.html#content-security-policy) in script tags |
-| HardCodedString                                       | No      | warns if there is a visible hardcoded string in the DOM (does not check for a hardcoded string nested inside a JavaScript tag)            |
+| [HardCodedString](#HardCodedString)                                       | No      | warns if there is a visible hardcoded string in the DOM (does not check for a hardcoded string nested inside a JavaScript tag)            |
 
 
 ### DeprecatedClasses
@@ -489,6 +489,48 @@ Linter-Specific Option    | Description
 `allow_blank`             | True or false, depending on whether or not the `type` attribute may be omitted entirely from a `<script>` tag. Defaults to `true`.
 `disallow_inline_scripts` | Do not allow inline `<script>` tags anywhere in ERB templates. Defaults to `false`.
 
+### HardCodedString
+
+`HardCodedStrings` warns if there is a visible hardcoded string in the DOM. It does not check for a hardcoded string nested inside a JavaScript tag.
+
+Example configuration:
+
+```yaml
+---
+linters:
+  HardCodedString
+    enabled: true
+    corrector:
+      path: path/to/corrector_file.rb
+      name: I18nCorrector
+      i18n_load_path: path/to/translator_file.rb
+```
+
+This linter requires a `corrector` option. Without a `corrector` option, the strings won't be translated.
+c
+Linter-Specific Option    | Description
+--------------------------|---------------------------------------------------------
+path | a string pointing to the path to the corrector file
+name | the name of the corrector class (can [either be `I18nCorrector` or `Rubocop::I18nCorrector`](https://github.com/Shopify/erb-lint/blob/19c9ddb94f0ea1d73ac12e18a7ea822d76adeeab/lib/erb_lint/linters/hard_coded_string.rb#L17))
+i18n_load_path | a string pointing to the path of the file(s) to be translated
+
+Below is an example corrector file. For your project, the actual details of the `autocorrect` method are left up to how you want to correct those offenses.
+
+```ruby
+class I18nCorrector
+  attr_reader :node
+
+  def initialize(node, filename, i18n_load_path, range)
+  end
+
+  def autocorrect(tag_start:, tag_end:)
+    ->(corrector) do
+      node
+    end
+  end
+end
+```
+
 ## Custom Linters
 
 `erb-lint` allows you to create custom linters specific to your project. It will load linters from the `.erb-linters` directory in the root of your

From 5d8db92f3ef0c8130906b33f9ae148e1c59a9f0e Mon Sep 17 00:00:00 2001
From: francisfuzz <15894826+francisfuzz@users.noreply.github.com>
Date: Fri, 9 Jun 2023 09:36:26 -0700
Subject: [PATCH 3/9] Update README.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Étienne Barrié <etienne.barrie@gmail.com>
---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 64978743..48a87672 100644
--- a/README.md
+++ b/README.md
@@ -110,7 +110,7 @@ linters:
 | [ErbSafety](#ErbSafety)                               | No      | detects unsafe interpolation of ruby data into various javascript contexts and enforce usage of safe helpers like `.to_json`.             |
 | [Rubocop](#Rubocop)                                   | No      | runs RuboCop rules on ruby statements found in ERB templates                                                                              |
 | [RequireScriptNonce](#RequireScriptNonce)             | No      | warns about missing [Content Security Policy nonces](https://guides.rubyonrails.org/security.html#content-security-policy) in script tags |
-| [HardCodedString](#HardCodedString)                                       | No      | warns if there is a visible hardcoded string in the DOM (does not check for a hardcoded string nested inside a JavaScript tag)            |
+| [HardCodedString](#HardCodedString)                   | No      | warns if there is a visible hardcoded string in the DOM (does not check for a hardcoded string nested inside a JavaScript tag)               |
 
 
 ### DeprecatedClasses

From 19539fc4e9b227874fba72058111237dbcb6533e Mon Sep 17 00:00:00 2001
From: francisfuzz <15894826+francisfuzz@users.noreply.github.com>
Date: Fri, 9 Jun 2023 09:36:33 -0700
Subject: [PATCH 4/9] Update README.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Étienne Barrié <etienne.barrie@gmail.com>
---
 README.md | 1 -
 1 file changed, 1 deletion(-)

diff --git a/README.md b/README.md
index 48a87672..0d3f0757 100644
--- a/README.md
+++ b/README.md
@@ -507,7 +507,6 @@ linters:
 ```
 
 This linter requires a `corrector` option. Without a `corrector` option, the strings won't be translated.
-c
 Linter-Specific Option    | Description
 --------------------------|---------------------------------------------------------
 path | a string pointing to the path to the corrector file

From e3a46bb8165e40ac7867347cfac3dbfbc538d5f9 Mon Sep 17 00:00:00 2001
From: francisfuzz <15894826+francisfuzz@users.noreply.github.com>
Date: Fri, 9 Jun 2023 09:39:51 -0700
Subject: [PATCH 5/9] fix: add missing colon

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1aa52c14..97c550e7 100644
--- a/README.md
+++ b/README.md
@@ -511,7 +511,7 @@ Example configuration:
 ```yaml
 ---
 linters:
-  HardCodedString
+  HardCodedString:
     enabled: true
     corrector:
       path: path/to/corrector_file.rb

From 8b3893bc805f8188507ab511f01b2c4b909f5c72 Mon Sep 17 00:00:00 2001
From: francisfuzz <15894826+francisfuzz@users.noreply.github.com>
Date: Fri, 9 Jun 2023 09:42:05 -0700
Subject: [PATCH 6/9] fix: remove extra `s`

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 97c550e7..9d341ee0 100644
--- a/README.md
+++ b/README.md
@@ -504,7 +504,7 @@ Linter-Specific Option    | Description
 
 ### HardCodedString
 
-`HardCodedStrings` warns if there is a visible hardcoded string in the DOM. It does not check for a hardcoded string nested inside a JavaScript tag.
+`HardCodedString` warns if there is a visible hardcoded string in the DOM. It does not check for a hardcoded string nested inside a JavaScript tag.
 
 Example configuration:
 

From af48e1970d1559a4a247f87af931637018612273 Mon Sep 17 00:00:00 2001
From: francisfuzz <15894826+francisfuzz@users.noreply.github.com>
Date: Wed, 27 Mar 2024 16:11:17 -0700
Subject: [PATCH 7/9] docs: update yaml example and autocorrect detail

---
 README.md | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 43e7d05c..6eed1f37 100644
--- a/README.md
+++ b/README.md
@@ -516,10 +516,11 @@ linters:
     corrector:
       path: path/to/corrector_file.rb
       name: I18nCorrector
-      i18n_load_path: path/to/translator_file.rb
+      i18n_load_path: config/locales/en.yml
 ```
 
-This linter requires a `corrector` option. Without a `corrector` option, the strings won't be translated.
+To leverage this linter's autocorrect feature, you must define the configuration for its `corrector`, such that its path, class name, and `i18n_load_path` are resolvable.
+
 Linter-Specific Option    | Description
 --------------------------|---------------------------------------------------------
 path | a string pointing to the path to the corrector file

From 0b55b86b59098a1c57a03bbf71861d2d8589dae8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89tienne=20Barri=C3=A9?= <etienne.barrie@shopify.com>
Date: Wed, 18 Sep 2024 14:44:11 +0200
Subject: [PATCH 8/9] Close fenced code block

---
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.md b/README.md
index 6eed1f37..287a30ed 100644
--- a/README.md
+++ b/README.md
@@ -542,6 +542,7 @@ class I18nCorrector
     end
   end
 end
+```
 
 ## CommentSyntax
 

From 9947ee8d228995a481df95854cb32dd3f99f071e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89tienne=20Barri=C3=A9?= <etienne.barrie@shopify.com>
Date: Wed, 18 Sep 2024 14:50:57 +0200
Subject: [PATCH 9/9] Fix anchor id

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 287a30ed..8aed7940 100644
--- a/README.md
+++ b/README.md
@@ -123,7 +123,7 @@ linters:
 | [ErbSafety](#erbsafety)                          | No       | detects unsafe interpolation of ruby data into various javascript contexts and enforce usage of safe helpers like `.to_json`. |
 | [Rubocop](#rubocop)                              | No       | runs RuboCop rules on ruby statements found in ERB templates |
 | [RequireScriptNonce](#requirescriptnonce)        | No       | warns about missing [Content Security Policy nonces](https://guides.rubyonrails.org/security.html#content-security-policy) in script tags |
-| [HardCodedString](#HardCodedString)              | No       | warns if there is a visible hardcoded string in the DOM (does not check for a hardcoded string nested inside a JavaScript tag)            |
+| [HardCodedString](#hardcodedstring)              | No       | warns if there is a visible hardcoded string in the DOM (does not check for a hardcoded string nested inside a JavaScript tag)            |
 
 ### DeprecatedClasses