about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorgithub-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>2024-03-09 00:11:53 +0000
committerGitHub <noreply@github.com>2024-03-09 00:11:53 +0000
commit54e3ad544249ba9aea3ea7e7918738becd673923 (patch)
tree554f739a4a62ee6d295c1fde2c0fc493414d317c /doc
parenta32bb438c0219345fc535b4f910da21fa4c4aaa2 (diff)
parent6b3b8bb7e779be721d5c8515d0077a706eeab0a3 (diff)
downloadnixlib-54e3ad544249ba9aea3ea7e7918738becd673923.tar
nixlib-54e3ad544249ba9aea3ea7e7918738becd673923.tar.gz
nixlib-54e3ad544249ba9aea3ea7e7918738becd673923.tar.bz2
nixlib-54e3ad544249ba9aea3ea7e7918738becd673923.tar.lz
nixlib-54e3ad544249ba9aea3ea7e7918738becd673923.tar.xz
nixlib-54e3ad544249ba9aea3ea7e7918738becd673923.tar.zst
nixlib-54e3ad544249ba9aea3ea7e7918738becd673923.zip
Merge master into haskell-updates
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/javascript.section.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/languages-frameworks/javascript.section.md b/doc/languages-frameworks/javascript.section.md
index 4dc207f79847..c148070ad244 100644
--- a/doc/languages-frameworks/javascript.section.md
+++ b/doc/languages-frameworks/javascript.section.md
@@ -233,6 +233,37 @@ sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=
 
 It returns a derivation with all `package-lock.json` dependencies downloaded into `$out/`, usable as an npm cache.
 
+#### importNpmLock {#javascript-buildNpmPackage-importNpmLock}
+
+`importNpmLock` is a Nix function that requires the following optional arguments:
+
+- `npmRoot`: Path to package directory containing the source tree
+- `package`: Parsed contents of `package.json`
+- `packageLock`: Parsed contents of `package-lock.json`
+- `pname`: Package name
+- `version`: Package version
+
+It returns a derivation with a patched `package.json` & `package-lock.json` with all dependencies resolved to Nix store paths.
+
+This function is analogous to using `fetchNpmDeps`, but instead of specifying `hash` it uses metadata from `package.json` & `package-lock.json`.
+
+Note that `npmHooks.npmConfigHook` cannot be used with `importNpmLock`. You will instead need to use `importNpmLock.npmConfigHook`:
+
+```nix
+{ buildNpmPackage, importNpmLock }:
+
+buildNpmPackage {
+  pname = "hello";
+  version = "0.1.0";
+
+  npmDeps = importNpmLock {
+    npmRoot = ./.;
+  };
+
+  npmConfigHook = importNpmLock.npmConfigHook;
+}
+```
+
 ### corepack {#javascript-corepack}
 
 This package puts the corepack wrappers for pnpm and yarn in your PATH, and they will honor the `packageManager` setting in the `package.json`.