erblint-github 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfd39a72bcefe35b0231242045b4aca7cfdf6468b795d2703528655039b9e7be
-  data.tar.gz: 4331758cf201fe621f5510554766a6d300f46b43ef36d272e82f53d2ffaf420d
+  metadata.gz: 0e372a7e49311d6c270ff943ca1ec446c1f20ad06ac47fc784ce60c23f51b1d1
+  data.tar.gz: ac136d5460abc4d8fef0229036486b57565425bc4660ca252b6344378a6d1629
 SHA512:
-  metadata.gz: ea54a4d64005d7be039a3f9ed620447ca673db7113e821f303cce4c35da74835c6f124afa84f3b7e8eb35e2adb278394aef1f6326a10f73ebfb3a9a342c956a1
-  data.tar.gz: 942f3526203855f2a58c37f54b5d2775cc0de910a0adf057889dba2c4e60a1553276b640c7ba6c8fd6ed91d3b3af597ab86c0aa49e84f49ed47005feafcec59a
+  metadata.gz: 42290941d5f2d0b2643842e62a1e5f759d8387294f829a01b52c354103c42aade10fcf0d30571fd4b5a061b9a6cd968aaf6f5204189b0049971ac99f1baae71e
+  data.tar.gz: 557bbc994d0fb8a3e0a49a129f22c9a209be7219fa9b0812b77fbe4ba2ce66265cd36c42674572db33f7729d50dbc00c0388d06899a2ec0aadcd141e4a3e9a74

data/README.md

@@ -27,10 +27,14 @@ linters:
     enabled: true
   GitHub::Accessibility::AvoidGenericLinkTextCounter:
     enabled: true
+  GitHub::Accessibility::DisabledAttributeCounter:
+    enabled: true
   GitHub::Accessibility::IframeHasTitle:
     enabled: true
   GitHub::Accessibility::ImageHasAlt:
     enabled: true
+  GitHub::Accessibility::LinkHasHrefCounter:
+    enabled: true
   GitHub::Accessibility::NoAriaLabelMisuseCounter:
     enabled: true
   GitHub::Accessibility::NoPositiveTabIndex:
@@ -39,18 +43,23 @@ linters:
     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::AvoidGenericLinkTextCounter](./docs/rules/accessibility/avoid-generic-link-text-counter.md)
+- [GitHub::Accessibility::DisabledAttributeCounter](./docs/rules/accessibility/disabled-attribute-counter-test)
 - [GitHub::Accessibility::IframeHasTitle](./docs/rules/accessibility/iframe-has-title.md)
 - [GitHub::Accessibility::ImageHasAlt](./docs/rules/accessibility/image-has-alt.md)
+- [GitHub::Accessibility::LinkHasHrefCounter](./docs/rules/accessibility/link_has_href-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::NoTitleAttributeCounter](./docs/rules/accessibility/no-title-attribute-counter.md)
+- [GitHub::Accessibility::SvgHasAccessibleTextCounter](./docs/rules/accessibility/svg_has_accessible_text_counter.md)
 
 ## Testing
 

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/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/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.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint
@@ -107,12 +107,15 @@ files:
 - 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_generic_link_text_counter.rb
+- lib/erblint-github/linters/github/accessibility/disabled_attribute_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/link_has_href_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_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 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.9
 signing_key: 
 specification_version: 4
 summary: erblint GitHub