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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make sure recommended.js is up-to-date and dependecies are up-to-date #56

Closed
2 tasks
khiga8 opened this issue Jun 6, 2023 · 7 comments
Closed
2 tasks
Assignees
Labels

Comments

@khiga8
Copy link
Contributor

khiga8 commented Jun 6, 2023

The component to tag mappings in recommended.js have not been updated for a while, and is overdue for a review.

In addition, this library is behind on jsx-a11y and eslint-plugin-github dependency updates.

We have a mapping that is used in eslint-plugin-jsx-a11y and a mapping that is used in eslint-plugin-github. The latter should be deprecated since it was an experimental feature that is deprecated in the latest eslint-plugin-github.

  • Are there any component to tag mappings that should be newly added? (Notably, jsx-a11y supports 1:1 component to tag mapping). However, we should be wary of adding some mappings that could raise a false positive. For example, if we map Avatar to img, but it already sets alt internally default, the ESLint rule may incorrectly flag that there's a missing alt.
  • Are there any component to tag mappings that should be removed?

Acceptance criteria

  • Bump eslint-plugin-github and eslint-plugin-jsx-a11y dependency to the latest
  • Ensure that the configs are up-to-date.
@khiga8 khiga8 changed the title Make sure component mapping used for accessibility linting in recommended.js is up-to-date. Make sure recommended.js is up-to-date and dependecies are up-to-date Jul 11, 2023
@TylerJDev
Copy link
Contributor

Hey @khiga8, this sounds good!

Just to clarify, is the idea to remove the mappings under "github" in the recommended.js file?

As far as the mapping in jsx-a11y, we definitely could add additional mappings. Nothing comes to mind right now, but I can review our current list of components to see if any of them would benefit from being mapped.

@TylerJDev TylerJDev self-assigned this Jul 12, 2023
@khiga8
Copy link
Contributor Author

khiga8 commented Jul 12, 2023

Hey @TylerJDev! We're going to release a new version of eslint-plugin-github hopefully tomorrow, once these two PRs are merged in:

So I would encourage bumping to that version once it's out!

Here's what changed:

@TylerJDev
Copy link
Contributor

Sounds good! I'll create a draft PR that should include some of the changes suggested!

@TylerJDev
Copy link
Contributor

Closing per #67.

@khiga8
Copy link
Contributor Author

khiga8 commented Jul 27, 2023

@TylerJDev should we keep this open until the false positives flags are fixed? 🤔

@TylerJDev
Copy link
Contributor

@khiga8, I was planning on creating a separate issue to track these. But I don't have a preference either way.

@khiga8
Copy link
Contributor Author

khiga8 commented Jul 27, 2023

Ooh that sounds good! Just want to make sure your follow-up efforts are tracked! :)

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

No branches or pull requests

3 participants