public/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nodePackages: Added instructions to README about packages with binary addons

Browse Source
This commit is contained in:
Roger Qiu 2017-12-21 23:45:21 +11:00
parent c98523d336
commit a3330a9b96
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
pkgs/development/node-packages/README.md
View File

@ -17,6 +17,23 @@ is that a new package should be added to the collection for the latest stable LT
release (which is currently 6.x), unless there is an explicit reason to support release (which is currently 6.x), unless there is an explicit reason to support
a different release. a different release.
If your package uses native addons, you need to examine what kind of native
build system it uses. Here are some examples:
* `node-gyp`
* `node-gyp-builder`
* `node-pre-gyp`
After you have identified the correct system, you need to override your package
expression while adding in build system as a build input. For example, `dat`
requires `node-gyp-build`, so we override its expression in `default-v6.nix`:
```nix
dat = nodePackages.dat.override (oldAttrs: {
buildInputs = oldAttrs.buildInputs ++ [ nodePackages.node-gyp-build ];
});
```
To add a package from NPM to nixpkgs: To add a package from NPM to nixpkgs:
1. Modify `pkgs/development/node-packages/node-packages-v6.json` to add, update 1. Modify `pkgs/development/node-packages/node-packages-v6.json` to add, update