From ab1f55dc4eb2d6ab2d58d27c3e37329025c0e6da Mon Sep 17 00:00:00 2001
From: francisfuzz <15894826+francisfuzz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 05:55:23 -0700
Subject: [PATCH] docs(README.md): Document HardCodedString linter (#278)

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

diff --git a/README.md b/README.md
index 16cc4f8..4ab7c0f 100644
--- a/README.md
+++ b/README.md
@@ -123,6 +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)            |
 
 ### DeprecatedClasses
 
@@ -500,6 +501,49 @@ 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
+
+`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:
+
+```yaml
+---
+linters:
+  HardCodedString:
+    enabled: true
+    corrector:
+      path: path/to/corrector_file.rb
+      name: I18nCorrector
+      i18n_load_path: config/locales/en.yml
+```
+
+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
+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
+```
+
 ## CommentSyntax
 
 This linter enforces the use of the correct ERB comment syntax, since Ruby comments (`<% # comment %>` with a space) are not technically valid ERB comments.