erblint-github 0.0.9 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfd39a72bcefe35b0231242045b4aca7cfdf6468b795d2703528655039b9e7be
-  data.tar.gz: 4331758cf201fe621f5510554766a6d300f46b43ef36d272e82f53d2ffaf420d
+  metadata.gz: c3e42bd7e46e4628deda31d1657890c3ccc9e683d85943f2540629d36962b114
+  data.tar.gz: '099d8957fbc44e9739296d60c6f4436d7cf96ad0731bf69aca6edd5663acf98f'
 SHA512:
-  metadata.gz: ea54a4d64005d7be039a3f9ed620447ca673db7113e821f303cce4c35da74835c6f124afa84f3b7e8eb35e2adb278394aef1f6326a10f73ebfb3a9a342c956a1
-  data.tar.gz: 942f3526203855f2a58c37f54b5d2775cc0de910a0adf057889dba2c4e60a1553276b640c7ba6c8fd6ed91d3b3af597ab86c0aa49e84f49ed47005feafcec59a
+  metadata.gz: e41f3c103e9b0c57cd9706706605d26e25aafdae1359d0d123d6dd05b32904a91e0609fcf42d0551bf871d904610c2e38b65e47b2cb10637424426714902394c
+  data.tar.gz: 6969aff49edec2d4f9d6768eb94d20c5ffc24b01495ea9ad68d134900a1351b7c7a5afcb5896c6b14da3212e36c1bf29c1a308c8fd5215a4bb055e9d303cdcc2

data/README.md

@@ -23,34 +23,77 @@ require "erblint-github/linters"
 ```yaml 
 ---
 linters:
-  GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled:
+  GitHub::Accessibility::AvoidBothDisabledAndAriaDisabledCounter:
     enabled: true
   GitHub::Accessibility::AvoidGenericLinkTextCounter:
     enabled: true
-  GitHub::Accessibility::IframeHasTitle:
+  GitHub::Accessibility::DisabledAttributeCounter:
     enabled: true
-  GitHub::Accessibility::ImageHasAlt:
+  GitHub::Accessibility::IframeHasTitleCounter:
+    enabled: true
+  GitHub::Accessibility::ImageHasAltCounter:
+    enabled: true
+  GitHub::Accessibility::LandmarkHasLabelCounter:
+    enabled: true
+  GitHub::Accessibility::LinkHasHrefCounter:
+    enabled: true
+  GitHub::Accessibility::NestedInteractiveElementsCounter:
     enabled: true
   GitHub::Accessibility::NoAriaLabelMisuseCounter:
     enabled: true
-  GitHub::Accessibility::NoPositiveTabIndex:
+  GitHub::Accessibility::NoPositiveTabIndexCounter:
     enabled: true
-  GitHub::Accessibility::NoRedundantImageAlt:
+  GitHub::Accessibility::NoRedundantImageAltCounter:
     enabled: true
   GitHub::Accessibility::NoTitleAttributeCounter:
     enabled: true
+  GitHub::Accessibility::SvgHasAccessibleTextCounter:
+    enabled: true
 ```
 
 ## Rules
 
-- [GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled](./docs/rules/accessibility/avoid-both-disabled-and-aria-disabled.md)
+- [GitHub::Accessibility::AvoidBothDisabledAndAriaDisabledCounter](./docs/rules/accessibility/avoid-both-disabled-and-aria-disabled-counter.md)
 - [GitHub::Accessibility::AvoidGenericLinkTextCounter](./docs/rules/accessibility/avoid-generic-link-text-counter.md)
-- [GitHub::Accessibility::IframeHasTitle](./docs/rules/accessibility/iframe-has-title.md)
-- [GitHub::Accessibility::ImageHasAlt](./docs/rules/accessibility/image-has-alt.md)
+- [GitHub::Accessibility::DisabledAttributeCounter](./docs/rules/accessibility/disabled-attribute-counter.md)
+- [GitHub::Accessibility::LandmarkHasLabelCounter](./docs/rules/accessibility/landmark-has-label-counter.md)
+- [GitHub::Accessibility::LinkHasHrefCounter](./docs/rules/accessibility/link-has-href-counter.md)
+- [GitHub::Accessibility::NestedInteractiveElementsCounter](./docs/rules/accessibility/nested-interactive-elements-counter.md)
+- [GitHub::Accessibility::IframeHasTitleCounter](./docs/rules/accessibility/iframe-has-title-counter.md)
+- [GitHub::Accessibility::ImageHasAltCounter](./docs/rules/accessibility/image-has-alt-counter.md)
 - [GitHub::Accessibility::NoAriaLabelMisuseCounter](./docs/rules/accessibility/no-aria-label-misuse-counter.md)
-- [GitHub::Accessibility::NoPositiveTabIndex](./docs/rules/accessibility/no-positive-tab-index.md)
-- [GitHub::Accessibility::NoRedundantImageAlt](./docs/rules/accessibility/no-redundant-image-alt.md)
+- [GitHub::Accessibility::NoPositiveTabIndexCounter](./docs/rules/accessibility/no-positive-tab-index-counter.md)
+- [GitHub::Accessibility::NoRedundantImageAltCounter](./docs/rules/accessibility/no-redundant-image-alt-counter.md)
 - [GitHub::Accessibility::NoTitleAttributeCounter](./docs/rules/accessibility/no-title-attribute-counter.md)
+- [GitHub::Accessibility::SvgHasAccessibleTextCounter](./docs/rules/accessibility/svg-has-accessible-text-counter.md)
+
+## Disabling a rule (experimental)
+
+_This is an experimental feature which should ideally be upstreamed to erblint_
+
+`erblint` does not natively support rule disables. At GitHub, we've implemented these rules in a way to allow rules to be disabled at an offense-level via counters or disabled at a file-level because often times, we want to enable a rule but aren't able to address all offenses at once. We achieve this in one of two ways.
+
+Rules that are marked as `Counter` can be disabled by adding a comment with the offense count that matches the number of offenses within the file like:
+
+```.html.erb
+<%# erblint:counter GitHub::Accessibility::LinkHasHrefCounter 1 %>
+```
+
+In this comment example, when a new `LinkHasHrefCounter` offense has been added, the counter will need to be bumped up to 2. More recent rules use a `Counter` format.
+
+If you are enabling a rule for the first time and your codebase has a lot of offenses, you can use the `-a` command to automatically add these counter comments in the appropriate places.
+
+```
+bundle exec erblint app/views app/components -a
+```
+
+Rules that are not marked as `Counter` like `NoRedundantImageAlt` are considered to be legacy format. We are in the process of migrating these to counters. These rules can still be disabled at the file-level by adding this comment at the top of the file:
+
+```.html.erb
+<%# erblint:disable GitHub::Accessibility::NoRedundantImageAlt %>
+```
+
+However, unlike a counter, any subsequent offenses introduced to the file will not raise. 
 
 ## Testing
 

data/lib/erblint-github/linters/github/accessibility/{avoid_both_disabled_and_aria_disabled.rb → avoid_both_disabled_and_aria_disabled_counter.rb}

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class AvoidBothDisabledAndAriaDisabled < Linter
+        class AvoidBothDisabledAndAriaDisabledCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -22,7 +22,21 @@ module ERBLint
               generate_offense(self.class, processed_source, tag)
             end
 
-            rule_disabled?(processed_source)
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
           end
         end
       end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class DisabledAttributeCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          VALID_DISABLED_TAGS = %w[button input textarea option select fieldset optgroup task-lists].freeze
+          MESSAGE = "`disabled` is only valid on #{VALID_DISABLED_TAGS.join(', ')}."
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.closing?
+              next if VALID_DISABLED_TAGS.include?(tag.name)
+              next if tag.attributes["disabled"].nil?
+
+              generate_offense(self.class, processed_source, tag)
+            end
+
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/erblint-github/linters/github/accessibility/{iframe_has_title.rb → iframe_has_title_counter.rb}

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class IframeHasTitle < Linter
+        class IframeHasTitleCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -23,7 +23,21 @@ module ERBLint
               generate_offense(self.class, processed_source, tag) if title.empty? && !aria_hidden?(tag)
             end
 
-            rule_disabled?(processed_source)
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
           end
 
           private

data/lib/erblint-github/linters/github/accessibility/{image_has_alt.rb → image_has_alt_counter.rb}

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class ImageHasAlt < Linter
+        class ImageHasAltCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -22,7 +22,21 @@ module ERBLint
               generate_offense(self.class, processed_source, tag) if alt.empty?
             end
 
-            rule_disabled?(processed_source)
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
           end
         end
       end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class LandmarkHasLabelCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          LANDMARK_ROLES = %w[complementary navigation region search].freeze
+          LANDMARK_TAGS = %w[aside nav section].freeze
+          MESSAGE = "Landmark elements should have an aria-label attribute, or aria-labelledby if a heading elements exists in the landmark."
+          ROLE_TAG_MAPPING = { "complementary" => "aside", "navigation" => "nav", "region" => "section" }.freeze
+
+          def get_additional_message(tag, roles)
+            role_matched = (roles & ROLE_TAG_MAPPING.keys).first
+            if role_matched
+              tag_matched = ROLE_TAG_MAPPING[role_matched]
+
+              if tag.name == tag_matched
+                "The <#{tag_matched}> element will automatically communicate a role of '#{role_matched}'. You can safely drop the role attribute."
+              else
+                replace_message = if tag.name == "div"
+                                    "If possible replace this tag with a <#{tag_matched}>."
+                                  else
+                                    "Wrapping this element in a <#{tag_matched}> and setting a label on it is reccomended."
+                                  end
+
+                "The <#{tag_matched}> element will automatically communicate a role of '#{role_matched}'. #{replace_message}"
+              end
+            elsif roles.include?("search") && tag.name != "form"
+              "The 'search' role works best when applied to a <form> element. If possible replace this tag with a <form>."
+            end
+          end
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.closing?
+
+              possible_roles = possible_attribute_values(tag, "role")
+              next unless LANDMARK_TAGS.include?(tag.name) && (possible_roles & LANDMARK_ROLES).empty?
+              next if tag.attributes["aria-label"]&.value&.present? || tag.attributes["aria-labelledby"]&.value&.present?
+
+              message = get_additional_message(tag, possible_roles)
+              if message
+                generate_offense(self.class, processed_source, tag, "#{MESSAGE}\n#{message}")
+              else
+                generate_offense(self.class, processed_source, tag)
+              end
+            end
+
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class LinkHasHrefCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          MESSAGE = "Links should go somewhere, you probably want to use a `<button>` instead."
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.name != "a"
+              next if tag.closing?
+
+              href = possible_attribute_values(tag, "href")
+              name = tag.attributes["name"]
+              generate_offense(self.class, processed_source, tag) if (!name && href.empty?) || href.include?("#")
+            end
+
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class NestedInteractiveElementsCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          INTERACTIVE_ELEMENTS = %w[button summary input select textarea a].freeze
+          MESSAGE = "Nesting interactive elements produces invalid HTML, and ssistive technologies, such as screen readers, might ignore or respond unexpectedly to such nested controls."
+
+          def run(processed_source)
+            last_interactive_element = nil
+            tags(processed_source).each do |tag|
+              next unless INTERACTIVE_ELEMENTS.include?(tag.name)
+
+              last_interactive_element = nil if last_interactive_element && tag.name == last_interactive_element.name && tag.closing?
+              next if tag.closing?
+
+              if last_interactive_element
+                next if last_interactive_element.name == "summary" && tag.name == "a"
+                next if tag.name == "input" && tag.attributes["type"]&.value == "hidden"
+
+                message = "Found <#{tag.name}> nested inside of <#{last_interactive_element.name}>.\n" + MESSAGE
+                generate_offense(self.class, processed_source, tag, message)
+              end
+
+              last_interactive_element = tag unless tag&.name == "input"
+            end
+
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/erblint-github/linters/github/accessibility/{no_positive_tab_index.rb → no_positive_tab_index_counter.rb}

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NoPositiveTabIndex < Linter
+        class NoPositiveTabIndexCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -20,7 +20,21 @@ module ERBLint
               generate_offense(self.class, processed_source, tag)
             end
 
-            rule_disabled?(processed_source)
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
           end
         end
       end

data/lib/erblint-github/linters/github/accessibility/{no_redundant_image_alt.rb → no_redundant_image_alt_counter.rb}

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NoRedundantImageAlt < Linter
+        class NoRedundantImageAltCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -24,7 +24,21 @@ module ERBLint
               generate_offense(self.class, processed_source, tag) if (alt.downcase.split & REDUNDANT_ALT_WORDS).any?
             end
 
-            rule_disabled?(processed_source)
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
           end
         end
       end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class SvgHasAccessibleTextCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          MESSAGE = "`<svg>` must have accessible text. Set `aria-label`, or `aria-labelledby`, or nest a `<title>` element. However, if the `<svg>` is purely decorative, hide it with `aria-hidden='true'.\nFor more info, see https://css-tricks.com/accessible-svgs/."
+
+          def run(processed_source)
+            current_svg = nil
+            has_accessible_label = false
+
+            tags(processed_source).each do |tag|
+              # Checks whether tag is a <title> nested in an <svg>
+              has_accessible_label = true if current_svg && tag.name == "title" && !tag.closing?
+
+              next if tag.name != "svg"
+
+              if tag.closing?
+                generate_offense(self.class, processed_source, current_svg) unless has_accessible_label
+                current_svg = nil
+              elsif possible_attribute_values(tag, "aria-hidden").join == "true"
+                has_accessible_label = true
+                current_svg = tag
+              else
+                current_svg = tag
+                aria_label = possible_attribute_values(tag, "aria-label").join
+                aria_labelledby = possible_attribute_values(tag, "aria-labelledby").join
+
+                has_accessible_label = aria_label.present? || aria_labelledby.present?
+              end
+            end
+
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erblint-github
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.2
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint
@@ -105,14 +105,19 @@ files:
 - README.md
 - lib/erblint-github/linters.rb
 - lib/erblint-github/linters/custom_helpers.rb
-- lib/erblint-github/linters/github/accessibility/avoid_both_disabled_and_aria_disabled.rb
+- lib/erblint-github/linters/github/accessibility/avoid_both_disabled_and_aria_disabled_counter.rb
 - lib/erblint-github/linters/github/accessibility/avoid_generic_link_text_counter.rb
-- lib/erblint-github/linters/github/accessibility/iframe_has_title.rb
-- lib/erblint-github/linters/github/accessibility/image_has_alt.rb
+- lib/erblint-github/linters/github/accessibility/disabled_attribute_counter.rb
+- lib/erblint-github/linters/github/accessibility/iframe_has_title_counter.rb
+- lib/erblint-github/linters/github/accessibility/image_has_alt_counter.rb
+- lib/erblint-github/linters/github/accessibility/landmark_has_label_counter.rb
+- lib/erblint-github/linters/github/accessibility/link_has_href_counter.rb
+- lib/erblint-github/linters/github/accessibility/nested_interactive_elements_counter.rb
 - lib/erblint-github/linters/github/accessibility/no_aria_label_misuse_counter.rb
-- lib/erblint-github/linters/github/accessibility/no_positive_tab_index.rb
-- lib/erblint-github/linters/github/accessibility/no_redundant_image_alt.rb
+- lib/erblint-github/linters/github/accessibility/no_positive_tab_index_counter.rb
+- lib/erblint-github/linters/github/accessibility/no_redundant_image_alt_counter.rb
 - lib/erblint-github/linters/github/accessibility/no_title_attribute_counter.rb
+- lib/erblint-github/linters/github/accessibility/svg_has_accessible_text_counter.rb
 - lib/tasks/docs.rake
 - lib/tasks/tests.rake
 homepage: https://github.com/github/erblint-github
@@ -135,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.10
 signing_key: 
 specification_version: 4
 summary: erblint GitHub