nodejs/node-gyp
Node Gyp
node-gyp is a build system wrapper and compilation tool designed to transform C and C++ source code into binary modules for the Node.js runtime. It functions as a native module compiler that orchestrates the process of converting native source code into binary bindings for high-performance execution.
The project provides cross-platform compilation by managing different compilers and SDKs across Windows, macOS, and Linux. It translates a single project configuration into platform-specific build files, such as Makefiles or Visual Studio projects, to ensure consistent builds across different operating systems.
Beyond standard binary compilation, the tool handles the procurement of remote source files and the management of versioned runtime header files required for binary compatibility. It also supports the generation of portable WebAssembly modules.
Features
- Add-on Compilation Toolchains - Converts C and C++ source code into binary bindings and modules for high-performance execution in the Node.js runtime.
- Native Module Toolchains - Provides the primary toolchain for bootstrapping and compiling C and C++ native extensions for the Node.js runtime.
- Build Environment Configurators - Sets architecture, compiler versions, and system paths using flags or configuration files to prepare the build process.
- Cross-Platform and Native Compilation - Generates platform-specific build files and manages compiler toolchains to ensure native code compiles across different operating systems.
- Build Toolchain Abstractions - Maps high-level build commands to specific compilers and SDKs based on the detected host operating system.
- Multi-Toolchain Integration - Connects with various compilers and SDKs across different operating systems to ensure consistent code compilation.
- Platform Build File Generators - Translates a central JSON project definition into platform-specific build files like Makefiles or Visual Studio projects.
- Platform-Specific Build File Generation - Creates platform-specific configuration files, such as Makefiles, based on a central project definition.
- Build Configuration Management - Reads compilation settings from configuration files or package manifests to determine how native code is built.
- Binary Compilation - Transforms C and C++ source code into binary modules that the JavaScript runtime can load.
- Node.js Native Addons - Converts C and C++ source code into binary modules that can be loaded and executed within a Node.js environment.
- Build Tools - Compiles C and C++ source code into binary modules that can be loaded as native addons by Node.js.
- Build File Generators - Generates platform-specific build files such as Makefiles and Visual Studio projects from a single project configuration.
- Build-Time Source Procurement - Downloads and extracts external dependencies from HTTP endpoints during the build process to satisfy native requirements.
- Target-Specific Build Settings - Builds native modules for specific runtime versions by specifying target versions and header locations.
- Toolchain Path Resolution - Determines system paths and compiler versions via command-line flags and configuration files to locate build tools.
- External Source Inclusions - Downloads remote source files via HTTP and integrates them into the compilation process.
- Native Library Integrations - Fetches remote source files and integrates external C++ libraries into the build process for native extensions.
- Runtime Header Management - Downloads and links specific versioned C++ header files to ensure binary compatibility with the target runtime.
- WebAssembly Glue Code Generators - Builds native source code into portable WebAssembly formats, providing the necessary interface for web environments.
- WebAssembly Compilation - Builds native modules into a portable WebAssembly format for use in web environments.
