Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Start migrating rules away from counter system #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 31, 2023
Merged

Conversation

khiga8
Copy link
Collaborator

@khiga8 khiga8 commented Mar 28, 2023

Relates to: #56

This PR starts prepping for deprecation of the counter system which we've used as a way to get around lack of support for inline disables. This is no longer necessary with the latest ERB version which now offers inline disable support.

This PR renames AvoidBothDisabledAndAriaDisabledCounter to be AvoidBothDisabledAndAriaDisabled, deprecating the counter from the name.

The to-be-deprecated counter system will continue to work if it's configured explicitly, so existing counter comments shouldn't break. Basically if ERBLint config is:

AvoidBothDisabledAndAriaDisabled:
  enabled: true
  enable_counter: true

The existing counter comments shouldn't break. We will default to counter system off. We can keep them enabled and turn them off as we migrate each rule.

This PR adds a doc which we will be surfaced during the new release which instructs how to migrate away from counters.
Preview migration doc 🔍 . I am hoping we can also include a script to ease this migration for our release.

If this approach seems fine, I plan to follow-up with every other rule to prep for migration internally.

@@ -55,7 +55,7 @@ linters:

## Rules

- [GitHub::Accessibility::AvoidBothDisabledAndAriaDisabledCounter](./docs/rules/accessibility/avoid-both-disabled-and-aria-disabled-counter.md)
- [GitHub::Accessibility::AvoidBothDisabledAndAriaDisabledCounter](./docs/rules/accessibility/avoid-both-disabled-and-aria-disabled.md)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will remove Counter from names in the README right before we cut release, for alignment with current version.

@khiga8 khiga8 requested a review from jonrohan March 28, 2023 17:45
@khiga8 khiga8 marked this pull request as ready for review March 28, 2023 17:45
@khiga8 khiga8 requested a review from a team as a code owner March 28, 2023 17:45
@khiga8
Copy link
Collaborator Author

khiga8 commented Mar 28, 2023

@jonrohan what do you think of this counter deprecation approach? could it work for PVC too?

update: chatted in person and on board!

@accessibility-bot
Copy link

👋 Hello and thanks for pinging us! An accessibility first responder will review this soon.

  • 💻 On PRs for our review: please provide a review environment with steps to validate, screenshots (with alt text), or videos demonstrating functionality we should be checking. This will help speed up our review and feedback cycle.
  • ⚠️ If this is urgent, please visit us in #accessibility on Slack and tag the first responder(s) listed in the channel topic.

Copy link
Member

@owenniblock owenniblock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excited for this change!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants