Question 1

node2nix vs npm2nix which should I use?

Accepted Answer

node2nix is more actively maintained and better supports modern NPM features like lock files, while npm2nix is older and less flexible. For new projects in the Nix ecosystem, node2nix is generally preferred due to its updated approach and documentation.

Question 2

How to use node2nix with a private NPM registry?

Accepted Answer

Use the --registry, --registry-auth-token, and --registry-scope options when running node2nix, as shown in the README's 'Using alternative NPM registries' section. This allows authentication and specification of custom registries for private packages.

Question 3

Can node2nix handle Git dependencies from private repositories?

Accepted Answer

Yes, by using the --use-fetchgit-private flag and providing an SSH config file with identity keys, as detailed in the 'Using private Git repositories' section. This enables secure access to private Git repos in Nix builds.

Question 4

What do I do if node2nix fails due to peer dependencies?

Accepted Answer

Enable the --include-peer-dependencies flag during generation or manually add them as overrides. The README warns that newer NPM versions don't install peer dependencies by default, so this step is often necessary for correct deployments.

Question 5

How to override a dependency's native build inputs in node2nix?

Accepted Answer

Create an override.nix file that modifies the package's buildInputs, similar to the floomatic example with Qt4. The README provides specific code snippets for injecting native libraries through Nix's override mechanism.

Question 6

Is node2nix compatible with Yarn or pnpm lock files?

Accepted Answer

No, node2nix primarily supports NPM's package-lock.json; for Yarn or pnpm, you may need to convert lock files or use alternative tools. The README focuses on NPM integration, so other package managers are not directly supported.

node2nix

What is node2nix?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions