erblint-github 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e7ce2b605ec0f31cb56b3e74e9f2eb4e10a11a8ab07d960596209b7d9674427
-  data.tar.gz: 0a74bf6def4d4c0b34c3f8bba3af39f7b3207fb87a72e08cf9143f3d42a1f577
+  metadata.gz: c3e42bd7e46e4628deda31d1657890c3ccc9e683d85943f2540629d36962b114
+  data.tar.gz: '099d8957fbc44e9739296d60c6f4436d7cf96ad0731bf69aca6edd5663acf98f'
 SHA512:
-  metadata.gz: 04e924e98c1fe68f5b3d56d8f0cf9a4c0083d70d55192661a1c93dcb457b870df4ab5841c8376c2afc8c7b3c86be87266df513e22cecfe5f33b230d450d4f5a4
-  data.tar.gz: f266202201dc8de5a3bd6089ed7b5562962b130ec5643775c3a910a242086a13280e4e449ccf26f3c0f9e5c1874693c8ce3971dff965117079ecd568c3c11e33
+  metadata.gz: e41f3c103e9b0c57cd9706706605d26e25aafdae1359d0d123d6dd05b32904a91e0609fcf42d0551bf871d904610c2e38b65e47b2cb10637424426714902394c
+  data.tar.gz: 6969aff49edec2d4f9d6768eb94d20c5ffc24b01495ea9ad68d134900a1351b7c7a5afcb5896c6b14da3212e36c1bf29c1a308c8fd5215a4bb055e9d303cdcc2

data/README.md

@@ -23,15 +23,15 @@ require "erblint-github/linters"
 ```yaml 
 ---
 linters:
-  GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled:
+  GitHub::Accessibility::AvoidBothDisabledAndAriaDisabledCounter:
     enabled: true
   GitHub::Accessibility::AvoidGenericLinkTextCounter:
     enabled: true
   GitHub::Accessibility::DisabledAttributeCounter:
     enabled: true
-  GitHub::Accessibility::IframeHasTitle:
+  GitHub::Accessibility::IframeHasTitleCounter:
     enabled: true
-  GitHub::Accessibility::ImageHasAlt:
+  GitHub::Accessibility::ImageHasAltCounter:
     enabled: true
   GitHub::Accessibility::LandmarkHasLabelCounter:
     enabled: true
@@ -41,9 +41,9 @@ linters:
     enabled: true
   GitHub::Accessibility::NoAriaLabelMisuseCounter:
     enabled: true
-  GitHub::Accessibility::NoPositiveTabIndex:
+  GitHub::Accessibility::NoPositiveTabIndexCounter:
     enabled: true
-  GitHub::Accessibility::NoRedundantImageAlt:
+  GitHub::Accessibility::NoRedundantImageAltCounter:
     enabled: true
   GitHub::Accessibility::NoTitleAttributeCounter:
     enabled: true
@@ -53,20 +53,48 @@ linters:
 
 ## Rules
 
-- [GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled](./docs/rules/accessibility/avoid-both-disabled-and-aria-disabled.md)
+- [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-test)
-- [GitHub::Accessibility::IframeHasTitle](./docs/rules/accessibility/iframe-has-title.md)
+- [GitHub::Accessibility::DisabledAttributeCounter](./docs/rules/accessibility/disabled-attribute-counter.md)
 - [GitHub::Accessibility::LandmarkHasLabelCounter](./docs/rules/accessibility/landmark-has-label-counter.md)
-- [GitHub::Accessibility::ImageHasAlt](./docs/rules/accessibility/image-has-alt.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::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::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_
+
+`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 `LinkHasHrefCounter` 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
 
 ```
@@ -81,4 +109,4 @@ If you use VS Code, we highly encourage [ERB Linter extension](https://marketpla
 ## Note
 
 This repo contains several accessibility-related linting rules to help surface accessibility issues that would otherwise go undetected until a later stage. Please note that due to the limitations of static code analysis,
-these ERB accessibility checks are NOT enough for ensuring the accessibility of your app. This shouldn't be the only tool you use to catch accessibility issues and should be supplemented with other tools that can check the runtime browser DOM output, as well as processes like accessibility design reviews, manual audits, user testing, etc.
+these ERB accessibility checks are NOT enough for ensuring the accessibility of your app. This shouldn't be the only tool you use to catch accessibility issues and should be supplemented with other tools that can check the runtime browser DOM output, as well as processes like accessibility design reviews, manual audits, user testing, etc.

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

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class AvoidBothDisabledAndAriaDisabled < Linter
+        class AvoidBothDisabledAndAriaDisabledCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -22,7 +22,21 @@ module ERBLint
               generate_offense(self.class, processed_source, tag)
             end
 
-            rule_disabled?(processed_source)
+            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

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

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class IframeHasTitle < Linter
+        class IframeHasTitleCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -23,7 +23,21 @@ module ERBLint
               generate_offense(self.class, processed_source, tag) if title.empty? && !aria_hidden?(tag)
             end
 
-            rule_disabled?(processed_source)
+            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
 
           private

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

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class ImageHasAlt < Linter
+        class ImageHasAltCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -22,7 +22,21 @@ module ERBLint
               generate_offense(self.class, processed_source, tag) if alt.empty?
             end
 
-            rule_disabled?(processed_source)
+            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

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

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NoPositiveTabIndex < Linter
+        class NoPositiveTabIndexCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -20,7 +20,21 @@ module ERBLint
               generate_offense(self.class, processed_source, tag)
             end
 
-            rule_disabled?(processed_source)
+            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

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

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NoRedundantImageAlt < Linter
+        class NoRedundantImageAltCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -24,7 +24,21 @@ module ERBLint
               generate_offense(self.class, processed_source, tag) if (alt.downcase.split & REDUNDANT_ALT_WORDS).any?
             end
 
-            rule_disabled?(processed_source)
+            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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erblint-github
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2022-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint
@@ -105,17 +105,17 @@ 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.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.rb
-- lib/erblint-github/linters/github/accessibility/image_has_alt.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_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_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/tasks/docs.rake
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.9
+rubygems_version: 3.3.10
 signing_key: 
 specification_version: 4
 summary: erblint GitHub