node-gyp 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.| Name | Version | Size | License | Type | Vulnerabilities |
|---|---|---|---|---|---|
| fstream | 1.0.12 | 16.61 kB | ISC | prod | |
| glob | 7.2.3 | 15.08 kB | ISC | prod | |
| graceful-fs | 4.2.11 | 9.57 kB | ISC | prod | |
| minimatch | 3.1.2 | 11.66 kB | ISC | prod | |
| mkdirp | 0.5.6 | 2.95 kB | MIT | prod | |
| nopt | 3.0.6 | 10.07 kB | ISC | prod | |
| npmlog | 3.1.2 | 6.08 kB | ISC | prod | |
| osenv | 0.1.5 | 2.25 kB | ISC | prod | |
| path-array | 1.0.1 | 3.9 kB | MIT | prod | 1 |
| request | 2.88.2 | 57.83 kB | Apache-2.0 | prod | 3 2 |
| rimraf | 2.7.1 | 5.53 kB | ISC | prod | |
| semver | 5.7.2 | 17.45 kB | ISC | prod | |
| tar | 2.2.2 | 211.58 kB | ISC | prod | 3 |
| which | 1.3.1 | 4.08 kB | ISC | prod |
Node-gyp is a cross-platform command-line tool created with Node.js that is used for compiling native addon modules for Node.js. It's designed to work on multiple target versions of Node.js, irrespective of which version of Node.js is installed on your system. Node-gyp achieves this by downloading the required development files or headers for the targeted version. It's important to note that while node-gyp aids in the development of Node.js native addons, it is not utilized for building Node.js itself.
Utilizing node-gyp requires a few steps. First, you need to install it through npm by running npm install -g node-gyp in your terminal. Node-gyp has dependencies on Python, make and a C/C++ compiler toolchain like GCC on Unix, Python and XCode Command Line Tools on macOS, and Python and Visual C++ Build Environment on Windows, so ensure these are correctly installed on your system.
Once installed and dependencies are resolved, using node-gyp involves generating project build files and then invoking the build command. Here's a simple usage example for your native addon:
cd my_node_addon
node-gyp configure
node-gyp build
In this example, you first navigate to the root directory of your native addon, generate the necessary project build files for your platform using the configure command, and then build your native addon with the build command. The compiled bindings will be found in build/Debug/ or build/Release/ depending on your build mode.
You can access the detailed and extensive node-gyp documentation in the docs directory on the package's GitHub repository link: node-gyp Github repository. This documentation provides additional information on specific node-gyp topics which can come in handy when installing or building addons using node-gyp. It also has the command and configuration options for finer control over your builds.
