node-gyp is a cross-platform command-line tool written in Node.js for
compiling native addon modules for Node.js. It contains a vendored copy of the
gyp-next project that was previously used
by the Chromium team, extended to support the development of Node.js native addons.
Note that node-gyp is not used to build Node.js itself.
Multiple target versions of Node.js are supported (i.e. 0.8, ..., 4, 5, 6,
etc.), regardless of what version of Node.js is actually installed on your system
(node-gyp downloads the necessary development files or headers for the target version).
Features
The same build commands work on any of the supported platforms
Supports the targeting of different versions of Node.js
Installation
You can install node-gyp using npm:
npm install -g node-gyp
Depending on your operating system, you will need to install:
You also need to install the XCode Command Line Tools by running xcode-select --install. Alternatively, if you already have the full Xcode installed, you can find them under the menu Xcode -> Open Developer Tool -> More Developer Tools.... This step will install clang, clang++, and make.
Install all the required tools and configurations using Microsoft's windows-build-tools using npm install --global windows-build-tools from an elevated PowerShell or CMD.exe (run as Administrator).
To target native ARM64 Node.js on Windows 10 on ARM, add the components "Visual C++ compilers and libraries for ARM64" and "Visual C++ ATL for ARM64".
Configuring Python Dependency
node-gyp requires that you have installed a compatible version of Python, one of: v2.7, v3.5, v3.6,
v3.7, or v3.8. If you have multiple Python versions installed, you can identify which Python
version node-gyp should use in one of the following ways:
by setting the --python command-line option, e.g.:
If node-gyp is called by way of npm, and you have multiple versions of
Python installed, then you can set npm's 'python' config key to the appropriate
value:
npm config set python /path/to/executable/python
If the PYTHON environment variable is set to the path of a Python executable,
then that version will be used, if it is a compatible version.
If the NODE_GYP_FORCE_PYTHON environment variable is set to the path of a
Python executable, it will be used instead of any of the other configured or
builtin Python search paths. If it's not a compatible version, no further
searching will be done.
How to Use
To compile your native addon, first go to its root directory:
cd my_node_addon
The next step is to generate the appropriate project build files for the current
platform. Use configure for that:
node-gyp configure
Auto-detection fails for Visual C++ Build Tools 2015, so --msvs_version=2015
needs to be added (not needed when run by npm as configured above):
node-gyp configure --msvs_version=2015
Note: The configure step looks for a binding.gyp file in the current
directory to process. See below for instructions on creating a binding.gyp file.
Now you will have either a Makefile (on Unix platforms) or a vcxproj file
(on Windows) in the build/ directory. Next, invoke the build command:
node-gyp build
Now you have your compiled .node bindings file! The compiled bindings end up
in build/Debug/ or build/Release/, depending on the build mode. At this point,
you can require the .node file with Node.js and run your tests!
Note: To create a Debug build of the bindings file, pass the --debug (or
-d) switch when running either the configure, build or rebuild commands.
The binding.gyp file
A binding.gyp file describes the configuration to build your module, in a
JSON-like format. This file gets placed in the root of your package, alongside
package.json.
A barebones gyp file appropriate for building a Node.js addon could look like: