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

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.

npmlock2nix vs node2nix: which is better?

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.

Can npmlock2nix handle private npm packages?

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.

How to cache node_modules builds with npmlock2nix?

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.

What if my build fails with npmlock2nix?

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.

Does npmlock2nix support monorepos or workspaces?

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 — Nix Derivations from npm Packages

What is npmlock2nix?

npmlock2nix is a Nix library that converts npm-based JavaScript projects into Nix derivations by parsing package.json and package-lock.json files. It solves the problem of integrating Node.js dependencies into the Nix ecosystem, enabling reproducible and pure builds for npm packages.

Target Audience

Nix users and developers who need to manage npm-based projects within Nix workflows, such as those building JavaScript applications or tools with Nix.

Value Proposition

Developers choose npmlock2nix for its simplicity, reliability, and adherence to Nix principles, offering a tested and unit-tested solution that works in restricted evaluation and supports GitHub dependencies without auto-generated code.

nixify npm based packages [maintainer=@andir]

Use Cases

Best For

Integrating npm packages into Nix-based development environments
Creating reproducible builds for Node.js applications with Nix
Managing JavaScript dependencies in pure Nix derivations
Setting up development shells with node_modules for npm projects
Building npm-based projects with custom build commands in Nix
Handling GitHub-hosted dependencies in Nix workflows

Not Ideal For

Projects using yarn or pnpm without a package-lock.json file
Teams wanting a zero-configuration, drop-in solution for npm builds
Developers not already familiar with Nix overlays and derivations

Pros & Cons

Pros

Pure Nix Implementation

Uses pure Nix expressions without auto-generated code, ensuring better integration and reliability within Nix workflows, as emphasized in the features.

Secure Evaluation Support

Works in Nix's restricted evaluation mode, enhancing security for builds in controlled environments, a key feature highlighted in the README.

GitHub Dependency Handling

Supports dependencies hosted directly on GitHub, extending beyond standard npm registries for more flexible source management.

Comprehensive Testing Suite

Includes both unit and integration tests, ensuring robustness and reliability for production use, as noted in the features and development section.

Cons

Manual Build Configuration

Requires users to explicitly define buildCommands and installPhase for custom builds, adding complexity compared to more automated tools.

Lock File Reliance

Depends solely on package-lock.json, making it incompatible with projects using yarn.lock or pnpm-lock.yaml without manual conversion or additional steps.

Nix Ecosystem Dependency

Only useful within Nix-based workflows, requiring setup with niv and overlays, which can be a barrier for teams not invested in Nix.

What is npmlock2nix?

Target Audience

Nix users and developers who need to manage npm-based projects within Nix workflows, such as those building JavaScript applications or tools with Nix.

Value Proposition

Use Cases

Best For

Integrating npm packages into Nix-based development environments
Creating reproducible builds for Node.js applications with Nix
Managing JavaScript dependencies in pure Nix derivations
Setting up development shells with node_modules for npm projects
Building npm-based projects with custom build commands in Nix
Handling GitHub-hosted dependencies in Nix workflows

Not Ideal For

Projects using yarn or pnpm without a package-lock.json file
Teams wanting a zero-configuration, drop-in solution for npm builds
Developers not already familiar with Nix overlays and derivations

Pros & Cons

Pros

Pure Nix Implementation

Uses pure Nix expressions without auto-generated code, ensuring better integration and reliability within Nix workflows, as emphasized in the features.

Secure Evaluation Support

Works in Nix's restricted evaluation mode, enhancing security for builds in controlled environments, a key feature highlighted in the README.

GitHub Dependency Handling

Supports dependencies hosted directly on GitHub, extending beyond standard npm registries for more flexible source management.

Comprehensive Testing Suite

Includes both unit and integration tests, ensuring robustness and reliability for production use, as noted in the features and development section.

Cons

Manual Build Configuration

Requires users to explicitly define buildCommands and installPhase for custom builds, adding complexity compared to more automated tools.

Lock File Reliance

Depends solely on package-lock.json, making it incompatible with projects using yarn.lock or pnpm-lock.yaml without manual conversion or additional steps.

Nix Ecosystem Dependency

Only useful within Nix-based workflows, requiring setup with niv and overlays, which can be a barrier for teams not invested in Nix.

npmlock2nix

What is npmlock2nix?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

npmlock2nix

What is npmlock2nix?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?