Conversation
✅ Deploy Preview for rstest-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation explaining CommonJS interoperability limitations in Rstest when outputting ES modules. It addresses issue #858 by documenting that Rstest does not support interpreting CommonJS module default exports as named exports, and provides a workaround using explicit external type configuration.
Changes:
- Added comprehensive CommonJS interop documentation section explaining behavior and limitations
- Enhanced test fixtures to demonstrate working interop scenarios with both default and named exports
- Simplified test-lodash fixture to clearly show the unsupported CommonJS pattern
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/config/build/output.mdx | Added English documentation section explaining CommonJS interop behavior, limitations, and workaround |
| website/docs/zh/config/build/output.mdx | Added Chinese documentation section with same content as English version |
| e2e/externals/fixtures/test-pkg/interopDefault.ts | Updated to import and export both default and named export 'a' from test-interop |
| e2e/externals/fixtures/test-lodash/index.js | Simplified to minimal CommonJS pattern demonstrating unsupported use case |
| e2e/externals/fixtures/test-interop/index.js | Added named export 'a' alongside existing default export |
| e2e/externals/fixtures/interopDefault.test.ts | Added test assertion for the new named export 'a' |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Currently, Rstest does not support interoping CommonJS module default exports as named exports.
If you encounter issues during usage, you can specify the external type of a dependency as CommonJS through specifying external type.
Related Links
#858
Checklist