Question 1

How do I set up npmlock2nix for a new npm project?

Accepted Answer

First, add npmlock2nix via niv, then create a Nix overlay as shown in the README. Ensure your project has package.json and package-lock.json files in the root directory. Refer to the API documentation for detailed usage.

Question 2

npmlock2nix vs node2nix: which is better?

Accepted Answer

npmlock2nix uses pure Nix expressions and works with package-lock.json for deterministic builds, while node2nix generates Nix expressions from npm packages. Choose npmlock2nix for stricter Nix integration, but node2nix might be easier for broader npm compatibility.

Question 3

Can npmlock2nix handle private npm packages?

Accepted Answer

The README doesn't explicitly cover private registries. Since it parses package-lock.json, it might work if dependencies are resolved, but you'll likely need to configure Nix to access private sources, which can add complexity.

Question 4

How to cache node_modules builds with npmlock2nix?

Accepted Answer

Nix inherently caches derivations, so node_modules built with npmlock2nix are cached locally. For team sharing, use services like Cachix to distribute builds, but this requires additional Nix configuration.

Question 5

What if my build fails with npmlock2nix?

Accepted Answer

Check that package-lock.json is consistent and up-to-date. Review your buildCommands and installPhase for errors. The project's integration tests and API documentation can help debug, but Nix experience is often needed.

Question 6

Does npmlock2nix support monorepos or workspaces?

Accepted Answer

The documentation doesn't specify support for npm workspaces or monorepos. You might need to create separate derivations for each package, which can be complex and require custom Nix scripting.

npmlock2nix

What is npmlock2nix?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions