docs(readme): document the full locator/interaction/assertion/mocking surface#72
Merged
Merged
Conversation
…ocking surface The README showed 3 of 8 matchers and 2 of 9 interactions, and the mocking section demonstrated the server without route() or the traffic assertions — the Playwright-shaped core of the pitch. Now covered: fill/clear/check/uncheck/press/waitFor/clickableAncestor, locator narrowing (first/last/nth/near/count), all matchers with .not, the did-you-mean failure hint (also reflected in Troubleshooting), mock route().fulfill/reject/abort + toHaveSent/toHaveReceived/send, and an Evidence section with captureState.
cb97bef to
882eac8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Docs-only. The README documented roughly a third of the shipped public surface; this fills the gaps without changing the pitch or structure:
getBy*list plus narrowing —first()/last()/nth()/count()and thenear()relative locator (withmaxDistance).fill()/clear()(the v0.11.0 atomic path),check()/uncheck(),press({ duration }),waitFor(),tap({ clickableAncestor }), andnative.fill(label, text)..not, plus the did-you-mean failure hint shown as a sample error.mock.route().fulfill/reject/abort,expect(mock).toHaveSent/toHaveReceived, andmock.send()— the Playwright-page.route()half of the pitch was previously invisible.captureState("checkpoint").Every example was verified against the current exports (
src/index.tsstar-exports,FrameMatchshape,MockRoutesignatures, locator options) before writing.Proof
npm run checkdocs/readme-overhaul(no code changes).npm testRisk
Notes
scrollIntoView,inspect) — docs should trail merges.PR Proof Law
.agents/DEFINITION_OF_DONE.mdand.agents/skills/pr-inline-screenshot-proof/SKILL.md., or the proof section saysNot applicablewith the technical reason.