nixpkgs/pkgs/development/node-packages
2017-10-31 11:23:42 +01:00
..
composition-v4.nix nodePackages.ocaml-language-server: init at 0.2.0 2017-08-30 21:54:18 +02:00
composition-v6.nix nodePackages.ocaml-language-server: init at 0.2.0 2017-08-30 21:54:18 +02:00
default-v4.nix bower2nix: fix execution under nix-shell --pure 2017-10-30 18:23:45 +01:00
default-v6.nix bower2nix: fix execution under nix-shell --pure 2017-10-30 18:23:45 +01:00
generate.sh nodePackages: split into v4/v6 package set 2017-05-05 09:02:52 +01:00
node-env.nix eslint_d: init at 4.2.5 2017-06-04 14:09:52 +02:00
node-packages-v4.json nodePackages: split into v4/v6 package set 2017-05-05 09:02:52 +01:00
node-packages-v4.nix nodePackages.web-ext: init at 2.2.2 2017-10-23 11:05:38 +01:00
node-packages-v6.json nodePackages.web-ext: init at 2.2.2 2017-10-23 11:05:38 +01:00
node-packages-v6.nix nodePackages.web-ext: init at 2.2.2 2017-10-23 11:05:38 +01:00
README.md nodePackages: add more details about the packages to include and the Node.js versions to support 2017-10-31 11:23:42 +01:00

Node.js packages

The pkgs/development/node-packages folder contains a generated collection of NPM packages that can be installed with the Nix package manager.

As a rule of thumb, the package set should only provide end user software packages, such as command-line utilities. Libraries should only be added to the package set if there is a non-NPM package that requires it.

When it is desired to use NPM libraries in a development project, use the node2nix generator directly on the package.json configuration file of the project.

The package set also provides support for multiple Node.js versions. The policy is that a new package should be added to the collection for the latest stable LTS release (which is currently 6.x), unless there is an explicit reason to support a different release.

To add a package from NPM to nixpkgs:

  1. Modify pkgs/development/node-packages/node-packages-v6.json to add, update or remove package entries. (Or pkgs/development/node-packages/node-packages-v4.json for packages depending on Node.js 4.x)
  2. Run the script: (cd pkgs/development/node-packages && ./generate.sh).
  3. Build your new package to test your changes: cd /path/to/nixpkgs && nix-build -A nodePackages.<new-or-updated-package>. To build against a specific Node.js version (e.g. 4.x): nix-build -A nodePackages_4_x.<new-or-updated-package>
  4. Add and commit all modified and generated files.

For more information about the generation process, consult the README.md file of the node2nix tool.