Skip to content

Commit e9eb4d8

Browse files
authored
Merge pull request #60 from github/kh-migrate-more-rules
Migrate all rules from using `Counter` in name
2 parents dee42cf + 1a9cc38 commit e9eb4d8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+363
-751
lines changed

README.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -23,56 +23,56 @@ require "erblint-github/linters"
2323
```yaml
2424
---
2525
linters:
26-
GitHub::Accessibility::AvoidBothDisabledAndAriaDisabledCounter:
26+
GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled:
2727
enabled: true
28-
GitHub::Accessibility::AvoidGenericLinkTextCounter:
28+
GitHub::Accessibility::AvoidGenericLinkText:
2929
enabled: true
30-
GitHub::Accessibility::DisabledAttributeCounter:
30+
GitHub::Accessibility::DisabledAttribute:
3131
enabled: true
32-
GitHub::Accessibility::IframeHasTitleCounter:
32+
GitHub::Accessibility::IframeHasTitle:
3333
enabled: true
34-
GitHub::Accessibility::ImageHasAltCounter:
34+
GitHub::Accessibility::ImageHasAlt:
3535
enabled: true
36-
GitHub::Accessibility::LandmarkHasLabelCounter:
36+
GitHub::Accessibility::LandmarkHasLabel:
3737
enabled: true
38-
GitHub::Accessibility::LinkHasHrefCounter:
38+
GitHub::Accessibility::LinkHasHref:
3939
enabled: true
40-
GitHub::Accessibility::NestedInteractiveElementsCounter:
40+
GitHub::Accessibility::NestedInteractiveElements:
4141
enabled: true
42-
GitHub::Accessibility::NoAriaHiddenOnFocusableCounter:
42+
GitHub::Accessibility::NoAriaHiddenOnFocusable:
4343
enabled: true
44-
GitHub::Accessibility::NoAriaLabelMisuseCounter:
44+
GitHub::Accessibility::NoAriaLabelMisuse:
4545
enabled: true
46-
GitHub::Accessibility::NoPositiveTabIndexCounter:
46+
GitHub::Accessibility::NoPositiveTabIndex:
4747
enabled: true
48-
GitHub::Accessibility::NoRedundantImageAltCounter:
48+
GitHub::Accessibility::NoRedundantImageAlt:
4949
enabled: true
50-
GitHub::Accessibility::NoTitleAttributeCounter:
50+
GitHub::Accessibility::NoTitleAttribute:
5151
enabled: true
52-
GitHub::Accessibility::SvgHasAccessibleTextCounter:
52+
GitHub::Accessibility::SvgHasAccessibleText:
5353
enabled: true
5454
```
5555
5656
## Rules
5757
58-
- [GitHub::Accessibility::AvoidBothDisabledAndAriaDisabledCounter](./docs/rules/accessibility/avoid-both-disabled-and-aria-disabled.md)
59-
- [GitHub::Accessibility::AvoidGenericLinkTextCounter](./docs/rules/accessibility/avoid-generic-link-text-counter.md)
60-
- [GitHub::Accessibility::DisabledAttributeCounter](./docs/rules/accessibility/disabled-attribute-counter.md)
61-
- [GitHub::Accessibility::LandmarkHasLabelCounter](./docs/rules/accessibility/landmark-has-label-counter.md)
62-
- [GitHub::Accessibility::LinkHasHrefCounter](./docs/rules/accessibility/link-has-href-counter.md)
63-
- [GitHub::Accessibility::NestedInteractiveElementsCounter](./docs/rules/accessibility/nested-interactive-elements-counter.md)
64-
- [GitHub::Accessibility::IframeHasTitleCounter](./docs/rules/accessibility/iframe-has-title-counter.md)
65-
- [GitHub::Accessibility::ImageHasAltCounter](./docs/rules/accessibility/image-has-alt-counter.md)
66-
- [GitHub::Accessibility::NoAriaHiddenOnFocusableCounter](./docs/rules/accessibility/no-aria-hidden-on-focusable-counter.md)
67-
- [GitHub::Accessibility::NoAriaLabelMisuseCounter](./docs/rules/accessibility/no-aria-label-misuse-counter.md)
68-
- [GitHub::Accessibility::NoPositiveTabIndexCounter](./docs/rules/accessibility/no-positive-tab-index-counter.md)
69-
- [GitHub::Accessibility::NoRedundantImageAltCounter](./docs/rules/accessibility/no-redundant-image-alt-counter.md)
70-
- [GitHub::Accessibility::NoTitleAttributeCounter](./docs/rules/accessibility/no-title-attribute-counter.md)
71-
- [GitHub::Accessibility::SvgHasAccessibleTextCounter](./docs/rules/accessibility/svg-has-accessible-text-counter.md)
72-
73-
## Disabling a rule (experimental)
74-
75-
_This is an experimental feature which should ideally be upstreamed to erblint_
58+
- [GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled](./docs/rules/accessibility/avoid-both-disabled-and-aria-disabled.md)
59+
- [GitHub::Accessibility::AvoidGenericLinkText](./docs/rules/accessibility/avoid-generic-link-text.md)
60+
- [GitHub::Accessibility::DisabledAttribute](./docs/rules/accessibility/disabled-attribute.md)
61+
- [GitHub::Accessibility::LandmarkHasLabel](./docs/rules/accessibility/landmark-has-label.md)
62+
- [GitHub::Accessibility::LinkHasHref](./docs/rules/accessibility/link-has-href.md)
63+
- [GitHub::Accessibility::NestedInteractiveElements](./docs/rules/accessibility/nested-interactive-elements.md)
64+
- [GitHub::Accessibility::IframeHasTitle](./docs/rules/accessibility/iframe-has-title.md)
65+
- [GitHub::Accessibility::ImageHasAlt](./docs/rules/accessibility/image-has-alt.md)
66+
- [GitHub::Accessibility::NoAriaHiddenOnFocusable](./docs/rules/accessibility/no-aria-hidden-on-focusable.md)
67+
- [GitHub::Accessibility::NoAriaLabelMisuse](./docs/rules/accessibility/no-aria-label-misuse.md)
68+
- [GitHub::Accessibility::NoPositiveTabIndex](./docs/rules/accessibility/no-positive-tab-index.md)
69+
- [GitHub::Accessibility::NoRedundantImageAlt](./docs/rules/accessibility/no-redundant-image-alt.md)
70+
- [GitHub::Accessibility::NoTitleAttribute](./docs/rules/accessibility/no-title-attribute.md)
71+
- [GitHub::Accessibility::SvgHasAccessibleText](./docs/rules/accessibility/svg-has-accessible-text.md)
72+
73+
## Disabling a rule (Deprecated)
74+
75+
_This is a soon-to-be deprecated feature. Do not use. See [migration guide](./docs/counter-migration-guide.md)_
7676
7777
`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.
7878

@@ -82,7 +82,7 @@ Rules that are marked as `Counter` can be disabled by adding a comment with the
8282
<%# erblint:counter GitHub::Accessibility::LinkHasHrefCounter 1 %>
8383
```
8484

85-
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.
85+
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.
8686

8787
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.
8888

docs/rules/accessibility/avoid-generic-link-text-counter.md renamed to docs/rules/accessibility/avoid-generic-link-text.md

File renamed without changes.

docs/rules/accessibility/disabled-attribute-counter.md renamed to docs/rules/accessibility/disabled-attribute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Disabled attribute counter
1+
# Disabled attribute
22

33
## Rule Details
44

File renamed without changes.
File renamed without changes.

docs/rules/accessibility/landmark-has-label-counter.md renamed to docs/rules/accessibility/landmark-has-label.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Landmark Has Label Counter
1+
# Landmark Has Label
22

33
## Rule Details
44

docs/rules/accessibility/link-has-href-counter.md renamed to docs/rules/accessibility/link-has-href.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Link Has Href counter
1+
# Link Has Href
22

33
## Rule Details
44

docs/rules/accessibility/nested-interactive-elements-counter.md renamed to docs/rules/accessibility/nested-interactive-elements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Nested Interactive Elements Counter
1+
# Nested Interactive Elements
22

33
## Rule Details
44

docs/rules/accessibility/no-aria-hidden-on-focusable-counter.md renamed to docs/rules/accessibility/no-aria-hidden-on-focusable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# No aria-hidden on focusable counter
1+
# No aria-hidden on focusable
22

33
## Rule Details
44

docs/rules/accessibility/no-aria-label-misuse-counter.md renamed to docs/rules/accessibility/no-aria-label-misuse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# No aria label misuse counter
1+
# No aria label misuse
22

33
## Rule Details
44

0 commit comments

Comments
 (0)