Skip to content

Conversation

@sfc-gh-bnisco
Copy link
Collaborator

@sfc-gh-bnisco sfc-gh-bnisco commented Oct 28, 2024

Describe your changes

  • Based on some feedback in [chore] Modernize SettingsDialog #9684 this PR introduces a new lint rule for RTL, encouraging usage of user-event.
  • user-events gives us greater confidence in the way we write tests because "fireEvent dispatches DOM events, whereas user-event simulates full interactions, which may fire multiple events and do additional checks along the way." [docs]
  • This PR adds inline disable comments to any usages that are currently in violation, so there should be no changes to code as written today.

GitHub Issue Link (if applicable)

Testing Plan

  • Explanation of why no additional tests are needed
  • Unit Tests (JS and/or Python) ✅
  • E2E Tests
  • Any manual testing needed?

Contribution License Agreement

By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

@sfc-gh-bnisco sfc-gh-bnisco added security-assessment-completed Security assessment has been completed for PR impact:internal PR changes only affect internal code change:chore PR contains maintenance or housekeeping change labels Oct 28, 2024
@sfc-gh-bnisco sfc-gh-bnisco marked this pull request as ready for review October 28, 2024 18:52
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the bnisco/rtl-eslint branch 2 times, most recently from dea2597 to a35b3bb Compare October 30, 2024 18:40
@sfc-gh-bnisco sfc-gh-bnisco merged commit c2b034c into develop Nov 20, 2024
28 checks passed
@sfc-gh-bnisco sfc-gh-bnisco deleted the bnisco/rtl-eslint branch November 20, 2024 17:08
edegp pushed a commit to edegp/streamlit that referenced this pull request Jan 19, 2025
## Describe your changes

- Based on some feedback in
streamlit#9684 this PR introduces a
new lint rule for RTL, encouraging usage of user-event.
- user-events gives us greater confidence in the way we write tests
because "fireEvent dispatches DOM events, whereas user-event simulates
full interactions, which may fire multiple events and do additional
checks along the way."
[[docs](https://testing-library.com/docs/user-event/intro/)]
- This PR adds inline disable comments to any usages that are currently
in violation, so there should be no changes to code as written today.

## GitHub Issue Link (if applicable)

## Testing Plan

- Explanation of why no additional tests are needed
- Unit Tests (JS and/or Python) ✅
- E2E Tests
- Any manual testing needed?

---

**Contribution License Agreement**

By submitting this pull request you agree that all contributions to this
project are made under the Apache 2.0 license.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

change:chore PR contains maintenance or housekeeping change impact:internal PR changes only affect internal code security-assessment-completed Security assessment has been completed for PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants