Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump eslint-plugin-jsx-a11y to 6.7.1 #395

Merged
merged 4 commits into from Feb 6, 2023
Merged

Conversation

khiga8
Copy link
Contributor

@khiga8 khiga8 commented Feb 3, 2023

Fixes: https://github.com/github/accessibility/issues/2917

This PR bumps the eslint-plugin-jsx-a11y dependency from 6.6.0 to 6.7.1 which includes new rules and bug fixes.

Check out the CHANGELOG for eslint-plugin-jsx-a11y.

This update includes a new rule anchor-ambiguous-text which can replace our custom a11y-no-generic-link-text.

馃摚 Any "best practice" or existing practice for deprecating a rule? I've just marked the rule as deprecated and removed it from the config.

'github/role-supports-aria-props': 'error',
'jsx-a11y/role-supports-aria-props': 'off',
'jsx-a11y/no-aria-hidden-on-focusable': 'error',
'jsx-a11y/anchor-ambiguous-text': [
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This rule replaces our a11y-no-generic-link-text. We need to explicitly enable it because its part of the jsx-a11y/strict ruleset.

Maybe we want to enable the strict ruleset but I don't know, I think we need to review it.

'jsx-a11y/anchor-ambiguous-text': [
'error',
{
words: ['this', 'more', 'read here', 'read more'],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Rules in addition to the defaults.

anchor-ambiguous-text rule options

@@ -1,4 +1,6 @@
# No Generic Link Text
# No Generic Link Text [Deprecated]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

馃摚 Any "best practice" or existing practice for deprecating a rule? I've just marked the rule as deprecated and removed it from the config.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think if github/a11y-no-generic-link-text has been completely removed form the code base then you could just delete this document altogether!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh okay! I haven't removed the code yet. For this immediate release I will keep it marked as deprecated, then delete it entirely in follow-ups.

@khiga8 khiga8 marked this pull request as ready for review February 3, 2023 15:39
@khiga8 khiga8 requested a review from a team as a code owner February 3, 2023 15:39
Copy link
Contributor

@theinterned theinterned left a comment

Choose a reason for hiding this comment

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

Looks good!

@@ -1,4 +1,6 @@
# No Generic Link Text
# No Generic Link Text [Deprecated]
Copy link
Contributor

Choose a reason for hiding this comment

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

I think if github/a11y-no-generic-link-text has been completely removed form the code base then you could just delete this document altogether!

@khiga8 khiga8 merged commit 759a37b into main Feb 6, 2023
@khiga8 khiga8 deleted the kh-bump-eslint-dependency branch February 6, 2023 16:31
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.

None yet

2 participants