node-packages: update packaging guideline

This commit is contained in:
Jörg Thalheim 2017-07-30 14:26:58 +01:00
parent d298873d53
commit e95352cfdd

View File

@ -2,12 +2,12 @@ Node.js packages
=============== ===============
To add a package from [NPM](https://www.npmjs.com/) to nixpkgs: To add a package from [NPM](https://www.npmjs.com/) to nixpkgs:
1. Install node2nix: `nix-env -f '<nixpkgs>' -iA nodePackages.node2nix`. 1. Modify `pkgs/development/node-packages/node-packages.json`, to add, update,
2. Modify `pkgs/development/node-packages/node-packages.json`, to add, update, or remove package entries. (or `pkgs/development/node-packages/node-packages-v4.json`
or remove package entries. for packagages depending on node.js 4.x)
3. Run the script: `cd pkgs/development/node-packages && sh generate.sh`. 2. Run the script: `cd pkgs/development/node-packages && sh generate.sh`.
4. Build your new package to test your changes: `cd /path/to/nixpkgs && 3. Build your new package to test your changes:
nix-build -A nodePackages.<new-or-updated-package>`. To build against a `cd /path/to/nixpkgs && nix-build -A nodePackages.<new-or-updated-package>`.
specific node.js version (e.g. 5.x): `nix-build -A To build against a specific node.js version (e.g. 5.x):
nodePackages_5_x.<new-or-updated-package>` `nix-build -A nodePackages_4_x.<new-or-updated-package>`
5. Add, commit, and share your changes! 4. Add and commit all modified and generated files.