erblint-github 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcbe592387330f5ba0247660e9ed42074c9efbf0a0b2fa2ac02b9a846ecd2173
-  data.tar.gz: 51111580933382545db7a1603b897026cb5566febc494f83aaf4a57e2b02c525
+  metadata.gz: 9f1a4a94379042a57da340419014484f8395304da4ba9e60427b1314208b65ce
+  data.tar.gz: a2412a3fcc727db9d01441c2fdd4c24e7f3d472e0b55f73bb1c79a6839275ad6
 SHA512:
-  metadata.gz: 6bec2b9610ad690d506abc4b4e3e450cf492ccd36ee4784ef95902bc322d229b3435f3a19e9e06a434b7dc3c2d502872f1767c8301dfc3182625c7b5a4d1efa8
-  data.tar.gz: 3796bc95ceebd37e04f711a40363eefe4681f91837d4936dee34d78b815a1cb50b8186cfce295a815147c010c56fed596a824e08d74596a028c0582b9ffda5c9
+  metadata.gz: 4fde78f77bdbeda8d2c8831b629eb2b45d81a1a48c535d1ae962c2c3c5b01a1aa36ba8880ff912d38e6332331d2dfffa2128fb51820a2c041e746b9ae3af6501
+  data.tar.gz: a30c11c3dad20f668f334f67b9278057b06b72cce181ec32d37b2aedb3916826ef71a6c518db62c29a0d54e97e2d76c0870dee956157f8ff370d834eb1a7380f

data/bin/erblint-disable

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "json"
+
+# Accepts comma-separated args with simple rule name
+# e.g. script/erblint-disable SomeRule1,SomeRule2
+# e.g. script/erblint-disable GitHub::Accessibility::Rule1,SomeRule2
+rules = ARGV[0]
+
+rules_array = rules.split(",")
+rules_map = {}
+rules_array.each do |rule|
+  rule_underscored = rule.to_s.gsub("::", "/").
+    gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+    gsub(/([a-z\d])([A-Z])/, '\1_\2').
+    tr("-", "_").
+    downcase.
+    gsub("git_hub", "github") # corrects rule names with `GitHub` name to align with erb-lint expectations
+  rules_map[rule] = rule_underscored
+end
+
+rules_map.each do |disable_comment_name, command_line_name|
+  output = `bin/erblint --format json --enable-linters #{command_line_name} app/views app/components packages/**/app/components app/forms/**/`
+  hashed_output = JSON.parse(output)
+  hashed_output["files"].each do |file|
+    path = file["path"]
+    offenses = file["offenses"]
+    line_numbers = offenses.map do |offense|
+      offense["location"]["last_line"]
+    end
+    File.open(path, "r+") do |file|
+      lines = file.each_line.to_a
+      line_numbers.each do |line_number|
+        line = lines[line_number - 1]
+        unless line.match?(/erblint:disable (?<rules>.*#{disable_comment_name}).*/)
+          existing_disable = line.match(/(?<=# erblint:disable)(.*) (?=%>)/)
+          if existing_disable
+            existing_disable_string = existing_disable.captures[0]
+            add_new_disable = "#{existing_disable_string}, #{disable_comment_name}"
+            lines[line_number - 1] = lines[line_number - 1].gsub(existing_disable_string, add_new_disable)
+          else
+            lines[line_number - 1] = lines[line_number - 1].gsub("\n", "") + "<%# erblint:disable #{disable_comment_name} %>\n"
+          end
+        end
+      end
+      file.rewind
+      file.write(lines.join)
+    end
+  end
+end
+
+exit 0

data/config/accessibility.yml

@@ -1,5 +1,7 @@
 ---
 linters:
+  NoUnusedDisable:
+    enabled: true
   GitHub::Accessibility::AriaLabelIsWellFormatted:
     enabled: true
   GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled:
@@ -30,3 +32,5 @@ linters:
     enabled: true
   GitHub::Accessibility::SvgHasAccessibleText:
     enabled: true
+  GitHub::Accessibility::NoVisuallyHiddenInteractiveElements:
+    enabled: true

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

@@ -47,7 +47,7 @@ module ERBLint
         if offenses_count.zero?
           # have to adjust to get `\n` so we delete the whole line
           add_offense(processed_source.to_source_range(comment_node.loc.adjust(end_pos: 1)), "Unused erblint:counter comment for #{rule_name}", "") if comment_node
-          return
+          return false
         end
 
         first_offense = @offenses[0]

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

@@ -10,11 +10,11 @@ module ERBLint
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
-          MESSAGE = "The title attribute should never be used unless for an `<iframe>` as it is inaccessible for several groups of users."
+          MESSAGE = "The title attribute should never be used as it is inaccessible for several groups of users. Exceptions are provided for <iframe> and <link>."
 
           def run(processed_source)
             tags(processed_source).each do |tag|
-              next if tag.name == "iframe"
+              next if tag.name == "iframe" || tag.name == "link"
               next if tag.closing?
 
               title = possible_attribute_values(tag, "title")

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class NoVisuallyHiddenInteractiveElements < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+          INTERACTIVE_ELEMENTS = %w[a button summary select option textarea].freeze
+
+          MESSAGE = "Avoid visually hidding interactive elements. Visually hiding interactive elements can be confusing to sighted keyboard users as it appears their focus has been lost when they navigate to the hidden element"
+
+          def run(processed_source)
+            visually_hidden = false
+
+            tags(processed_source).each do |tag|
+              next if tag.closing?
+              classes = possible_attribute_values(tag, "class")
+              visually_hidden = true if classes.include?("sr-only")
+              next unless classes.include?("sr-only") || visually_hidden
+              if INTERACTIVE_ELEMENTS.include?(tag.name)
+                generate_offense(self.class, processed_source, tag)
+              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.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-13 00:00:00.000000000 Z
+date: 2023-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.18.0
+        version: 5.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.18.0
+        version: 5.20.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.52.0
+        version: 1.56.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.52.0
+        version: 1.56.4
 - !ruby/object:Gem::Dependency
   name: rubocop-github
   requirement: !ruby/object:Gem::Requirement
@@ -97,12 +97,14 @@ dependencies:
 description: Template style checking for GitHub Ruby repositories
 email:
 - opensource+erblint-github@github.com
-executables: []
+executables:
+- erblint-disable
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/erblint-disable
 - config/accessibility.yml
 - lib/erblint-github/linters.rb
 - lib/erblint-github/linters/custom_helpers.rb
@@ -120,6 +122,7 @@ files:
 - 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.rb
+- lib/erblint-github/linters/github/accessibility/no_visually_hidden_interactive_elements.rb
 - lib/erblint-github/linters/github/accessibility/svg_has_accessible_text.rb
 - lib/tasks/docs.rake
 - lib/tasks/tests.rake