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

chore(deps): Bump eslint-plugin-primer-react to v5.4.0 and update the code accordingly #4766

Merged
merged 7 commits into from
Aug 11, 2024

Conversation

broccolinisoup
Copy link
Member

@broccolinisoup broccolinisoup commented Jul 23, 2024

Closes #

Changelog

New

Changed

  • Update the eslint-plugin-primer-react
  • Remove primer-react/no-deprecated-colors
  • Mark primer-react/a11y-use-next-tooltip rule as off
  • Fix the usages according to the rules and disable some of them (please see comments on the code.)

Removed

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Testing & Reviewing

Merge checklist

Copy link

changeset-bot bot commented Jul 23, 2024

🦋 Changeset detected

Latest commit: b51bca3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added the staff Author is a staff member label Jul 23, 2024
Copy link
Contributor

github-actions bot commented Jul 23, 2024

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 96.05 KB (+0.06% 🔺)
packages/react/dist/browser.umd.js 96.29 KB (-0.03% 🔽)

@@ -89,6 +88,7 @@ module.exports = {
'github/no-inner-html': 'off',
'github/role-supports-aria-props': 'off',
'no-restricted-syntax': 'off',
'primer-react/a11y-use-next-tooltip': 'off',
Copy link
Member Author

Choose a reason for hiding this comment

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

I disabled this because of having the source code of Tooltip v1 in this repo 🫠 We don't want eslint fixing our tooltip v1.

As far as I have checked, we don't use any Tooltip v1 under the hood. So I think keeping this rule disabled until we remove the Tooltip v1 component is fine. Let me know if you think otherwise or if I missed anything!

@@ -75,7 +75,6 @@ module.exports = {
],
},
],
'primer-react/no-deprecated-colors': ['warn', {checkAllStrings: true}],
Copy link
Member Author

Choose a reason for hiding this comment

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

@@ -41,6 +41,7 @@ export const GroupWithSubtleTitleOldAPI = () => {
under features.
</p>
<ActionList selectionVariant="multiple" role="menu" showDividers aria-label="Reviewers">
{/* eslint-disable-next-line primer-react/no-deprecated-props */}
Copy link
Member Author

Choose a reason for hiding this comment

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

we intentionally keep the deprecated API for VRT.

@@ -162,6 +162,7 @@ export const NestedScrollContainer: StoryFn = args => (
<Placeholder label="Header" height={64} />
</PageLayout.Header>
<PageLayout.Content padding="normal" width="large">
{/* eslint-disable-next-line github/a11y-role-supports-aria-props */}
Copy link
Member Author

Choose a reason for hiding this comment

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

@TylerJDev can we fix these violations??

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like it was turned off in eslint-plugin-github, so I'd say yes!

<IconButton
unsafeDisableTooltip={true}
Copy link
Member Author

Choose a reason for hiding this comment

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

this component is not maintained anymore and the tests are dramatically failing when the icon button is enabled. So I simply disabled. Let me know if you have any concern 🙌🏻

@broccolinisoup broccolinisoup changed the title Update primer-react eslint plugin and update the code accordignly chore(deps): Bump eslint-plugin-primer-react to v5.4.0 and update the code accordingly Jul 23, 2024
@broccolinisoup broccolinisoup marked this pull request as ready for review July 23, 2024 06:07
@broccolinisoup broccolinisoup requested a review from a team as a code owner July 23, 2024 06:07
@broccolinisoup broccolinisoup added this pull request to the merge queue Aug 11, 2024
Merged via the queue into main with commit e74e581 Aug 11, 2024
30 checks passed
@broccolinisoup broccolinisoup deleted the eslint-bump-v5.4.0 branch August 11, 2024 23:11
@primer primer bot mentioned this pull request Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
staff Author is a staff member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants