erblint-github 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4866db453698b16cc11db6797374c4e60a125aa020fabe51966928d19e0578c0
-  data.tar.gz: ba36e29a32956fe98e545059f803b3113404f206015f963b1215452241f43427
+  metadata.gz: 241e053b11c2e8e99f2393e5810b8bf9206e9db587a579c7ba20f67575f07874
+  data.tar.gz: 60470f738221eda4e5ee04d230cbdb63f80aa9098e87381cf75b4a6f732c4dbc
 SHA512:
-  metadata.gz: b7becf4d23e09a131db0d379a3b28c47ad548034eb4e387a38ae6fb1f1d47ab6dba33173a0b5dfd39bfc6c999ffe02ea1f8278b42ae5ea82ec6c503bcaf0ffbd
-  data.tar.gz: 98ce947b2b9a76cbe3310b6a4187bce8cadad184f33044aee0761bd4d55f5bb82d8329fe683e26549f2c2144aedfeaa2ebcb39f32a7e20b13d5be044ce92da4f
+  metadata.gz: 267422c819129ea1e6eca8cc66ef95448345f3278cdd2ee036cc04303c8b9ef3628757808c9edc2dae815f30d56b9dceafa10670f0a60b492cb8c1df9e5254cf
+  data.tar.gz: 30566b29367c5991e4e6229c98f85f217467f8cbd7dd15c03a3f8f270c11da6d2439a699e9133f707d0b4a256f38e611a83e32774decbe4f35fa09647fde7d78

data/README.md

@@ -23,56 +23,56 @@ require "erblint-github/linters"
 ```yaml 
 ---
 linters:
-  GitHub::Accessibility::AvoidBothDisabledAndAriaDisabledCounter:
+  GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled:
     enabled: true
-  GitHub::Accessibility::AvoidGenericLinkTextCounter:
+  GitHub::Accessibility::AvoidGenericLinkText:
     enabled: true
-  GitHub::Accessibility::DisabledAttributeCounter:
+  GitHub::Accessibility::DisabledAttribute:
     enabled: true
-  GitHub::Accessibility::IframeHasTitleCounter:
+  GitHub::Accessibility::IframeHasTitle:
     enabled: true
-  GitHub::Accessibility::ImageHasAltCounter:
+  GitHub::Accessibility::ImageHasAlt:
     enabled: true
-  GitHub::Accessibility::LandmarkHasLabelCounter:
+  GitHub::Accessibility::LandmarkHasLabel:
     enabled: true
-  GitHub::Accessibility::LinkHasHrefCounter:
+  GitHub::Accessibility::LinkHasHref:
     enabled: true
-  GitHub::Accessibility::NestedInteractiveElementsCounter:
+  GitHub::Accessibility::NestedInteractiveElements:
     enabled: true
-  GitHub::Accessibility::NoAriaHiddenOnFocusableCounter:
+  GitHub::Accessibility::NoAriaHiddenOnFocusable:
     enabled: true
-  GitHub::Accessibility::NoAriaLabelMisuseCounter:
+  GitHub::Accessibility::NoAriaLabelMisuse:
     enabled: true
-  GitHub::Accessibility::NoPositiveTabIndexCounter:
+  GitHub::Accessibility::NoPositiveTabIndex:
     enabled: true
-  GitHub::Accessibility::NoRedundantImageAltCounter:
+  GitHub::Accessibility::NoRedundantImageAlt:
     enabled: true
-  GitHub::Accessibility::NoTitleAttributeCounter:
+  GitHub::Accessibility::NoTitleAttribute:
     enabled: true
-  GitHub::Accessibility::SvgHasAccessibleTextCounter:
+  GitHub::Accessibility::SvgHasAccessibleText:
     enabled: true
 ```
 
 ## Rules
 
-- [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::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::NoAriaHiddenOnFocusableCounter](./docs/rules/accessibility/no-aria-hidden-on-focusable-counter.md)
-- [GitHub::Accessibility::NoAriaLabelMisuseCounter](./docs/rules/accessibility/no-aria-label-misuse-counter.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_
+- [GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled](./docs/rules/accessibility/avoid-both-disabled-and-aria-disabled.md)
+- [GitHub::Accessibility::AvoidGenericLinkText](./docs/rules/accessibility/avoid-generic-link-text.md)
+- [GitHub::Accessibility::DisabledAttribute](./docs/rules/accessibility/disabled-attribute.md)
+- [GitHub::Accessibility::LandmarkHasLabel](./docs/rules/accessibility/landmark-has-label.md)
+- [GitHub::Accessibility::LinkHasHref](./docs/rules/accessibility/link-has-href.md)
+- [GitHub::Accessibility::NestedInteractiveElements](./docs/rules/accessibility/nested-interactive-elements.md)
+- [GitHub::Accessibility::IframeHasTitle](./docs/rules/accessibility/iframe-has-title.md)
+- [GitHub::Accessibility::ImageHasAlt](./docs/rules/accessibility/image-has-alt.md)
+- [GitHub::Accessibility::NoAriaHiddenOnFocusable](./docs/rules/accessibility/no-aria-hidden-on-focusable.md)
+- [GitHub::Accessibility::NoAriaLabelMisuse](./docs/rules/accessibility/no-aria-label-misuse.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::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.
 
@@ -82,7 +82,7 @@ Rules that are marked as `Counter` can be disabled by adding a comment with the
 <%# 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.
+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.
 

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

@@ -8,24 +8,6 @@ module ERBLint
     module CustomHelpers
       INTERACTIVE_ELEMENTS = %w[button summary input select textarea a].freeze
 
-      def rule_disabled?(processed_source)
-        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
-          rule_name = simple_class_name
-
-          if indicator == "#" && comment.start_with?("erblint:disable") && comment.match(rule_name)
-            if @offenses.any?
-              clear_offenses
-            else
-              add_offense(processed_source.to_source_range(code_node.loc),
-                          "Unused erblint:disable comment for #{rule_name}")
-            end
-          end
-        end
-      end
-
       def counter_correct?(processed_source)
         comment_node = nil
         expected_count = 0
@@ -52,10 +34,10 @@ module ERBLint
         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:counter #{rule_name} #{offenses_count} %> to bypass this check.", "<%# erblint:counter #{rule_name} #{offenses_count} %>")
+          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} #{offenses_count} %>") if expected_count != offenses_count
+          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
 

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

@@ -6,13 +6,18 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class AvoidBothDisabledAndAriaDisabledCounter < Linter
+        class AvoidBothDisabledAndAriaDisabled < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
           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?
@@ -22,20 +27,8 @@ module ERBLint
               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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

data/lib/erblint-github/linters/github/accessibility/{avoid_generic_link_text_counter.rb → avoid_generic_link_text.rb}

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class AvoidGenericLinkTextCounter < Linter
+        class AvoidGenericLinkText < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -22,6 +22,11 @@ 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
@@ -93,20 +98,8 @@ module ERBLint
                 banned_text = nil
               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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
 

data/lib/erblint-github/linters/github/accessibility/{disabled_attribute_counter.rb → disabled_attribute.rb}

@@ -6,13 +6,23 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class DisabledAttributeCounter < Linter
+        class DisabledAttribute < 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(', ')}."
 
+          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?
@@ -22,20 +32,8 @@ module ERBLint
               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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

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

@@ -6,13 +6,18 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class IframeHasTitleCounter < Linter
+        class IframeHasTitle < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
           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"
@@ -23,20 +28,8 @@ module ERBLint
               generate_offense(self.class, processed_source, tag) if title.empty? && !aria_hidden?(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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
 

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

@@ -6,12 +6,17 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class ImageHasAltCounter < Linter
+        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"
 
+          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"
@@ -22,20 +27,8 @@ module ERBLint
               generate_offense(self.class, processed_source, tag) if alt.empty?
             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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

data/lib/erblint-github/linters/github/accessibility/{landmark_has_label_counter.rb → landmark_has_label.rb}

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class LandmarkHasLabelCounter < Linter
+        class LandmarkHasLabel < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -36,6 +36,11 @@ module ERBLint
             end
           end
 
+          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?
@@ -52,20 +57,8 @@ module ERBLint
               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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

data/lib/erblint-github/linters/github/accessibility/{link_has_href_counter.rb → link_has_href.rb}

@@ -6,12 +6,17 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class LinkHasHrefCounter < Linter
+        class LinkHasHref < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
           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"
@@ -22,20 +27,8 @@ module ERBLint
               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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

data/lib/erblint-github/linters/github/accessibility/{nested_interactive_elements_counter.rb → nested_interactive_elements.rb}

@@ -6,12 +6,16 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NestedInteractiveElementsCounter < Linter
+        class NestedInteractiveElements < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
           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|
@@ -31,20 +35,8 @@ module ERBLint
               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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

data/lib/erblint-github/linters/github/accessibility/{no_aria_hidden_on_focusable_counter.rb → no_aria_hidden_on_focusable.rb}

@@ -6,32 +6,25 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NoAriaHiddenOnFocusableCounter < Linter
+        class NoAriaHiddenOnFocusable < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
           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
 
-            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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

data/lib/erblint-github/linters/github/accessibility/{no_aria_label_misuse_counter.rb → no_aria_label_misuse.rb}

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NoAriaLabelMisuseCounter < Linter
+        class NoAriaLabelMisuse < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -18,6 +18,11 @@ 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?
@@ -34,20 +39,8 @@ module ERBLint
                 end
               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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

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

@@ -6,12 +6,17 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NoPositiveTabIndexCounter < Linter
+        class NoPositiveTabIndex < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
           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?
@@ -20,20 +25,8 @@ module ERBLint
               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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

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

@@ -6,13 +6,18 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NoRedundantImageAltCounter < Linter
+        class NoRedundantImageAlt < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
           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"
@@ -24,20 +29,8 @@ module ERBLint
               generate_offense(self.class, processed_source, tag) if (alt.downcase.split & REDUNDANT_ALT_WORDS).any?
             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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

data/lib/erblint-github/linters/github/accessibility/{no_title_attribute_counter.rb → no_title_attribute.rb}

@@ -6,12 +6,17 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NoTitleAttributeCounter < Linter
+        class NoTitleAttribute < Linter
           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."
 
+          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"
@@ -21,20 +26,8 @@ module ERBLint
               generate_offense(self.class, processed_source, tag) if title.present?
             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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

data/lib/erblint-github/linters/github/accessibility/{svg_has_accessible_text_counter.rb → svg_has_accessible_text.rb}

@@ -6,12 +6,17 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class SvgHasAccessibleTextCounter < Linter
+        class SvgHasAccessibleText < 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/."
 
+          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
@@ -37,20 +42,8 @@ module ERBLint
               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
+            if @config.counter_enabled?
+              counter_correct?(processed_source)
             end
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erblint-github
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint
@@ -105,20 +105,20 @@ 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_counter.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_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_hidden_on_focusable_counter.rb
-- lib/erblint-github/linters/github/accessibility/no_aria_label_misuse_counter.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/erblint-github/linters/github/accessibility/avoid_both_disabled_and_aria_disabled.rb
+- lib/erblint-github/linters/github/accessibility/avoid_generic_link_text.rb
+- lib/erblint-github/linters/github/accessibility/disabled_attribute.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/landmark_has_label.rb
+- lib/erblint-github/linters/github/accessibility/link_has_href.rb
+- lib/erblint-github/linters/github/accessibility/nested_interactive_elements.rb
+- lib/erblint-github/linters/github/accessibility/no_aria_hidden_on_focusable.rb
+- lib/erblint-github/linters/github/accessibility/no_aria_label_misuse.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.rb
+- lib/erblint-github/linters/github/accessibility/svg_has_accessible_text.rb
 - lib/tasks/docs.rake
 - lib/tasks/tests.rake
 homepage: https://github.com/github/erblint-github
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: erblint GitHub