erblint-github 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b2a29a79e8d05ae92a33bff53b8a210d3ae35658e4e331fb3f7b7c9ca259147
-  data.tar.gz: 6e551b63af42992248a0b1965e50d9954c44e3596bc5feed0ba6a2eb7399d1bf
+  metadata.gz: d329206d7b3c42304a1279e5077122c74757ce8959272c1c76bd870559becc0a
+  data.tar.gz: e0d34fb46bc77014dd2124fbab66af6bffe1385cd381b0c2e54a4520d5b02876
 SHA512:
-  metadata.gz: 62bd97d7ece9d2d9082d1424e086b542f25a5b736ee7664636811376cd87b08c2420cbb1c3fef0ab0b769511c6e520d8769c51380647a373efa95b241d8db393
-  data.tar.gz: a8c9be52a3b99be842df8b5d34388f3ee8ff2629e369deaaefdea206520440a1e3a5fc18e1a74b5fa2fd774ffd2a6586476ad8dbfb965a3ea9b8dd5dd053b099
+  metadata.gz: 2893fe01bc4fa5f16be61698646f649c5098eeefa4268be7f69ee7ef7bd3c7fbe4a6b4f5c09ecfeedbba3441c62e96ae767253d1058171b00c92c7f88992aedd
+  data.tar.gz: 0a3cbff707c22df4bbcb4e6da28e86ad9f2d46cbe0cc61a241a7f163e584846eaa671639a736a32efdfc90463f8abb14c45069b7f71aaea2fd3467f0812a86a2

data/README.md

@@ -1,4 +1,5 @@
 # erblint-github
+
 Template style checking for GitHub's Ruby projects
 
 ## Setup
@@ -10,49 +11,19 @@ gem "erb_lint", require: false
 gem "erblint-github"
 ```
 
-2. Require the linters within the `.erb-linters` folder. This could be done by adding a file `.erb-linters/erblint-github.rb` with the following line.
+2. Require the lint rules from this library. Currently, the only supported way is to add a new file in `.erb-linters/erblint-github.rb` with the line:
 
 ```ruby
 require "erblint-github/linters"
 ```
 
-3. Update the `erb-lint.yml` to configure the rule.
-
-### .erb-lint.yml
+3. Update your `erb-lint.yml` to pull in our recommended configs. This will ensure you are up-to-date with our recommendations.
 
-```yaml 
+```yaml
 ---
-linters:
-  GitHub::Accessibility::AriaLabelIsWellFormatted:
-    enabled: true
-  GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled:
-    enabled: true
-  GitHub::Accessibility::AvoidGenericLinkText:
-    enabled: true
-  GitHub::Accessibility::DisabledAttribute:
-    enabled: true
-  GitHub::Accessibility::IframeHasTitle:
-    enabled: true
-  GitHub::Accessibility::ImageHasAlt:
-    enabled: true
-  GitHub::Accessibility::NavigationHasLabel:
-    enabled: true
-  GitHub::Accessibility::LinkHasHref:
-    enabled: true
-  GitHub::Accessibility::NestedInteractiveElements:
-    enabled: true
-  GitHub::Accessibility::NoAriaHiddenOnFocusable:
-    enabled: true
-  GitHub::Accessibility::NoAriaLabelMisuse:
-    enabled: true
-  GitHub::Accessibility::NoPositiveTabIndex:
-    enabled: true
-  GitHub::Accessibility::NoRedundantImageAlt:
-    enabled: true
-  GitHub::Accessibility::NoTitleAttribute:
-    enabled: true
-  GitHub::Accessibility::SvgHasAccessibleText:
-    enabled: true
+inherit_gem:
+  erblint-github:
+    - config/accessibility.yml
 ```
 
 ## Rules
@@ -73,34 +44,6 @@ linters:
 - [GitHub::Accessibility::NoTitleAttribute](./docs/rules/accessibility/no-title-attribute.md)
 - [GitHub::Accessibility::SvgHasAccessibleText](./docs/rules/accessibility/svg-has-accessible-text.md)
 
-## Disabling a rule (Deprecated)
-
-_This is a soon-to-be deprecated feature. Do not use. See [migration guide](./docs/counter-migration-guide.md)_
-
-`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 `LinkHasHref` 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/config/accessibility.yml

@@ -0,0 +1,32 @@
+---
+linters:
+  GitHub::Accessibility::AriaLabelIsWellFormatted:
+    enabled: true
+  GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled:
+    enabled: true
+  GitHub::Accessibility::AvoidGenericLinkText:
+    enabled: true
+  GitHub::Accessibility::DisabledAttribute:
+    enabled: true
+  GitHub::Accessibility::IframeHasTitle:
+    enabled: true
+  GitHub::Accessibility::ImageHasAlt:
+    enabled: true
+  GitHub::Accessibility::NavigationHasLabel:
+    enabled: true
+  GitHub::Accessibility::LinkHasHref:
+    enabled: true
+  GitHub::Accessibility::NestedInteractiveElements:
+    enabled: true
+  GitHub::Accessibility::NoAriaHiddenOnFocusable:
+    enabled: true
+  GitHub::Accessibility::NoAriaLabelMisuse:
+    enabled: true
+  GitHub::Accessibility::NoPositiveTabIndex:
+    enabled: true
+  GitHub::Accessibility::NoRedundantImageAlt:
+    enabled: true
+  GitHub::Accessibility::NoTitleAttribute:
+    enabled: true
+  GitHub::Accessibility::SvgHasAccessibleText:
+    enabled: true

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

@@ -8,39 +8,6 @@ module ERBLint
     module CustomHelpers
       INTERACTIVE_ELEMENTS = %w[button summary input select textarea a].freeze
 
-      def counter_correct?(processed_source)
-        comment_node = nil
-        expected_count = 0
-        rule_name = simple_class_name
-        offenses_count = @offenses.length
-
-        processed_source.parser.ast.descendants(:erb).each do |node|
-          indicator_node, _, code_node, = *node
-          indicator = indicator_node&.loc&.source
-          comment = code_node&.loc&.source&.strip
-
-          if indicator == "#" && comment.start_with?("erblint:counter") && comment.match(rule_name)
-            comment_node = node
-            expected_count = comment.match(/\s(\d+)\s?$/)[1].to_i
-          end
-        end
-
-        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
-        end
-
-        first_offense = @offenses[0]
-
-        if comment_node.nil?
-          add_offense(processed_source.to_source_range(first_offense.source_range), "#{rule_name}: If you must, add <%# erblint:disable #{rule_name} %> at the end of the offending line to bypass this check. See https://github.com/shopify/erb-lint#disable-rule-at-offense-level", "<%# erblint:disable #{rule_name} %>")
-        else
-          clear_offenses
-          add_offense(processed_source.to_source_range(comment_node.loc), "Incorrect erblint:counter number for #{rule_name}. Expected: #{expected_count}, actual: #{offenses_count}.", "<%# erblint:counter #{rule_name}Counter #{offenses_count} %>") if expected_count != offenses_count
-        end
-      end
-
       def generate_offense(klass, processed_source, tag, message = nil, replacement = nil)
         message ||= klass::MESSAGE
         message += "\nLearn more at https://github.com/github/erblint-github#rules.\n"
@@ -57,7 +24,7 @@ module ERBLint
 
       def possible_attribute_values(tag, attr_name)
         value = tag.attributes[attr_name]&.value || nil
-        basic_conditional_code_check(value || "") || [value].compact
+        [value].compact
       end
 
       # Map possible values from condition

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

@@ -10,7 +10,7 @@ module ERBLint
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
-          MESSAGE = "[aria-label] text should be formatted the same as you would visual text. Use sentence case."
+          MESSAGE = "[aria-label] text should be formatted the same as you would visual text. Use sentence case, and don't format it like an ID. Additionally, `aria-label` should be concise and should not contain line breaks."
 
           class ConfigSchema < LinterConfig
             property :exceptions, accepts: array_of?(String),
@@ -23,9 +23,8 @@ module ERBLint
               next if tag.closing?
 
               aria_label = possible_attribute_values(tag, "aria-label").join
-              next if aria_label.empty?
 
-              if aria_label.match?(/^[a-z]/) && !@config.exceptions.include?(aria_label)
+              if (aria_label.start_with?(/^[a-z]/) || aria_label.match?(/[\r\n]+/)) && !@config.exceptions.include?(aria_label)
                 generate_offense(self.class, processed_source, tag)
               end
             end

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

@@ -13,11 +13,6 @@ module ERBLint
           ELEMENTS_WITH_NATIVE_DISABLED_ATTRIBUTE_SUPPORT = %w[button fieldset input optgroup option select textarea].freeze
           MESSAGE = "[aria-disabled] may be used in place of native HTML [disabled] to allow tab-focus on an otherwise ignored element. Setting both attributes is contradictory."
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             tags(processed_source).each do |tag|
               next if tag.closing?
@@ -26,10 +21,6 @@ module ERBLint
 
               generate_offense(self.class, processed_source, tag)
             end
-
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
         end
       end

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

@@ -22,11 +22,6 @@ module ERBLint
 
           MESSAGE = "Avoid using generic link text such as #{BANNED_GENERIC_TEXT.join(', ')} which do not make sense in isolation."
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             processed_source.ast.children.each_with_index do |node, index|
               next unless node.methods.include?(:type) && node.type == :text
@@ -98,9 +93,6 @@ module ERBLint
                 banned_text = nil
               end
             end
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
 
           private

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

@@ -13,16 +13,6 @@ module ERBLint
           VALID_DISABLED_TAGS = %w[button input textarea option select fieldset optgroup task-lists].freeze
           MESSAGE = "`disabled` is only valid on #{VALID_DISABLED_TAGS.join(', ')}."
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             tags(processed_source).each do |tag|
               next if tag.closing?
@@ -31,10 +21,6 @@ module ERBLint
 
               generate_offense(self.class, processed_source, tag)
             end
-
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
         end
       end

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

@@ -13,11 +13,6 @@ module ERBLint
           MESSAGE = "`<iframe>` with meaningful content should have a title attribute that identifies the content."\
                     " If `<iframe>` has no meaningful content, hide it from assistive technology with `aria-hidden='true'`."\
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             tags(processed_source).each do |tag|
               next if tag.name != "iframe"
@@ -27,10 +22,6 @@ module ERBLint
 
               generate_offense(self.class, processed_source, tag) if title.empty? && !aria_hidden?(tag)
             end
-
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
 
           private

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

@@ -12,11 +12,6 @@ module ERBLint
 
           MESSAGE = "<img> should have an alt prop with meaningful text or an empty string for decorative images"
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             tags(processed_source).each do |tag|
               next if tag.name != "img"
@@ -26,10 +21,6 @@ module ERBLint
 
               generate_offense(self.class, processed_source, tag) if alt.empty?
             end
-
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
         end
       end

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

@@ -12,11 +12,6 @@ module ERBLint
 
           MESSAGE = "Links should go somewhere, you probably want to use a `<button>` instead."
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             tags(processed_source).each do |tag|
               next if tag.name != "a"
@@ -26,10 +21,6 @@ module ERBLint
               name = tag.attributes["name"]
               generate_offense(self.class, processed_source, tag) if (!name && href.empty?) || href.include?("#")
             end
-
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
         end
       end

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

@@ -12,10 +12,6 @@ module ERBLint
 
           MESSAGE = "Nesting interactive elements produces invalid HTML, and ssistive technologies, such as screen readers, might ignore or respond unexpectedly to such nested controls."
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
           def run(processed_source)
             last_interactive_element = nil
             tags(processed_source).each do |tag|
@@ -34,10 +30,6 @@ module ERBLint
 
               last_interactive_element = tag unless tag&.name == "input"
             end
-
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
         end
       end

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

@@ -12,20 +12,11 @@ module ERBLint
 
           MESSAGE = "Elements that are focusable should not have `aria-hidden='true' because it will cause confusion for assistive technology users."
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             tags(processed_source).each do |tag|
               aria_hidden = possible_attribute_values(tag, "aria-hidden")
               generate_offense(self.class, processed_source, tag) if aria_hidden.include?("true") && focusable?(tag)
             end
-
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
         end
       end

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

@@ -18,11 +18,6 @@ module ERBLint
 
           MESSAGE = "[aria-label] and [aria-labelledby] usage are only reliably supported on interactive elements and a subset of ARIA roles"
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             tags(processed_source).each do |tag|
               next if tag.closing?
@@ -39,9 +34,6 @@ module ERBLint
                 end
               end
             end
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
         end
       end

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

@@ -12,11 +12,6 @@ module ERBLint
 
           MESSAGE = "Do not use positive tabindex as it is error prone and can severely disrupt navigation experience for keyboard users"
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             tags(processed_source).each do |tag|
               next if tag.closing?
@@ -24,10 +19,6 @@ module ERBLint
 
               generate_offense(self.class, processed_source, tag)
             end
-
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
         end
       end

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

@@ -13,11 +13,6 @@ module ERBLint
           MESSAGE = "<img> alt prop should not contain `image` or `picture` as screen readers already announce the element as an image"
           REDUNDANT_ALT_WORDS = %w[image picture].freeze
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             tags(processed_source).each do |tag|
               next if tag.name != "img"
@@ -28,10 +23,6 @@ module ERBLint
 
               generate_offense(self.class, processed_source, tag) if (alt.downcase.split & REDUNDANT_ALT_WORDS).any?
             end
-
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
         end
       end

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

@@ -12,11 +12,6 @@ module ERBLint
 
           MESSAGE = "The title attribute should never be used unless for an `<iframe>` as it is inaccessible for several groups of users."
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             tags(processed_source).each do |tag|
               next if tag.name == "iframe"
@@ -25,10 +20,6 @@ module ERBLint
               title = possible_attribute_values(tag, "title")
               generate_offense(self.class, processed_source, tag) if title.present?
             end
-
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
         end
       end

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

@@ -12,11 +12,6 @@ module ERBLint
 
           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/."
 
-          class ConfigSchema < LinterConfig
-            property :counter_enabled, accepts: [true, false], default: false, reader: :counter_enabled?
-          end
-          self.config_schema = ConfigSchema
-
           def run(processed_source)
             current_svg = nil
             has_accessible_label = false
@@ -41,10 +36,6 @@ module ERBLint
                 has_accessible_label = aria_label.present? || aria_labelledby.present?
               end
             end
-
-            if @config.counter_enabled?
-              counter_correct?(processed_source)
-            end
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erblint-github
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.49.0
+        version: 1.52.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.49.0
+        version: 1.52.0
 - !ruby/object:Gem::Dependency
   name: rubocop-github
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- config/accessibility.yml
 - lib/erblint-github/linters.rb
 - lib/erblint-github/linters/custom_helpers.rb
 - lib/erblint-github/linters/github/accessibility/aria_label_is_well_formatted.rb