Solve small problems with minimal, neat solutions.
Send us your pull requests, and we will merge them.
Node.js native addon build tool
node-ninja is a cross-platform command-line tool written in Node.js for compiling
native addon modules for Node.js. It bundles the gyp
project used by the Chromium team and takes away the pain of dealing with the
various differences in build platforms.
Multiple target versions of node are supported (i.e. 0.8, 0.9, 0.10, ..., 1.0,
etc.), regardless of what version of node is actually installed on your system
(node-ninja downloads the necessary development files for the target version).
Features:
Easy to use, consistent interface
Same commands to build your module on every platform
Supports multiple target versions of Node
Installation
You can install with npm:
$ npm install -g node-ninja
TODO: review this section, it is out of date.
You will also need to install:
On Unix:
python (v2.7 recommended, v3.x.x is not supported)
If you have multiple Python versions installed, you can identify which Python
version node-ninja uses by setting the '--python' variable:
node-ninja --python /path/to/python2.7
If node-ninja is called by way of npmand 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/python2.7
Note that OS X is just a flavour of Unix and so needs python, make, and C/C++.
An easy way to obtain these is to install XCode from Apple,
and then use it to install the command line tools (under Preferences -> Downloads).
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-ninja configure
Note: The configure step looks for the binding.gyp file in the current
directory to process. See below for instructions on creating the 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-ninja 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 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 command.
The "binding.gyp" file
The 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 the package.json file.
A barebones gyp file appropriate for building a node addon looks like:
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Install Visual Studio Community 2015 Edition. (Custom Install, Select Visual C++ during the installation)
Set the environment variable GYP_MSVS_VERSION=2015
Run the command prompt as Administrator
$ npm install (--msvs_version=2015) <-- Shouldn't be needed if you have set GYP_MSVS_VERSION env
All Windows Versions
For 64-bit builds of node and native modules you will also need the Windows 7 64-bit SDK
You may need to run one of the following commands if your build complains about WindowsSDKDir not being set, and you are sure you have already installed the SDK: