Add clarification for otel-js apps written in CJS and ESM #8666
Conversation
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
Member
Author
|
I've incorporated the feedback from the original PR, and created new as I wasn't sure what would be easiest to review. Happy to reopen the old if that's better. |
vitorvasc
reviewed
Dec 18, 2025
Member
vitorvasc
left a comment
vitorvasc
left a comment
There was a problem hiding this comment.
Hi @JamieDanielson, thanks for this!
I left a small suggestion from a technical perspective so we can reuse these without needing to copy and paste.
vitorvasc
reviewed
Dec 18, 2025
Member
|
/fix:refcache |
Contributor
|
✅ |
cartermp
approved these changes
Dec 18, 2025
Contributor
cartermp
left a comment
cartermp
left a comment
There was a problem hiding this comment.
Overall LGTM, but I recommend moving the second notice in the nodejs.md file down under Troubleshooting.
vitorvasc
reviewed
Dec 19, 2025
|
|
||
| {{% /tab %}} {{< /tabpane >}} | ||
|
|
||
| {{% include esm-support-node.md %}} |
Member
There was a problem hiding this comment.
I'm not sure which one is intended, but the file is currently named sm-support-note.md, while the includes are referring to it as esm-support-node.md:
Suggested change
| {{% include esm-support-node.md %}} | |
| {{% include esm-support-note.md %}} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Node.js has two module systems: CommonJS(CJS) and ECMAScript modules(ESM). As ESM becomes more common in usage, we need to better document the current assumptions and requirements.
This is a start with the bare minimum, which is to specify the assumption that the app is running as CJS... as well as document the loader hook currently required for ESM apps. It seemed useful to start here based on issues like #4812.