Skip to content

docs: document gypfile field in package.json #8787

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

Merged
merged 1 commit into from
Dec 1, 2025
+14 −0
Merged

docs: document gypfile field in package.json #8787

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/lib/content/configuring-npm/package-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,6 +511,20 @@ The key is the lifecycle event, and the value is the command to run at that poin

See [`scripts`](/using-npm/scripts) to find out more about writing package scripts.

### gypfile

If you have a binding.gyp file in the root of your package and you have not defined your own `install` or `preinstall` scripts, npm will default to building your module using node-gyp.

To prevent npm from automatically building your module with node-gyp, set `gypfile` to `false`:

```json
{
"gypfile": false
}
```

This is useful for packages that include native addons but want to handle the build process differently, or packages that have a binding.gyp file but should not be built as a native addon.

### config

A "config" object can be used to set configuration parameters used in package scripts that persist across upgrades.
Expand Down
Loading