-
Notifications
You must be signed in to change notification settings - Fork 14
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
Change matcher format() to description() #918
Conversation
🦋 Changeset detectedLatest commit: 9e4d8b2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
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 |
e11faf1
to
2bc0425
Compare
A preview package of this pull request has been published with the tag $ npm install @bigtest/interactor@mk_matcher-format-rename or by updating your package.json to: {
"@bigtest/interactor": "mk_matcher-format-rename"
} |
2bc0425
to
9ab6f59
Compare
4cddaee
to
5113db3
Compare
5113db3
to
9e4d8b2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍🏻
Motivation
Currently if someone wants to construct their own matcher, they have to pass in an object that looks like this:
But with this new refactor, we're renaming
format
todescription
:This will resolve #906.
Approach
formatMatcher
todescriptionMatcher
, I flipped it to saymatcherDescription
as that seems more descriptive in my opinion.matcher().description()
as that's not something a user would be invoking themselves.matching
matcher with the oldformat
API to ensure it still works (but will output a deprecation message in the console).TODOs
I should probably keepDid.format()
in to output a message to say it's deprecated...?