nodejs-package-lock-v3 - options

deps

All dependencies of the package. This option should be set by the “outer world” and can be used to inherit attributes from pkgs or inputs etc.

By separating the task of retrieving things from the outside world, it is ensured that the dependencies are overridable. Nothing will stop users from adding nixpkgs itself as a dependency, but this will make it very hard for the user of the package to override any dependencies, because they’d have to figure out a way to insert their changes into the Nixpkgs fixpoint. By adding specific attributes to deps instead, the user has a realistic chance of overriding those dependencies.

So deps should be specific, but not overly specific. For instance, the caller shouldn’t have to know the version of a dependency in order to override it. The name should suffice. (e.g. nix = nixVersions.nix_2_12 instead of inherit (nixVersions) nix_2_12.

Type: lazy attribute set of raw value

Default: { }

Example:

{nixpkgs, ...}: {
  inherit (nixpkgs) stdenv;
  inherit (nixpkgs.haskellPackages) pandoc;
}

Declared by:

env

environment variables passed to the build environment

Type: attribute set of (null or boolean or signed integer or string or path or package or list of (boolean or signed integer or string or path or package))

Default: { }

Declared by:

lock.content

The content of the lock file. All fields declared via lock.fields are contained pointing to their respective values.

Type: anything

Declared by:

lock.extraScripts

Extra shell scripts to execute when nix run .#{package}.lock is called.

This allows adding custom logic to the lock file generation.

Type: list of path

Default: [ ]

Declared by:

lock.fields

Fields of the lock file

Type: attribute set of (submodule)

Default: { }

Example:

{
  pname = true;
  version = true;
}

Declared by:

lock.fields.<name>.default

The default value in case the lock file doesn’t exist or doesn’t yet contain the field.

Type: null or anything

Default: null

Declared by:

lock.fields.<name>.script

A script to refresh the value of this lock file field. The script should write the result as json file to $out.

Type: path

Declared by:

lock.invalidationData

Pass any data that should invalidate the lock file when changed. This is useful for example when the lock file should be regenerated when the requirements change.

Type: anything

Default: { }

Example:

{
  pip = {
    lockVersion = "2";
    requirements = [
      "requests"
      "pillow"
    ];
  };
}

Declared by:

lock.lib.computeFODHash

Helper function to write the hash of a given FOD to $out.

Type: function that evaluates to a(n) path (read only)

Declared by:

lock.refresh

Script to refresh the lock file

Type: package (read only)

Declared by:

name

The name of the package

Type: string

Declared by:

nodejs-package-lock-v3.packageLock

The content of the package-lock.json

Type: attribute set

Declared by:

nodejs-package-lock-v3.packageLockFile

The package-lock.json file to use.

Type: null or path

Declared by:

nodejs-package-lock-v3.pdefs

This option has no description.

Type: attribute set of attribute set of (submodule)

Declared by:

nodejs-package-lock-v3.pdefs.<name>.<name>.dependencies

This option has no description.

Type: attribute set of (submodule)

Declared by:

nodejs-package-lock-v3.pdefs.<name>.<name>.dependencies.<name>.dev

This option has no description.

Type: boolean

Declared by:

nodejs-package-lock-v3.pdefs.<name>.<name>.dependencies.<name>.version

This option has no description.

Type: string

Declared by:

nodejs-package-lock-v3.pdefs.<name>.<name>.source

This option has no description.

Type: string or path or package or (submodule)

Declared by:

paths.package

Path to the directory containing the definition of the current package. Relative to ‘paths.projectRoot’.

This helps locating package definitions for lock & update scripts.

Type: path or string

Declared by:

paths.cacheFile

Path to the eval cache file of the current package. Relative to “${paths.projectRoot}/${paths.package}”".

Type: string

Default: "cache.json"

Declared by:

paths.lockFile

Path to the lock file of the current package. Relative to “${paths.projectRoot}/${paths.package}”".

Type: string

Default: "lock.json"

Declared by:

paths.projectRoot

Path to the root of the project on which dream2nix operates. Must contain the marker file specified by ‘paths.projectRootFile’

This helps locating lock files at evaluation time.

Type: path

Example: ./.

Declared by:

paths.projectRootFile

File name to look for to determine the root of the project. Ensure ‘paths.projectRoot’ contains a file named like this.

This helps locating package definitions for lock & update scripts.

Type: string

Default: ".git"

Example: ".git"

Declared by:

public

The final result of the evaluated package. Contains everything that nix expects from a derivation. Contains fields like name, outputs, drvPath, outPath, etc. Can be build with nix-build or nix build.

Type: lazy attribute set of anything

Declared by:

public.docs

The manual of the package as a website

Type: package (read only)

Declared by:

version

The version of the package

Type: string

Declared by: