erblint-github 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 819c1bde423300648fdae7afee85bab8306b8ed234eaf04f1318d8a18abd380a
-  data.tar.gz: 16217f106609dde5113989809bd17fd6984ac170485222c8956460255cf514bb
+  metadata.gz: e46c63a275b6e7d34b0aab81c0de051625bfbd7fc6c3fedb944a6d10a5ba3cff
+  data.tar.gz: 33984e9857ae9a998a3ae56a9fd29c0bf89557d41eee3698cb13731327da7988
 SHA512:
-  metadata.gz: 355ff2fc38afdf3f426c80da3cada076565f1b69e4ff0ca20f909bd0dacec0a7fb8b4f61c03a8701325cf5f96b95480877b4057d65d232f856a3f89325408a37
-  data.tar.gz: 955cda7b4f36d4c08755ed23718173bbe910a694de9763b806c15d35a312c01696d1d5c93ca61f4f415680b3cb787debf79464e452a3eb4dd5ede09462324080
+  metadata.gz: 0404a048ebd068503aa1f7521a9c1f116165e3d9c507bee6e0a04c28ec3871b12fb53dc1141ff57981d013ac0af8d2bb41b21faea545c7741ff28f1d4e4c3b95
+  data.tar.gz: c64a47d57b7bb87ed7f1437be1430f44f860f58e0d28a6acca5b530e442350e9d1e8f28d83fdf8230d731a0851e812f9ad82278bec964aefffdac16fc250a530

data/README.md

@@ -23,13 +23,23 @@ require "erblint-github/linters"
 ```yaml 
 ---
 linters:
+  GitHub::Accessibility::ImageHasAlt:
+    enabled: true
+  GitHub::Accessibility::NoAriaLabelMisuse:
+    enabled: true
   GitHub::Accessibility::NoRedundantImageAlt:
     enabled: true
 ```
 
+### Rules
+
+- [GitHub::Accessibility::ImageHasAlt](./docs/rules/accessibility/no-aria-label-misuse.md)
+- [GitHub::Accessibility::NoAriaLabelMisuse](./docs/rules/accessibility/image-has-alt.md)
+- [GitHub::Accessibility::NoRedundantImageAlt](./docs/rules/accessibility/no-redundant-image-alt.md)
+
 ## Testing
 
 ```
 bundle install
-bundle exec rake test
+bundle exec rake
 ```

data/lib/erblint-github/linters/custom_helpers.rb

@@ -11,7 +11,7 @@ module ERBLint
           indicator_node, _, code_node, = *node
           indicator = indicator_node&.loc&.source
           comment = code_node&.loc&.source&.strip
-          rule_name = self.class.name.match(/:?:?(\w+)\Z/)[1]
+          rule_name = self.class.name.gsub("ERBLint::Linters::", "")
 
           if indicator == "#" && comment.start_with?("erblint:disable") && comment.match(rule_name)
             if @offenses.any?

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class ImageHasAlt < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          MESSAGE = "<img> should have an alt prop with meaningful text or an empty string for decorative images"
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.name != "img"
+              next if tag.closing?
+
+              alt = possible_attribute_values(tag, "alt")
+
+              generate_offense(self.class, processed_source, tag) if alt.empty?
+            end
+
+            rule_disabled?(processed_source)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class NoAriaLabelMisuse < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          GENERIC_ELEMENTS = %w[span div].freeze
+          NAME_RESTRICTED_ELEMENTS = %w[h1 h2 h3 h4 h5 h6 strong i p b code].freeze
+
+          # https://w3c.github.io/aria/#namefromprohibited
+          ROLES_WHICH_CANNOT_BE_NAMED = %w[caption code definition deletion emphasis insertion mark none paragraph presentation strong subscript suggestion superscript term time].freeze
+
+          MESSAGE = "[aria-label] and [aria-labelledby] usage are only reliably supported on interactive elements and a subset of ARIA roles"
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.closing?
+              next unless possible_attribute_values(tag, "aria-label").present? || possible_attribute_values(tag, "aria-labelledby").present?
+
+              if NAME_RESTRICTED_ELEMENTS.include?(tag.name)
+                generate_offense(self.class, processed_source, tag)
+              elsif GENERIC_ELEMENTS.include?(tag.name)
+                role = possible_attribute_values(tag, "role")
+                if role.present?
+                  generate_offense(self.class, processed_source, tag) if ROLES_WHICH_CANNOT_BE_NAMED.include?(role.join)
+                else
+                  generate_offense(self.class, processed_source, tag)
+                end
+              end
+            end
+            rule_disabled?(processed_source)
+          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.1
+  version: 0.0.2
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint
@@ -105,6 +105,8 @@ files:
 - README.md
 - lib/erblint-github/linters.rb
 - lib/erblint-github/linters/custom_helpers.rb
+- lib/erblint-github/linters/github/accessibility/image_has_alt.rb
+- lib/erblint-github/linters/github/accessibility/no_aria_label_misuse.rb
 - lib/erblint-github/linters/github/accessibility/no_redundant_image_alt.rb
 homepage: https://github.com/github/erblint-github
 licenses: