fix: allow user to add Vitepress configuration to ESM packages #339
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.
If users have a
type: module
entry in theirpackage.json
, they cannot use VitePress with aconfig.js
file.Reproduction
and also a
"type": "module"
entry to thepackage.json
file, so that itbecomes:
Then, adding a
docs/.vitepress/config.js
as suggested hereThis will result in a typical ERR_REQUIRE_ESM error:
Proposed fix
This change makes it so that
config.cjs
is searched beforeconfig.js
. Node's 'require' function allows files with such extensions to be loaded even from within an ES module project.