-
-
Notifications
You must be signed in to change notification settings - Fork 16
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
Adding constraints around naming test waiters #126
Conversation
@rwjblue bump. |
57669f0
to
1c32503
Compare
@@ -25,6 +25,7 @@ This addon implements the design specified in [RFC 581](https://github.com/ember | |||
- [Installation](#installation) | |||
- [Quickstart](#quickstart) | |||
- [buildWaiter function](#buildwaiter-function) | |||
- [Waiter naming conventions](#waiter-naming-conventions) |
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.
Should this be down in the best practices section, with a link from here?
@@ -59,17 +60,31 @@ that provides a number of methods. The key methods that allow you to control asy | |||
a pair to _begin_ waiting and _end_ waiting respectively. The `beginAsync` method returns a `token`, which uniquely identifies that async operation. To mark the | |||
async operation as complete, call `endAsync`, passing in the `token` that was returned from the prior `beginAsync` call. | |||
|
|||
#### Waiter naming conventions |
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.
Can you add a link to the eslint-plugin-ember
rule docs in this section too?
This PR adds some constrains around the naming of test waiters. Specifically, it adds a pattern (
namespace:descriptor
) for test waiters in order to help identify them. Currently this is implemented as a warning, to avoid a breaking change.README changes.