docs: Explain environment variables from package.json, .npmrc and npm
#7856
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
mbtools
reviewed
Apr 29, 2025
wraithgar
reviewed
Apr 30, 2025
| The package.json fields are tacked onto the `npm_package_` prefix. So, | ||
| for instance, if you had `{"name":"foo", "version":"1.2.5"}` in your | ||
| package.json file, then your package scripts would have the | ||
| `npm_package_name` environment variable set to "foo", and the |
There was a problem hiding this comment.
These still exist and are very load bearing
$ npm run env|grep name
npm_package_name=npmThere was a problem hiding this comment.
isn't this what the extended example includes (L282)?
There was a problem hiding this comment.
No the name/version entries are distinct from the config. They are powered by entries in package.json and can't be change via config.
There was a problem hiding this comment.
the example matches the code:
Agree. We should be more explicit. How about:
- Only
name,version,engines,config, andbinfrompackage.jsonare available. Other fields are not exposed as environment variables (see RFC). If you want to know what is inpackage.json, you can read and parse the file or userequire('./package.json'), for example.
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.
Environment variables explanation was incorrect before.
I haven't been able to get any more env vars from the package.json other than the name, version, engines, config and bin. If more env vars are populated, I'll adjust the documentation, but they're the only ones afaict