search

aryella-lacerda / react-native-accessibility-engine

Make accessibility-related assertions on React Native code using React Test Renderer
MIT License
165 stars 13 forks source link

docs: add checked-state-required to README #312

Closed emilyseibert closed 1 year ago

emilyseibert commented 1 year ago

I noticed that the new rule wasn't included in the README. Here's a quick README change to keep the docs up to date :)

emilyseibert commented 1 year ago

@aryella-lacerda also have this PR to help out with docs :)

codecov[bot] commented 1 year ago

Codecov Report

Base: 98.94% // Head: 99.47% // Increases project coverage by +0.52% :tada:

Coverage data is based on head (e88b5b8) compared to base (d6bfa15). Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #312 +/- ## ========================================== + Coverage 98.94% 99.47% +0.52% ========================================== Files 28 31 +3 Lines 190 191 +1 Branches 47 44 -3 ========================================== + Hits 188 190 +2 + Misses 2 1 -1 ``` | [Impacted Files](https://codecov.io/gh/aryella-lacerda/react-native-accessibility-engine/pull/312?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Aryella+Lacerda) | Coverage Δ | | |---|---|---| | [src/\_\_tests\_\_/assets/checkbox\_512px.png](https://codecov.io/gh/aryella-lacerda/react-native-accessibility-engine/pull/312/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Aryella+Lacerda#diff-c3JjL19fdGVzdHNfXy9hc3NldHMvY2hlY2tib3hfNTEycHgucG5n) | `100.00% <ø> (ø)` | | | [src/rules/index.ts](https://codecov.io/gh/aryella-lacerda/react-native-accessibility-engine/pull/312/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Aryella+Lacerda#diff-c3JjL3J1bGVzL2luZGV4LnRz) | `100.00% <ø> (ø)` | | | [src/helpers/isCheckbox/isCheckbox.ts](https://codecov.io/gh/aryella-lacerda/react-native-accessibility-engine/pull/312/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Aryella+Lacerda#diff-c3JjL2hlbHBlcnMvaXNDaGVja2JveC9pc0NoZWNrYm94LnRz) | `100.00% <100.00%> (ø)` | | | [src/rules/checked-state-required/index.ts](https://codecov.io/gh/aryella-lacerda/react-native-accessibility-engine/pull/312/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Aryella+Lacerda#diff-c3JjL3J1bGVzL2NoZWNrZWQtc3RhdGUtcmVxdWlyZWQvaW5kZXgudHM=) | `100.00% <100.00%> (ø)` | | | [src/matchers/toBeAccessible.ts](https://codecov.io/gh/aryella-lacerda/react-native-accessibility-engine/pull/312/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Aryella+Lacerda#diff-c3JjL21hdGNoZXJzL3RvQmVBY2Nlc3NpYmxlLnRz) | `100.00% <0.00%> (ø)` | | | [src/engine/index.tsx](https://codecov.io/gh/aryella-lacerda/react-native-accessibility-engine/pull/312/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Aryella+Lacerda#diff-c3JjL2VuZ2luZS9pbmRleC50c3g=) | `100.00% <0.00%> (+2.94%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Aryella+Lacerda). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Aryella+Lacerda)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.