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

Prevent an empty list of custom regexes in the DetailsMenuMigration linter from reporting false positives #2997

Merged
merged 2 commits into from
Aug 6, 2024

Conversation

camertron
Copy link
Contributor

What are you trying to accomplish?

A recent PR introduced the ability to add custom regexes to the DetailsMenuMigration linter to provide 3rd-party code a way to customize how the linter identifies violations. Unfortunately if the list of custom regexes is empty, the linter checks all code against an empty regex (eg. //i), which matches every string and therefore always returns true. This results in false-positives for every line of code in the file.

Integration

No changes necessary in production.

Risk Assessment

  • Low risk the change is small, highly observable, and easily rolled back.
  • Medium risk changes that are isolated, reduced in scope or could impact few users. The change will not impact library availability.
  • High risk changes are those that could impact customers and SLOs, low or no test coverage, low observability, or slow to rollback.

What approach did you choose and why?

I modified the linter to skip matching with the custom regexes if the list of custom regexes is empty.

Accessibility

  • No new axe scan violation - This change does not introduce any new axe scan violations.

Merge checklist

  • Added/updated tests
    - [ ] Added/updated documentation
    - [ ] Added/updated previews (Lookbook)
    - [ ] Tested in Chrome
    - [ ] Tested in Firefox
    - [ ] Tested in Safari
    - [ ] Tested in Edge

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

Copy link

changeset-bot bot commented Aug 6, 2024

🦋 Changeset detected

Latest commit: c5160ae

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

This PR includes changesets to release 1 package
Name Type
@primer/view-components 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

@camertron camertron marked this pull request as ready for review August 6, 2024 22:08
@camertron camertron requested a review from a team as a code owner August 6, 2024 22:08
@camertron camertron changed the title Prevent an empty list of custom regexes in the DetailsMenuMigration linter from reporting false-positives Prevent an empty list of custom regexes in the DetailsMenuMigration linter from reporting false positives Aug 6, 2024
Copy link
Contributor

@jamieshark jamieshark left a comment

Choose a reason for hiding this comment

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

thanks for this fix!

@camertron camertron merged commit 0d0b5bc into main Aug 6, 2024
38 checks passed
@camertron camertron deleted the fix_details_menu_migration_linter branch August 6, 2024 22:45
@primer primer bot mentioned this pull request Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants