Skip to content

Conversation

@MaxBlack-dev
Copy link
Contributor

Description

This PR adds documentation for the \gypfile\ field in package.json, which was previously undocumented.

Changes

  • Added a new section documenting the \gypfile\ field
  • Explained that npm automatically builds packages with binding.gyp using node-gyp
  • Documented that setting \gypfile: false\ prevents automatic building
  • Included example showing how to disable the automatic build

Fixes

Closes #6898

Context

The \gypfile\ field is currently respected by
pm rebuild\ (as documented in the rebuild command docs), but the field itself was not documented in the package.json specification. This change ensures users understand how to control node-gyp build behavior for native addons.

Type of Change

  • Documentation update

@MaxBlack-dev MaxBlack-dev requested a review from a team as a code owner November 29, 2025 23:40
@owlstronaut owlstronaut merged commit a864f80 into npm:latest Dec 1, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] package.json#gypfile is not documented

2 participants