-
-
Notifications
You must be signed in to change notification settings - Fork 6.5k
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
feat(jest-util): add requireOrImportModule util for importing CJS or ESM #11199
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
7aa6e53
feat(jest-util): add importModule for importing CJS or ESM
WeiAnAn f6cf308
refactor(jest-transform): refactor import transformer logic to import…
WeiAnAn b464cff
rename importModule to requireOrImportModule
WeiAnAn cb22e4f
change filePath type to Config.Path
WeiAnAn 4784cc7
verify requireOrImportModule path must be absolute
WeiAnAn 2884d03
add copyright header
WeiAnAn 9eaf3d7
refactor(jest-config): refactor using requireOrImportModule for load…
WeiAnAn 75479c8
throw error if not support dynamic import
WeiAnAn File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/** | ||
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
import {isAbsolute} from 'path'; | ||
import {pathToFileURL} from 'url'; | ||
import type {Config} from '@jest/types'; | ||
import interopRequireDefault from './interopRequireDefault'; | ||
|
||
export default async function requireOrImportModule<T>( | ||
filePath: Config.Path, | ||
): Promise<T> { | ||
let module: T; | ||
if (!isAbsolute(filePath) && filePath[0] === '.') { | ||
throw new Error(`Jest: requireOrImportModule path must be absolute`); | ||
} | ||
try { | ||
module = interopRequireDefault(require(filePath)).default; | ||
} catch (error) { | ||
if (error.code === 'ERR_REQUIRE_ESM') { | ||
try { | ||
const configUrl = pathToFileURL(filePath); | ||
|
||
// node `import()` supports URL, but TypeScript doesn't know that | ||
const importedConfig = await import(configUrl.href); | ||
|
||
if (!importedConfig.default) { | ||
throw new Error( | ||
`Jest: Failed to load ESM at ${filePath} - did you use a default export?`, | ||
); | ||
} | ||
|
||
module = importedConfig.default; | ||
} catch (innerError) { | ||
if (innerError.message === 'Not supported') { | ||
throw new Error( | ||
`Jest: Your version of Node does not support dynamic import - please enable it or use a .cjs file extension for file ${filePath}`, | ||
); | ||
} | ||
throw innerError; | ||
} | ||
} else { | ||
throw error; | ||
} | ||
} | ||
return module; | ||
} |
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.
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.
All LTS Node should support dynamic import after Node 10 EOL.
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.
Yep. Jest 27 will support Node 10, but 28 will drop it
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.
so we should keep the warning for now