This repository has been archived by the owner on Jul 6, 2021. It is now read-only.
Entries: Document before and after module hooks #118
Merged
Conversation
This file contains 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
| </p> | ||
| <p> | ||
| The module's callback is invoked with the test environment as its <code>this</code> context, with the environment's properties copied to the module's tests, hooks, and nested modules. Note that changes on tests' <code>this</code> won't affect sibling tests, where <code>this</code> will be reset to the same value for each test. | ||
| The module's callback is invoked with the test environment as its <code>this</code> context, with the environment's properties copied to the module's tests, hooks, and nested modules. Note that changes on tests' <code>this</code> are not preserved between sibling tests, except when made in the <code>before</code> hook. In all other cases, <code>this</code> will be reset to the initial value for each test. |
There was a problem hiding this comment.
except when made in the <code>before</code> hook. The phrase is already a reference for changes on each test not affecting sibling tests, the before hook is not one of them.
There was a problem hiding this comment.
Good point, will remove that.
|
It is looking good, only a single comment above |
trentmwillis
force-pushed
the
before-after
branch
from
5e920c2 to
c10a1b3
Compare
|
Updated. Let me know if there any other edits. |
|
It LGTM. @gibson042, would you like to check? |
| @@ -36,13 +42,13 @@ | |||
| If <code>QUnit.module</code> is defined without a <code>nested</code> callback argument, all subsequently defined tests will be grouped into the module until another module is defined. | |||
| </p> | |||
| <p> | |||
| Modules with grouped test functions allow defining nested modules, and QUnit will run tests on the parent module before going deep on the nested ones, even if they're declared first. The <code>beforeEach</code> and <code>afterEach</code> callbacks on a nested module call will stack (<a href="https://en.wikipedia.org/wiki/Stack_%28abstract_data_type%29">LIFO - last in, first out</a>) to the parent hooks. | |||
| Modules with grouped test functions allow defining nested modules, and QUnit will run tests on the parent module before going deep on the nested ones, even if they're declared first. Any hook callbacks on a nested module call will stack (<a href="https://en.wikipedia.org/wiki/Stack_%28abstract_data_type%29">LIFO - last in, first out</a>) to the parent hooks. | |||
There was a problem hiding this comment.
Preexisting issue, but only the "after" hooks form a stack—"before" hooks form a queue. This might be better characterized as the parent hooks wrapping nested ones.
There was a problem hiding this comment.
Good point, will correct that.
trentmwillis
force-pushed
the
before-after
branch
from
c10a1b3 to
b80675a
Compare
|
@gibson042 updated to address your comment. |
|
LGTM. |
trentmwillis
force-pushed
the
before-after
branch
from
b80675a to
cda8081
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Adds documentation for the
before/aftermodule hooks introduced in qunitjs/qunit#919.cc @leobalter