node2nix

https://www.npmjs.com/package/node2nix
Admin
node2nix is a tool that converts NPM package dependencies to Nix expressions, enabling deployment of...
Tokens:11,918
Snippets:182
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install node2nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=versions

Use this command to install the node2nix package. Ensure you have npm installed.

```bash
npm i node2nix
```

--------------------------------

### Install node2nix with NPM

Source: https://www.npmjs.com/package/node2nix/v/1.11.0

Installs the node2nix package globally using NPM.

```bash
$ npm install -g node2nix
```

--------------------------------

### Install node2nix with NPM

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Installs the node2nix package globally using NPM.

```bash
npm install -g node2nix
```

--------------------------------

### Install node2nix with Nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0

Installs the node2nix package using the Nix package manager.

```bash
$ nix-env -f '<nixpkgs>' -iA nodePackages.node2nix
```

--------------------------------

### Install node2nix with Nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Installs the node2nix package using the Nix package manager.

```bash
nix-env -f '<nixpkgs>' -iA nodePackages.node2nix
```

--------------------------------

### Install NPM Package (Latest Version)

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Installs a package from the NPM registry for which the latest version was requested in the JSON configuration. Directly refer to the package name.

```bash
$ nix-env -f default.nix -iA async
```

--------------------------------

### Install Tarball with NPM

Source: https://www.npmjs.com/package/node2nix/v/1.11.0

Installs a previously generated Node.js project tarball using NPM.

```bash
$ npm install node2nix-1.0.1.tgz
```

--------------------------------

### Implement postInstall Hook for Post-Deployment Execution

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Use an override.nix expression with a postInstall hook to execute commands after the NPM package has been deployed. This example runs 'grunt'.

```nix
{ pkgs ? import <nixpkgs> {}
, system ? builtins.currentSystem
}:

let
  nodePackages = import ./default.nix {
    inherit pkgs system;
  };
in
nodePackages // {
  package = nodePackages.package.override {
    postInstall = "grunt";
  };
}
```

--------------------------------

### Deploy Node.js Development Environment

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Installs project dependencies and opens a shell session where they are available. Use this to set up a development environment for a Node.js project.

```bash
$ nix-shell -A shell
```

--------------------------------

### Install NPM Package (Git URL)

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Installs a package from a Git URL as specified in the JSON configuration. The attribute name must be quoted and includes the Git URL.

```bash
$ nix-env -f default.nix -iA '"node2nix-git://github.com/svanderburg/node2nix.git"'
```

--------------------------------

### Install Tarball with NPM

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Installs a previously generated tarball of a Node.js project using NPM.

```bash
npm install node2nix-1.0.1.tgz
```

--------------------------------

### Install Project Dependencies with NPM

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Installs project dependencies using NPM, typically done in a development setting.

```bash
npm install
```

--------------------------------

### Install Project Dependencies with NPM

Source: https://www.npmjs.com/package/node2nix/v/1.11.0

Installs JavaScript dependencies for a project using NPM. This is a prerequisite for building a development version.

```bash
$ npm install
```

--------------------------------

### Build Development Version of node2nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0

Installs a development version of node2nix into the Nix profile.

```bash
$ nix-env -f release.nix -iA package.x86_64-linux
```

--------------------------------

### Install NPM Package (Resolved Version)

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Installs a package using an attribute name composed of its name and resolved version number. This is useful for packages with specific version numbers.

```bash
$ nix-env -f default.nix -iA '"nijs-0.0.18"'
```

--------------------------------

### Implement preRebuild Hook for Package Patching

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Use an override.nix expression with a preRebuild hook to patch executables before building. This example adds OpenSSL to the PATH for the dnschain package.

```nix
{pkgs ? import <nixpkgs> {
  inherit system;
}, system ? builtins.currentSystem}:

let
  nodePackages = import ./default.nix {
    inherit pkgs system;
  };
in
nodePackages // {
  dnschain = nodePackages.dnschain.override {
    preRebuild = ''
      wrapProgram $out/bin/dnschain --suffix PATH : ${pkgs.openssl.bin}/bin
    '';
  };
}
```

--------------------------------

### Build Development Version of node2nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Installs a development version of node2nix into the Nix profile.

```bash
nix-env -f release.nix -iA package.x86_64-linux
```

--------------------------------

### Install NPM Package (Specific Version)

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Installs a specific version of an NPM package defined in the JSON configuration. The attribute name is composed of the package name and version specifier, and must be quoted.

```bash
$ nix-env -f default.nix -iA '"mocha-1.21.x"'
```

--------------------------------

### Specify Global NPM Packages for Supplementation

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Use a JSON array to list additional NPM packages to be installed globally, such as grunt-cli.

```json
[
  "grunt-cli"
]
```

--------------------------------

### Install Specific NPM Package Version

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=versions

Installs a specific version of an NPM package using its attribute name, which is composed of the package name and version specifier. Attribute names with special characters like dots must be quoted.

```bash
$ nix-env -f default.nix -iA '"mocha-1.21.x"'
```

```bash
$ nix-env -f default.nix -iA '"node2nix-git://github.com/svanderburg/node2nix.git"'
```

```bash
$ nix-env -f default.nix -iA '"nijs-0.0.18"'
```

--------------------------------

### Disable NPM Install Step in node2nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

This Nix expression overrides a package to disable the `npm install` step by setting `dontNpmInstall` to `true`. This is useful when `node2nix`'s dependency resolution differs slightly from NPM's, causing deployments to fail. Disabling this step prevents the deployment from failing prematurely, as the actual dependency fetching and extraction are handled by the generated Nix expression.

```nix
{pkgs ? import <nixpkgs> {
  inherit system;
}, system ? builtins.currentSystem}:

let
  nodePackages = import ./default.nix {
    inherit pkgs system;
  };
in
nodePackages // {
  express = nodePackages.express.override {
    dontNpmInstall = true;
  };
}
```

--------------------------------

### Generate Nix Expressions from NPM Registry Specification

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Generates Nix expressions from a JSON specification of NPM packages. This command is used to prepare packages for installation with Nix.

```bash
$ node2nix -i node-packages.json
```

--------------------------------

### Include Peer Dependencies with node2nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Use this flag to ensure peer dependencies are installed, which is necessary for older NPM versions (2.x and older) or packages that rely on this behavior. This flag is not needed for newer NPM versions where peer dependencies are only used for version checks.

```bash
$ node2nix --include-peer-dependencies
```

--------------------------------

### Strip Optional Dependencies with node2nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

This command-line option removes optional dependencies from packages installed from the NPM registry. This is useful for preventing deployment failures caused by broken optional dependencies that are treated as regular runtime dependencies.

```bash
$ node2nix --strip-optional-dependencies
```

--------------------------------

### Build Package with Post-Deployment Hook

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Use nix-build with the override.nix file to execute the postInstall hook during the packaging process.

```bash
$ nix-build override.nix -A package
```

--------------------------------

### Build Wrapped Package with Nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Use nix-build with the override.nix file to deploy a wrapped package that includes the preRebuild hook.

```bash
$ nix-build override.nix -A dnschain
```

--------------------------------

### Configure SSH Agent for Private Repositories

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Before using --use-fetchgit-private, set up ssh-agent and add your private key using ssh-add to avoid passphrase prompts.

```bash
ssh-agent
ssh-add ~/id_rsa
```

--------------------------------

### Build Package with SSH Configuration Parameter

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

When deploying a package with Nix, pass the SSH configuration file location using the -I parameter.

```bash
$ nix-build -A package -I ssh-config-file=~/ssh_config
```

--------------------------------

### Build Node.js Project with Nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Builds the Node.js project using the generated Nix expressions. Creates a 'result' symlink pointing to the build output.

```bash
nix-build -A package
```

--------------------------------

### Build Node.js Project with Nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0

Builds the Node.js project using the generated Nix expressions. A 'result' symlink is created pointing to the build output.

```bash
$ nix-build -A package
```

--------------------------------

### Specify Input and Output Paths

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Customize input and output filenames for Nix expressions. Use --input for the JSON spec, --output for the registry Nix file, --composition for the main Nix expression, and --node-env for Node.js environment.

```bash
$ node2nix --input package.json --output registry.nix --composition default.nix --node-env node-env.nix
```

--------------------------------

### Enable Private Git Repository Support

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Use the --use-fetchgit-private flag with node2nix to enable support for private Git repositories using SSH.

```bash
$ node2nix --use-fetchgit-private
```

--------------------------------

### Provide SSH Configuration for Private Repositories

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Create an SSH configuration file (e.g., ~/ssh_config) specifying IdentityFile for private key usage.

```sshconfig
StrictHostKeyChecking=no
UserKnownHostsFile /dev/null
IdentityFile ~/id_rsa

```

--------------------------------

### Run Executable from Nix Build

Source: https://www.npmjs.com/package/node2nix/v/1.11.0

Executes a program from the built Node.js project, typically found in the 'result' symlink.

```bash
$ ./result/bin/node2nix
```

--------------------------------

### Run Executable from Nix Build

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Executes a program from the built Node.js project, typically found within the 'result' symlink.

```bash
./result/bin/node2nix
```

--------------------------------

### Generate Nix Expressions with Supplemental Packages

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Use node2nix with -d, -i, and --supplement-input flags to generate Nix expressions including supplemental global packages.

```bash
$ node2nix -d -i package.json --supplement-input supplement.json
```

--------------------------------

### NPM Package Specification for Registry Deployment

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

A JSON specification for deploying NPM packages from the registry. It supports string entries for latest versions and objects for specific versions or Git URLs.

```json
[
  "async",
  "underscore",
  "slasp",
  { "mocha" : "1.21.x" },
  { "mocha" : "1.20.x" },
  { "nijs": "0.0.18" },
  { "node2nix": "git://github.com/svanderburg/node2nix.git" }
]
```

--------------------------------

### Specify Global NPM Packages with Versions

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Provide specific versions for supplemental global NPM packages in a JSON array.

```json
[
  {
    "grunt-cli": "1.2.0"
  }
]
```

--------------------------------

### Specify Packages for Nix Expression Generation

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Use a JSON array to list NPM packages for Nix expression generation.

```json
[
  "dnschain"
]
```

--------------------------------

### Enable Development Dependencies

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Add the --development flag to include development dependencies in the Nix expression. This is useful for development environments where all package versions are needed.

```bash
$ node2nix --development
```

--------------------------------

### Generate Nix Expressions from NPM Registry Specification

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=versions

Deploys NPM packages from the registry based on a JSON specification. Use this to manage external Node.js packages within your Nix build.

```json
[
  "async",
  "underscore",
  "slasp",
  { "mocha" : "1.21.x" },
  { "mocha" : "1.20.x" },
  { "nijs": "0.0.18" },
  { "node2nix": "git://github.com/svanderburg/node2nix.git" }
]
```

```bash
$ node2nix -i node-packages.json
```

--------------------------------

### Generate Nix Expressions for Node.js Project

Source: https://www.npmjs.com/package/node2nix/v/1.11.0

Generates Nix expressions from a project's package.json file. This creates node-packages.nix, node-env.nix, and default.nix.

```bash
$ node2nix
```

--------------------------------

### Create Symlink to node_modules in Nix Shell

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

When using Node.js build tools like Grunt, Gulp, Babel, or ESLint within a Nix shell session, these tools may fail to find their plugins if they rely on the local `node_modules/` folder. This command creates a symbolic link from the project's root to the `NODE_PATH` environment variable, allowing these tools to locate their dependencies. Remember to remove the symlink before building with `nix-build` or `nix-env`.

```bash
$ ln -s $NODE_PATH node_modules
```

--------------------------------

### Use Alternative NPM Registries

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Configure node2nix to use alternative NPM registries, including private ones. Provide the registry URL with --registry and optionally authentication token and scope.

```bash
$ node2nix -i node-packages.json --registry http://private.registry.local
```

```bash
$ node2nix \
  --registry "https://registry.npmjs.org" \
  --registry "https://npm.pkg.github.com/" \
  --registry-auth-token "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  --registry-scope "@myorg"
```

--------------------------------

### Generate Tarball from Node.js Project

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Generates a tarball of the Node.js project using Nix build, useful for distribution.

```bash
nix-build -A tarball
```

--------------------------------

### Build Overridden Package

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Build a specific package with its injected dependencies using Nix. This command uses the override expression to ensure all required native libraries are available.

```bash
$ nix-build override.nix -A floomatic
```

--------------------------------

### Generate Nix Expressions with node2nix

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Generates Nix expressions (node-packages.nix, node-env.nix, default.nix) from package.json for deploying Node.js projects.

```bash
node2nix
```

--------------------------------

### Set NIX_PATH for SSH Configuration

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Alternatively, set the NIX_PATH environment variable to provide the SSH configuration file location.

```bash
$ export NIX_PATH=ssh-config-file=~/ssh_config:$NIX_PATH
```

--------------------------------

### Define Development Dependencies in package.json

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Specify development dependencies, including global packages like grunt CLI, in the package.json file.

```json
{
  "name": "grunt-test",
  "version": "0.0.1",
  "private": "true",
  "devDependencies": {
    "grunt": "*",
    "grunt-contrib-jshint": "*",
    "grunt-contrib-watch": "*"
  }
}
```

--------------------------------

### Generate Tarball from Node.js Project

Source: https://www.npmjs.com/package/node2nix/v/1.11.0

Generates a tarball of the Node.js project using Nix build. The tarball is placed in result/tarballs.

```bash
$ nix-build -A tarball
```

--------------------------------

### Generate Nix for Node.js 4.x

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Use the -4 flag to generate Nix expressions compatible with Node.js 4.x. This is useful for older Node.js versions that may not support newer features like flattening or lock files.

```bash
$ node2nix -4 -i node-package.json
```

--------------------------------

### Generate Nix Expressions from NPM Lock File

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Generates a Nix expression from a `package-lock.json` file. This ensures that Nix uses the exact same package versions as specified in the lock file, including transitive dependencies.

```bash
$ node2nix -l package-lock.json
```

--------------------------------

### Integrate Node.js Dependencies into Nix Derivations

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Uses node2nix-generated Node.js dependencies within another Nix derivation. This is useful for building projects that rely on Node.js build tools like Webpack.

```nix
let
  nodeDependencies = (pkgs.callPackage ./default.nix {}).nodeDependencies;
in

stdenv.mkDerivation {
  name = "my-webpack-app";
  src = ./my-app;
  buildInputs = [nodejs];
  buildPhase = ''
    ln -s ${nodeDependencies}/lib/node_modules ./node_modules
    export PATH="${nodeDependencies}/bin:$PATH"

    # Build the distribution bundle in "dist"
    webpack
    cp -r dist $out/
  '';
}
```

--------------------------------

### Override Package with Native Dependencies

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Inject native dependencies into a Nix derivation using an override. This is necessary when NPM packages rely on system libraries not automatically detected by node2nix.

```nix
{pkgs ? import <nixpkgs> {
    inherit system;
}, system ? builtins.currentSystem}:

let
  nodePackages = import ./default.nix {
    inherit pkgs system;
  };
in
nodePackages // {
  floomatic = nodePackages.floomatic.override {
    buildInputs = [ pkgs.pkgconfig pkgs.qt4 ];
  };
}
```

--------------------------------

### Run Node.js Script in Development Shell

Source: https://www.npmjs.com/package/node2nix/v/1.11.0?activeTab=readme

Executes a Node.js script within the development shell environment. This is useful for testing or running project-specific tools.

```bash
$ node bin/node2nix.js --help
```
Tokens:
Raw