erblint-github 0.0.6 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 310138254b0989437e8cf803d52cba66ad005d7cae43b8b6233e638a20e40868
-  data.tar.gz: 654d731eb0c99317883327dd401726582d7df70995350d0006b365fe1b9670b6
+  metadata.gz: cfd39a72bcefe35b0231242045b4aca7cfdf6468b795d2703528655039b9e7be
+  data.tar.gz: 4331758cf201fe621f5510554766a6d300f46b43ef36d272e82f53d2ffaf420d
 SHA512:
-  metadata.gz: ce1a90a1c2482b29b406787a1c530614718242de1b9fac828617c2f476db00578872bcddf52037bf8195c71beb8750916e853b5127f4de036aea5771a8edbe2b
-  data.tar.gz: 2a1e8844fdae5d352a6798937629e4ae70bea7d3a16c00e1a6de363dcc805044164b55e5166d9ffaf6f288bbdb135c373c2f1b1b40d27ecb0705c2cb616a833c
+  metadata.gz: ea54a4d64005d7be039a3f9ed620447ca673db7113e821f303cce4c35da74835c6f124afa84f3b7e8eb35e2adb278394aef1f6326a10f73ebfb3a9a342c956a1
+  data.tar.gz: 942f3526203855f2a58c37f54b5d2775cc0de910a0adf057889dba2c4e60a1553276b640c7ba6c8fd6ed91d3b3af597ab86c0aa49e84f49ed47005feafcec59a

data/README.md

@@ -25,6 +25,8 @@ require "erblint-github/linters"
 linters:
   GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled:
     enabled: true
+  GitHub::Accessibility::AvoidGenericLinkTextCounter:
+    enabled: true
   GitHub::Accessibility::IframeHasTitle:
     enabled: true
   GitHub::Accessibility::ImageHasAlt:
@@ -56,3 +58,12 @@ linters:
 bundle install
 bundle exec rake
 ```
+
+## Recommended extension
+
+If you use VS Code, we highly encourage [ERB Linter extension](https://marketplace.visualstudio.com/items?itemName=manuelpuyol.erb-linter) to see immediate feedback in your editor.
+
+## Note
+
+This repo contains several accessibility-related linting rules to help surface accessibility issues that would otherwise go undetected until a later stage. Please note that due to the limitations of static code analysis,
+these ERB accessibility checks are NOT enough for ensuring the accessibility of your app. This shouldn't be the only tool you use to catch accessibility issues and should be supplemented with other tools that can check the runtime browser DOM output, as well as processes like accessibility design reviews, manual audits, user testing, etc.

data/lib/erblint-github/linters/github/accessibility/avoid_generic_link_text_counter.rb

@@ -18,6 +18,8 @@ module ERBLint
             "Link",
             "Here"
           ].freeze
+          ARIA_LABEL_ATTRIBUTES = %w[aria-labelledby aria-label].freeze
+
           MESSAGE = "Avoid using generic link text such as #{BANNED_GENERIC_TEXT.join(', ')} which do not make sense in isolation."
 
           def run(processed_source)
@@ -25,6 +27,7 @@ module ERBLint
               next unless node.methods.include?(:type) && node.type == :text
 
               text = node.children.join.strip
+
               # Checks HTML tags
               if banned_text?(text)
                 prev_node = processed_source.ast.children[index - 1]
@@ -36,8 +39,17 @@ module ERBLint
                 prev_node_tag = BetterHtml::Tree::Tag.from_node(prev_node)
                 next_node_tag = BetterHtml::Tree::Tag.from_node(next_node)
 
-                # We only report if the text is nested between two link tags.
+                aria_label = possible_attribute_values(prev_node_tag, "aria-label")
+                aria_labelledby = possible_attribute_values(prev_node_tag, "aria-labelledby")
+
+                # Checks if nested between two link tags.
                 if link_tag?(prev_node_tag) && link_tag?(next_node_tag) && next_node_tag.closing?
+                  # Skip because we cannot reliably check accessible name from aria-labelledby, or an aria-label that is set to a variable
+                  # with static code analysis.
+                  next if aria_labelledby.present? || (aria_label.present? && aria_label.join.include?("<%="))
+                  # Skip because aria-label starts with visible text which we allow. Related to Success Criterion 2.5.3: Label in Name
+                  next if aria_label.present? && valid_accessible_name?(aria_label.join, text)
+
                   range = prev_node_tag.loc.begin_pos...text_node_tag.loc.end_pos
                   source_range = processed_source.to_source_range(range)
                   generate_offense_from_source_range(self.class, source_range)
@@ -45,20 +57,40 @@ module ERBLint
               end
 
               # Checks Rails link helpers like `link_to`
-              erb_node = node.type == :erb ? node : node.descendants(:erb).first
-              next unless erb_node
-
-              _, _, code_node = *erb_node
-              source = code_node.loc.source
-              ruby_node = extract_ruby_node(source)
-              send_node = ruby_node&.descendants(:send)&.first
-              next unless send_node.methods.include?(:method_name) && send_node.method_name == :link_to
-
-              send_node.child_nodes.each do |child_node|
-                if child_node.methods.include?(:type) && child_node.type == :str && banned_text?(child_node.children.join)
+              node.descendants(:erb).each do |erb_node|
+                _, _, code_node = *erb_node
+                source = code_node.loc.source
+                ruby_node = extract_ruby_node(source)
+                send_node = ruby_node&.descendants(:send)&.first
+                next unless send_node.methods.include?(:method_name) && send_node.method_name == :link_to
+
+                banned_text = nil
+
+                send_node.child_nodes.each do |child_node|
+                  banned_text = child_node.children.join if child_node.methods.include?(:type) && child_node.type == :str && banned_text?(child_node.children.join)
+                  next if banned_text.blank?
+                  next unless child_node.methods.include?(:type) && child_node.type == :hash
+
+                  child_node.descendants(:pair).each do |pair_node|
+                    next unless pair_node.children.first.type?(:sym)
+
+                    # Skips if `link_to` has `aria-labelledby` or `aria-label` which cannot be evaluated accurately with ERB lint alone.
+                    # ERB lint removes Ruby string interpolation so the `aria-label` for "<%= link_to 'Learn more', "aria-label": "Learn #{@some_variable}" %>" will
+                    # only be `Learn` which is unreliable so we can't do checks :(
+                    key_value = pair_node.children.first.children.join
+                    banned_text = nil if ARIA_LABEL_ATTRIBUTES.include?(key_value)
+                    next unless key_value == "aria"
+
+                    pair_node.children[1].descendants(:sym).each do |sym_node|
+                      banned_text = nil if sym_node.children.join == "label" || sym_node.children.join == "labelledby"
+                    end
+                  end
+                end
+                if banned_text.present?
                   tag = BetterHtml::Tree::Tag.from_node(code_node)
                   generate_offense(self.class, processed_source, tag)
-                  end
+                end
+                banned_text = nil
               end
             end
             counter_correct?(processed_source)
@@ -80,8 +112,17 @@ module ERBLint
 
           private
 
+          # Downcase and strip punctuation and extra whitespaces.
+          def stripped_text(text)
+            text.downcase.gsub(/\W+/, " ").strip
+          end
+
           def banned_text?(text)
-            BANNED_GENERIC_TEXT.map(&:downcase).include?(text.downcase)
+            BANNED_GENERIC_TEXT.map(&:downcase).include?(stripped_text(text))
+          end
+
+          def valid_accessible_name?(aria_label, text)
+            stripped_text(aria_label).include?(stripped_text(text))
           end
 
           def extract_ruby_node(source)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erblint-github
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.9
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint