aaf1e1c4fb
These packages will be placed into an environment using `backendsToPackages`. This function explicitly maps backends to `pkgs.nodePackages.${type}` unless it's a builtin. This ensures that only valid backends that work on NixOS are used (if not, the build already breaks at evaluation time). The log will be redirected to `stdout` to be able to watch the entire output using `journalctl`. Configuration parameters for the backends need to be set using `services.statsd.extraConfig` as each backend has its own options and all of them shouldn't be validated and checked explicitly and manually. |
||
---|---|---|
.. | ||
composition-v4.nix | ||
composition-v6.nix | ||
default-v4.nix | ||
default-v6.nix | ||
generate.sh | ||
node-env.nix | ||
node-packages-v4.json | ||
node-packages-v4.nix | ||
node-packages-v6.json | ||
node-packages-v6.nix | ||
README.md |
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:
- Modify
pkgs/development/node-packages/node-packages-v6.json
to add, update or remove package entries. (Orpkgs/development/node-packages/node-packages-v4.json
for packages depending on Node.js 4.x) - Run the script:
(cd pkgs/development/node-packages && ./generate.sh)
. - 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>
- Add and commit all modified and generated files.
For more information about the generation process, consult the
README.md file of the node2nix
tool.