Convert Figma logo to code with AI

nodejs logonode-gyp

Node.js native addon build tool

10,190
1,824
10,190
154

Top Related Projects

24,614

C++ Library Manager for Windows, Linux, and MacOS

39,034

An extremely fast bundler for the web

24,388

Package your Node.js project into an executable

6,610

A framework for building compiled Node.js add-ons in Rust via Node-API

Emscripten: An LLVM-to-WebAssembly Compiler

📦✨ your favorite rust -> wasm workflow tool!

Quick Overview

Node-gyp is a cross-platform command-line tool written in Node.js for compiling native addon modules for Node.js. It serves as a build system, automating the process of compiling C and C++ code into native Node.js modules, making it easier for developers to create and distribute native addons.

Pros

  • Cross-platform compatibility (Windows, macOS, and Linux)
  • Simplifies the process of building native addons for Node.js
  • Integrates well with npm for easy distribution of native modules
  • Supports multiple versions of Node.js

Cons

  • Can be challenging to set up, especially on Windows
  • Requires additional system dependencies (e.g., Python, C++ compiler)
  • May encounter compatibility issues with certain Node.js versions
  • Documentation can be overwhelming for beginners

Getting Started

To use node-gyp, follow these steps:

  1. Install node-gyp globally:

    npm install -g node-gyp
    
  2. Ensure you have the necessary system requirements:

    • Python (v2.7, v3.5, v3.6, v3.7, or v3.8)
    • make (on Unix platforms)
    • A proper C/C++ compiler toolchain (GCC on Linux, Xcode on macOS, or Visual Studio on Windows)
  3. Create a binding.gyp file in your project root:

    {
      "targets": [
        {
          "target_name": "addon",
          "sources": [ "addon.cc" ]
        }
      ]
    }
    
  4. Build your native addon:

    node-gyp configure
    node-gyp build
    

For more detailed instructions and troubleshooting, refer to the official node-gyp documentation.

Competitor Comparisons

24,614

C++ Library Manager for Windows, Linux, and MacOS

Pros of vcpkg

  • Broader language support, including C++, C, and others
  • Simpler package management for multiple platforms (Windows, Linux, macOS)
  • Integrates well with CMake and other build systems

Cons of vcpkg

  • Steeper learning curve for Node.js developers
  • Less optimized for Node.js native addon development
  • May require more manual configuration for Node.js projects

Code Comparison

node-gyp:

{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "addon.cc" ],
      "include_dirs": ["<!(node -e \"require('nan')\")"]
    }
  ]
}

vcpkg:

cmake_minimum_required(VERSION 3.0)
project(my_project)
find_package(unofficial-sqlite3 CONFIG REQUIRED)
target_link_libraries(main PRIVATE unofficial::sqlite3::sqlite3)

Summary

node-gyp is specifically designed for Node.js native addon development, making it easier for Node.js developers to work with C++ code. vcpkg, on the other hand, offers a more versatile package management solution for multiple languages and platforms, but may require more setup for Node.js projects. The choice between the two depends on the specific project requirements and the developer's familiarity with each tool.

39,034

An extremely fast bundler for the web

Pros of esbuild

  • Significantly faster build times due to its Go-based implementation
  • Built-in support for modern JavaScript features and TypeScript
  • Simpler configuration and usage, with fewer dependencies

Cons of esbuild

  • Less mature ecosystem and community support compared to node-gyp
  • Limited support for certain advanced build scenarios and custom plugins
  • May not be suitable for projects requiring native C++ addons

Code Comparison

esbuild:

require('esbuild').build({
  entryPoints: ['app.js'],
  bundle: true,
  outfile: 'out.js',
}).catch(() => process.exit(1))

node-gyp:

{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "addon.cc" ]
    }
  ]
}

Summary

esbuild is a modern, fast JavaScript bundler and minifier, while node-gyp is a tool for compiling native addon modules for Node.js. esbuild excels in speed and simplicity for JavaScript/TypeScript projects, while node-gyp is essential for projects requiring native C++ addons. The choice between them depends on the specific needs of your project, with esbuild being more suitable for pure JavaScript/TypeScript applications and node-gyp being necessary for projects with native code components.

24,388

Package your Node.js project into an executable

Pros of pkg

  • Simplifies deployment by bundling Node.js application into a single executable
  • Supports cross-platform compilation for Windows, macOS, and Linux
  • Eliminates the need for Node.js installation on target machines

Cons of pkg

  • Limited support for native modules and certain dependencies
  • May increase the size of the final executable significantly
  • Potential security concerns due to bundling sensitive code or configurations

Code Comparison

node-gyp (building native modules):

{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "addon.cc" ],
      "include_dirs": ["<!(node -e \"require('nan')\")"]
    }
  ]
}

pkg (packaging an application):

{
  "bin": "app.js",
  "pkg": {
    "targets": ["node14-win-x64", "node14-macos-x64", "node14-linux-x64"],
    "outputPath": "dist"
  }
}

Key Differences

  • node-gyp focuses on building native addons for Node.js
  • pkg is designed for packaging entire Node.js applications into executables
  • node-gyp is essential for projects requiring native modules
  • pkg simplifies distribution but may face limitations with certain dependencies
6,610

A framework for building compiled Node.js add-ons in Rust via Node-API

Pros of napi-rs

  • Safer and more ergonomic Rust bindings for Node.js native modules
  • Cross-platform support without requiring Python or node-gyp
  • Improved performance due to Rust's zero-cost abstractions

Cons of napi-rs

  • Limited to Rust language, while node-gyp supports multiple languages (C, C++, etc.)
  • Smaller ecosystem and community compared to node-gyp
  • Steeper learning curve for developers not familiar with Rust

Code Comparison

node-gyp (C++):

#include <node.h>

void Method(const v8::FunctionCallbackInfo<v8::Value>& args) {
  v8::Isolate* isolate = args.GetIsolate();
  args.GetReturnValue().Set(v8::String::NewFromUtf8(isolate, "world"));
}

napi-rs (Rust):

#[napi]
fn method() -> String {
  "world".to_string()
}

Summary

napi-rs offers a modern, safe approach to building native Node.js modules using Rust, with improved cross-platform support and performance. However, it's limited to Rust and has a smaller ecosystem compared to node-gyp. node-gyp remains more versatile in terms of language support and has a larger community, but requires additional dependencies and may be more complex to set up.

Emscripten: An LLVM-to-WebAssembly Compiler

Pros of Emscripten

  • Enables compilation of C/C++ code to WebAssembly, allowing for high-performance web applications
  • Supports a wide range of C/C++ libraries and frameworks
  • Provides a comprehensive toolchain for web-based development

Cons of Emscripten

  • Steeper learning curve compared to Node-gyp
  • May require more complex build configurations for certain projects
  • Limited to web-based environments, unlike Node-gyp's native bindings

Code Comparison

Emscripten (compiling C++ to WebAssembly):

#include <emscripten.h>
#include <iostream>

EMSCRIPTEN_KEEPALIVE
extern "C" int add(int a, int b) {
    return a + b;
}

Node-gyp (creating native Node.js addon):

#include <node.h>

void Add(const v8::FunctionCallbackInfo<v8::Value>& args) {
  v8::Isolate* isolate = args.GetIsolate();
  int result = args[0].As<v8::Number>()->Value() + args[1].As<v8::Number>()->Value();
  args.GetReturnValue().Set(v8::Number::New(isolate, result));
}

Both repositories serve different purposes: Emscripten focuses on compiling C/C++ to WebAssembly for web applications, while Node-gyp is used for building native Node.js addons. Emscripten offers broader web compatibility but may be more complex, whereas Node-gyp is simpler but limited to Node.js environments.

📦✨ your favorite rust -> wasm workflow tool!

Pros of wasm-pack

  • Specifically designed for WebAssembly, streamlining Rust-to-WASM compilation
  • Integrates seamlessly with npm, allowing easy distribution of WASM modules
  • Provides a complete toolchain for building, testing, and publishing WASM packages

Cons of wasm-pack

  • Limited to Rust-based projects, unlike node-gyp's language-agnostic approach
  • Relatively newer project with a smaller ecosystem compared to node-gyp
  • Steeper learning curve for developers not familiar with Rust or WebAssembly

Code Comparison

wasm-pack:

#[wasm_bindgen]
pub fn add(a: i32, b: i32) -> i32 {
    a + b
}

node-gyp:

void Add(const FunctionCallbackInfo<Value>& args) {
  int sum = args[0].As<Number>()->Value() + args[1].As<Number>()->Value();
  args.GetReturnValue().Set(Number::New(args.GetIsolate(), sum));
}

wasm-pack focuses on Rust-to-WASM compilation, offering a streamlined workflow for WebAssembly development. It integrates well with npm and provides a comprehensive toolchain. However, it's limited to Rust projects and has a smaller ecosystem compared to node-gyp. node-gyp, on the other hand, supports multiple languages and has a larger community, but lacks specific optimizations for WebAssembly development.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

node-gyp - Node.js native addon build tool

Build Status npm

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 and extended to support the development of Node.js native addons.

Note that node-gyp is not used to build Node.js itself.

All current and LTS target versions of Node.js are supported. Depending on what version of Node.js is actually installed on your system node-gyp downloads the necessary development files or headers for the target version. List of stable Node.js versions can be found on Node.js website.

Features

  • The same build commands work on any of the supported platforms
  • Supports the targeting of different versions of Node.js

Installation

[!Important] Python >= v3.12 requires node-gyp >= v10

You can install node-gyp using npm:

npm install -g node-gyp

Depending on your operating system, you will need to install:

On Unix

On macOS

  • A supported version of Python
  • Xcode Command Line Tools which will install clang, clang++, and make.
    • Install the Xcode Command Line Tools standalone by running xcode-select --install. -- OR --
    • Alternatively, if you already have the full Xcode installed, you can install the Command Line Tools under the menu Xcode -> Open Developer Tool -> More Developer Tools....

On Windows

Install tools with Chocolatey:

choco install python visualstudio2022-workload-vctools -y

Or install and configure Python and Visual Studio tools manually:

If the above steps didn't work for you, please visit Microsoft's Node.js Guidelines for Windows for additional tips.

To target native ARM64 Node.js on Windows on ARM, add the components "Visual C++ compilers and libraries for ARM64" and "Visual C++ ATL for ARM64".

To use the native ARM64 C++ compiler on Windows on ARM, ensure that you have Visual Studio 2022 17.4 or later installed.

It's advised to install following Powershell module: VSSetup using Install-Module VSSetup -Scope CurrentUser. This will make Visual Studio detection logic to use more flexible and accessible method, avoiding Powershell's ConstrainedLanguage mode.

Configuring Python Dependency

node-gyp requires that you have installed a supported version of Python. If you have multiple versions of Python installed, you can identify which version node-gyp should use in one of the following ways:

  1. by setting the --python command-line option, e.g.:
node-gyp <command> --python /path/to/executable/python
  1. If node-gyp is called by way of npm, and you have multiple versions of Python installed, then you can set the npm_config_python environment variable to the appropriate path:
export npm_config_python=/path/to/executable/python

    Or on Windows:

py --list-paths  # To see the installed Python versions
set npm_config_python=C:\path\to\python.exe  # CMD
$Env:npm_config_python="C:\path\to\python.exe"  # PowerShell
  1. If the PYTHON environment variable is set to the path of a Python executable, then that version will be used if it is a supported version.

  2. 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 built-in Python search paths. If it's not a compatible version, no further searching will be done.

Build for Third Party Node.js Runtimes

When building modules for third-party Node.js runtimes like Electron, which have different build configurations from the official Node.js distribution, you should use --dist-url or --nodedir flags to specify the headers of the runtime to build for.

Also when --dist-url or --nodedir flags are passed, node-gyp will use the config.gypi shipped in the headers distribution to generate build configurations, which is different from the default mode that would use the process.config object of the running Node.js instance.

Some old versions of Electron shipped malformed config.gypi in their headers distributions, and you might need to pass --force-process-config to node-gyp to work around configuration errors.

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:

{
  "targets": [
    {
      "target_name": "binding",
      "sources": [ "src/binding.cc" ]
    }
  ]
}

Further reading

The docs directory contains additional documentation on specific node-gyp topics that may be useful if you are experiencing problems installing or building addons using node-gyp.

Some additional resources for Node.js native addons and writing gyp configuration files:

Commands

node-gyp responds to the following commands:

CommandDescription
helpShows the help dialog
buildInvokes make/msbuild.exe and builds the native addon
cleanRemoves the build directory if it exists
configureGenerates project build files for the current platform
rebuildRuns clean, configure and build all in a row
installInstalls Node.js header files for the given version
listLists the currently installed Node.js header versions
removeRemoves the Node.js header files for the given version

Command Options

node-gyp accepts the following command options:

CommandDescription
-j n, --jobs nRun make in parallel. The value max will use all available CPU cores
--target=v6.2.1Node.js version to build for (default is process.version)
--silly, --loglevel=sillyLog all progress to console
--verbose, --loglevel=verboseLog most progress to console
--silent, --loglevel=silentDon't log anything to console
debug, --debugMake Debug build (default is Release)
--release, --no-debugMake Release build
-C $dir, --directory=$dirRun command in different directory
--make=$makeOverride make command (e.g. gmake)
--thin=yesEnable thin static libraries
--arch=$archSet target architecture (e.g. ia32)
--tarball=$pathGet headers from a local tarball
--devdir=$pathSDK download directory (default is OS cache directory)
--ensureDon't reinstall headers if already present
--dist-url=$urlDownload header tarball from custom URL
--proxy=$urlSet HTTP(S) proxy for downloading header tarball
--noproxy=$urlsSet urls to ignore proxies when downloading header tarball
--cafile=$cafileOverride default CA chain (to download tarball)
--nodedir=$pathSet the path to the node source code
--python=$pathSet path to the Python binary
--msvs_version=$versionSet Visual Studio version (Windows only)
--solution=$solutionSet Visual Studio Solution version (Windows only)
--force-process-configForce using runtime's process.config object to generate config.gypi file

Configuration

Environment variables

Use the form npm_config_OPTION_NAME for any of the command options listed above (dashes in option names should be replaced by underscores).

For example, to set devdir equal to /tmp/.gyp, you would:

Run this on Unix:

export npm_config_devdir=/tmp/.gyp

Or this on Windows:

set npm_config_devdir=c:\temp\.gyp

npm configuration for npm versions before v9

Use the form OPTION_NAME for any of the command options listed above.

For example, to set devdir equal to /tmp/.gyp, you would run:

npm config set [--global] devdir /tmp/.gyp

Note: Configuration set via npm will only be used when node-gyp is run via npm, not when node-gyp is run directly.

License

node-gyp is available under the MIT license. See the LICENSE file for details.

NPM DownloadsLast 30 Days