docs: fix esm loader options in ESM stubbing guide - #2767
Open
alorentiar wants to merge 1 commit into
Open
Conversation
mutableNamespace is a cjs sub-option according to the esm docs. Passed as a top-level key, esm refuses it at startup (Unknown esm option: mutableNamespace), so the loader file in the example never ran. Fixes sinonjs#2714.
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.
The loader example in this guide passes
mutableNamespaceas a top-levelesm option:
esm only reads it under
cjs(see the options table in its README), and itrejects unknown top-level keys, so this loader actually fails on startup with
Unknown esm@3.2.25 option: mutableNamespace. I reproduced that with mocha +esm on an older Node (esm only runs there), then confirmed the corrected
options load cleanly.
Moved the flag under
cjsin both places it appears. Keeping it scoped tothe reported config issue.
Refs #2714