Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs(scripts): update npm_package_* environment variables documentation #8821

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.

Sign up for GitHub

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

Jump to bottom
Merged
owlstronaut merged 1 commit into from
Dec 4, 2025
Merged

docs(scripts): update npm_package_* environment variables documentation #8821

owlstronaut merged 1 commit into from
Dec 4, 2025
+21 −2

Conversation

@MaxBlack-dev
Copy link
Contributor

@MaxBlack-dev MaxBlack-dev commented Dec 3, 2025

Description

This PR updates the npm_package_* environment variables documentation to reflect the changes made in npm 7.

Changes

  • Listed the specific environment variables that npm still provides in npm 7+
  • Added note explaining that most package.json fields are no longer provided as environment variables
  • Documented that npm_package_json provides the path to package.json for scripts that need to read other fields

Context

In npm 7, the behavior changed from providing all package.json fields as environment variables to only providing a specific subset. This was documented in RFC 21. The old documentation was misleading as it suggested all fields were still available.

Fixes

Fixes #2452

@MaxBlack-dev MaxBlack-dev requested a review from a team as a code owner December 3, 2025 21:04
owlstronaut
owlstronaut requested changes Dec 3, 2025
View reviewed changes
Copy link
Contributor

@owlstronaut owlstronaut left a comment

Choose a reason for hiding this comment

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

Are you open to documenting the install-specific envars that aren't currently documented anywhere?

cli/workspaces/arborist/lib/arborist/rebuild.js

Lines 310 to 316 in aa1dd7e

npm_package_resolved: resolved,
npm_package_integrity: integrity,
npm_package_json: resolve(path, 'package.json'),
npm_package_optional: boolEnv(optional),
npm_package_dev: boolEnv(dev),
npm_package_peer: boolEnv(peer),
npm_package_dev_optional:

Also, i don't think main is actually included. I'm not sure if that was missed last time this was updated or why, but it isn't here and in my local tests I'm not seeing a value.

@MaxBlack-dev MaxBlack-dev force-pushed the docs/2452-update-npm-package-vars-clean branch from 2329a66 to 09455b7 Compare December 4, 2025 19:23
@MaxBlack-dev
Copy link
Contributor Author

MaxBlack-dev commented Dec 4, 2025

Thank you for the review! I've updated the documentation based on your feedback:

Changes Made

  1. Removed npm_package_main - You're correct, this is not actually provided. I verified this in the source code at node_modules/@npmcli/run-script/lib/package-envs.js which only exports name, version, config, engines, and bin.

  2. Added install-specific environment variables - Documented the additional variables that are set during install scripts (preinstall, install, postinstall):

    • npm_package_resolved - The resolved URL for the package
    • npm_package_integrity - The integrity hash for the package
    • npm_package_optional - Set to "true" if the package is optional
    • npm_package_dev - Set to "true" if the package is a dev dependency
    • npm_package_peer - Set to "true" if the package is a peer dependency
    • npm_package_dev_optional - Set to "true" if the package is both dev and optional

These are sourced from workspaces/arborist/lib/arborist/rebuild.js lines 310-316 as you referenced.

The updated documentation now accurately reflects what environment variables are actually available to scripts.

owlstronaut
owlstronaut approved these changes Dec 4, 2025
View reviewed changes
Copy link
Contributor

@owlstronaut owlstronaut left a comment

Choose a reason for hiding this comment

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

Perfect, thank you!

@owlstronaut owlstronaut merged commit 33a50d7 into npm:latest Dec 4, 2025
8 checks passed
@github-actions github-actions bot mentioned this pull request Dec 3, 2025
Merged
@npm-cli-bot npm-cli-bot mentioned this pull request Dec 9, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@owlstronaut owlstronaut owlstronaut approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[BUG] Broken link in npm v7 series beta re. $npm_package_* environment variables (now gone)

2 participants

@MaxBlack-dev @owlstronaut