fix unfriendly error; add ESM examples for root hook plugins; closes #4310 #4311
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
- re-enable parallel-mode root hook plugin tests - refactor root hook plugin tests to avoid flake Signed-off-by: Christopher Hiller <boneskull@boneskull.com>
boneskull
added
type: bug
|
Just so we understand what's happening with the error. This is the current behavior. Given: // foo.js
export const foo = 1;Running this $ mocha --require foo.jsyou get With my change, you get instead which is the root problem. (file must end in |
|
I considered trying to make this even friendlier--e.g., "invalid use of ESM, please see node docs". however, just because a file throws a |
nicojs
approved these changes
Jun 5, 2020
There was a problem hiding this comment.
A small test improvement suggestion, but this can land as is as well.
I was thinking, do we maybe want to refer to root hooks as being test "setup" functions as well? That way users that are searching for "setup" also endup at these docs. If you agree I can create a PR for it.
docs/index.md
Outdated
| @@ -1316,7 +1335,9 @@ Available root hooks and their behavior: | |||
| The root hook callbacks run in the usual context, so `this` is available: | |||
There was a problem hiding this comment.
Suggested change
| The root hook callbacks run in the usual context, so `this` is available: | |
| The root hook callbacks run in the usual context, so `this` will refer to the current mocha context: |
|
this is a drawback to using ctrl-f for searching. we can’t attach keywords or metadata to a section... in general I’d like to avoid using multiple terminology for the same idea. “setup” is a “before each” hook in the tdd interface, for example, so it’d conflict |
Signed-off-by: Christopher Hiller <boneskull@boneskull.com>
boneskull
force-pushed
the
boneskull/issue/4310-esm-root-hook-docs
branch
from
4fe1ab5
to
66f16d1
Compare
This was referenced Jun 7, 2020
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.
This PR conflates two things, and I apologize.
I've updated the docs to show how to use ESM with root hook plugins.
I've also added a fix in the case that the
middlewarefails. It looks like yargs does not handle async middleware rejections properly--it fails to trap any error, and instead prints an unrelated problem. So, ifhandleRequiresorvalidatePluginfails, we need to trap that error ourself and print it, then force yargs to exit before thefailhandler can take over.Also contains refactors of
test/integration/options/require.spec.js, which was driving me nuts due to the nondeterministic parallel tests. It was also confusing as hell anyway, so hopefully the result is a little easier to stomach (it's still a hack).