Skip to content
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

Docs: Append to NODE_OPTIONS, not overwrite #14730

Merged
merged 6 commits into from
Nov 30, 2023
Merged

Conversation

someone635
Copy link
Contributor

@someone635 someone635 commented Nov 30, 2023

Summary

The suggestion given in the ECMASCRIPT modules docs to add NODE_OPTIONS=--experimental-vm-modules can lead to very hard to track bugs. Debuggers and other tooling can use NODE_OPTIONS, and overwriting it will break them. For me, it was the VSCode debugger that stopped breaking on breakpoints, and it took me the entire day to find this passage in their docs: https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_how-can-i-set-nodeoptions

It seems safer to propose to append to NODE_OPTIONS in the docs, rather than overwriting it.

Test plan

I followed the contributing.md and checked that my changes appears in the website for all versions (including screenshots here only for Next and 29.7 versions for economy of space).

image
image

Related issues:

This issue might be related: #12075

Copy link

linux-foundation-easycla bot commented Nov 30, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link

netlify bot commented Nov 30, 2023

Deploy Preview for jestjs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit dd3839a
🔍 Latest deploy log https://app.netlify.com/sites/jestjs/deploys/65687d7ee0ab900008aeb8f7
😎 Deploy Preview https://deploy-preview-14730--jestjs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good call, thanks!

@SimenB SimenB merged commit e54c0eb into jestjs:main Nov 30, 2023
70 of 73 checks passed
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants