commit 434df3c94b413ea1bd2f7310c7b821356f9edaf4 · pyrox.dev/nixpkgs

+31

doc/languages-frameworks/javascript.section.md

···

       233
       233
        
       

     

       234
       234
        
       It returns a derivation with all `package-lock.json` dependencies downloaded into `$out/`, usable as an npm cache.

     

       235
       235
        
       

     

       236
       236
       +
       #### importNpmLock {#javascript-buildNpmPackage-importNpmLock}

     

       237
       237
       +
       

     

       238
       238
       +
       `importNpmLock` is a Nix function that requires the following optional arguments:

     

       239
       239
       +
       

     

       240
       240
       +
       - `npmRoot`: Path to package directory containing the source tree

     

       241
       241
       +
       - `package`: Parsed contents of `package.json`

     

       242
       242
       +
       - `packageLock`: Parsed contents of `package-lock.json`

     

       243
       243
       +
       - `pname`: Package name

     

       244
       244
       +
       - `version`: Package version

     

       245
       245
       +
       

     

       246
       246
       +
       It returns a derivation with a patched `package.json` & `package-lock.json` with all dependencies resolved to Nix store paths.

     

       247
       247
       +
       

     

       248
       248
       +
       This function is analogous to using `fetchNpmDeps`, but instead of specifying `hash` it uses metadata from `package.json` & `package-lock.json`.

     

       249
       249
       +
       

     

       250
       250
       +
       Note that `npmHooks.npmConfigHook` cannot be used with `importNpmLock`. You will instead need to use `importNpmLock.npmConfigHook`:

     

       251
       251
       +
       

     

       252
       252
       +
       ```nix

     

       253
       253
       +
       { buildNpmPackage, importNpmLock }:

     

       254
       254
       +
       

     

       255
       255
       +
       buildNpmPackage {

     

       256
       256
       +
         pname = "hello";

     

       257
       257
       +
         version = "0.1.0";

     

       258
       258
       +
       

     

       259
       259
       +
         npmDeps = importNpmLock {

     

       260
       260
       +
           npmRoot = ./.;

     

       261
       261
       +
         };

     

       262
       262
       +
       

     

       263
       263
       +
         npmConfigHook = importNpmLock.npmConfigHook;

     

       264
       264
       +
       }

     

       265
       265
       +
       ```

     

       266
       266
       +
       

     

       236
       267
        
       ### corepack {#javascript-corepack}

     

       237
       268
        
       

     

       238
       269
        
       This package puts the corepack wrappers for pnpm and yarn in your PATH, and they will honor the `packageManager` setting in the `package.json`.

+14 -3

pkgs/build-support/node/build-npm-package/default.nix

···

       49
       49
        
         name = "${name}-npm-deps";

     

       50
       50
        
         hash = npmDepsHash;

     

       51
       51
        
       }

     

       52
       52
       +
         # Custom npmConfigHook

     

       53
       53
       +
       , npmConfigHook ? null

     

       54
       54
       +
         # Custom npmBuildHook

     

       55
       55
       +
       , npmBuildHook ? null

     

       56
       56
       +
         # Custom npmInstallHook

     

       57
       57
       +
       , npmInstallHook ? null

     

       52
       58
        
       , ...

     

       53
       59
        
       } @ args:

     

       54
       60
        
       

     
···

       57
       63
        
         npmHooks = buildPackages.npmHooks.override {

     

       58
       64
        
           inherit nodejs;

     

       59
       65
        
         };

     

       60
       60
       -
       

     

       61
       61
       -
         inherit (npmHooks) npmConfigHook npmBuildHook npmInstallHook;

     

       62
       66
        
       in

     

       63
       67
        
       stdenv.mkDerivation (args // {

     

       64
       68
        
         inherit npmDeps npmBuildScript;

     

       65
       69
        
       

     

       66
       70
        
         nativeBuildInputs = nativeBuildInputs

     

       67
       67
       -
           ++ [ nodejs npmConfigHook npmBuildHook npmInstallHook nodejs.python ]

     

       71
       71
       +
           ++ [

     

       72
       72
       +
             nodejs

     

       73
       73
       +
             # Prefer passed hooks

     

       74
       74
       +
             (if npmConfigHook != null then npmConfigHook else npmHooks.npmConfigHook)

     

       75
       75
       +
             (if npmBuildHook != null then npmBuildHook else npmHooks.npmBuildHook)

     

       76
       76
       +
             (if npmInstallHook != null then npmInstallHook else npmHooks.npmInstallHook)

     

       77
       77
       +
             nodejs.python

     

       78
       78
       +
           ]

     

       68
       79
        
           ++ lib.optionals stdenv.isDarwin [ darwin.cctools ];

     

       69
       80
        
         buildInputs = buildInputs ++ [ nodejs ];

     

       70
       81

+134

pkgs/build-support/node/import-npm-lock/default.nix

···

       1
       1
       +
       { lib

     

       2
       2
       +
       , fetchurl

     

       3
       3
       +
       , stdenv

     

       4
       4
       +
       , callPackages

     

       5
       5
       +
       , runCommand

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         inherit (builtins) match elemAt toJSON removeAttrs;

     

       10
       10
       +
         inherit (lib) importJSON mapAttrs;

     

       11
       11
       +
       

     

       12
       12
       +
         matchGitHubReference = match "github(.com)?:.+";

     

       13
       13
       +
         getName = package: package.name or "unknown";

     

       14
       14
       +
         getVersion = package: package.version or "0.0.0";

     

       15
       15
       +
       

     

       16
       16
       +
         # Fetch a module from package-lock.json -> packages

     

       17
       17
       +
         fetchModule =

     

       18
       18
       +
           { module

     

       19
       19
       +
           , npmRoot ? null

     

       20
       20
       +
           }: (

     

       21
       21
       +
             if module ? "resolved" then

     

       22
       22
       +
               (

     

       23
       23
       +
                 let

     

       24
       24
       +
                   # Parse scheme from URL

     

       25
       25
       +
                   mUrl = match "(.+)://(.+)" module.resolved;

     

       26
       26
       +
                   scheme = elemAt mUrl 0;

     

       27
       27
       +
                 in

     

       28
       28
       +
                 (

     

       29
       29
       +
                   if mUrl == null then

     

       30
       30
       +
                     (

     

       31
       31
       +
                       assert npmRoot != null; {

     

       32
       32
       +
                         outPath = npmRoot + "/${module.resolved}";

     

       33
       33
       +
                       }

     

       34
       34
       +
                     )

     

       35
       35
       +
                   else if (scheme == "http" || scheme == "https") then

     

       36
       36
       +
                     (

     

       37
       37
       +
                       fetchurl {

     

       38
       38
       +
                         url = module.resolved;

     

       39
       39
       +
                         hash = module.integrity;

     

       40
       40
       +
                       }

     

       41
       41
       +
                     )

     

       42
       42
       +
                   else if lib.hasPrefix "git" module.resolved then

     

       43
       43
       +
                     (

     

       44
       44
       +
                       builtins.fetchGit {

     

       45
       45
       +
                         url = module.resolved;

     

       46
       46
       +
                       }

     

       47
       47
       +
                     )

     

       48
       48
       +
                   else throw "Unsupported URL scheme: ${scheme}"

     

       49
       49
       +
                 )

     

       50
       50
       +
               )

     

       51
       51
       +
             else null

     

       52
       52
       +
           );

     

       53
       53
       +
       

     

       54
       54
       +
         # Manage node_modules outside of the store with hooks

     

       55
       55
       +
         hooks = callPackages ./hooks { };

     

       56
       56
       +
       

     

       57
       57
       +
       in

     

       58
       58
       +
       {

     

       59
       59
       +
         importNpmLock =

     

       60
       60
       +
           { npmRoot ? null

     

       61
       61
       +
           , package ? importJSON (npmRoot + "/package.json")

     

       62
       62
       +
           , packageLock ? importJSON (npmRoot + "/package-lock.json")

     

       63
       63
       +
           , pname ? getName package

     

       64
       64
       +
           , version ? getVersion package

     

       65
       65
       +
           }:

     

       66
       66
       +
           let

     

       67
       67
       +
             mapLockDependencies =

     

       68
       68
       +
               mapAttrs

     

       69
       69
       +
                 (name: version: (

     

       70
       70
       +
                   # Substitute the constraint with the version of the dependency from the top-level of package-lock.

     

       71
       71
       +
                   if (

     

       72
       72
       +
                     # if the version is `latest`

     

       73
       73
       +
                     version == "latest"

     

       74
       74
       +
                     ||

     

       75
       75
       +
                     # Or if it's a github reference

     

       76
       76
       +
                     matchGitHubReference version != null

     

       77
       77
       +
                   ) then packageLock'.packages.${"node_modules/${name}"}.version

     

       78
       78
       +
                   # But not a regular version constraint

     

       79
       79
       +
                   else version

     

       80
       80
       +
                 ));

     

       81
       81
       +
       

     

       82
       82
       +
             packageLock' = packageLock // {

     

       83
       83
       +
               packages =

     

       84
       84
       +
                 mapAttrs

     

       85
       85
       +
                   (_: module:

     

       86
       86
       +
                     let

     

       87
       87
       +
                       src = fetchModule {

     

       88
       88
       +
                         inherit module npmRoot;

     

       89
       89
       +
                       };

     

       90
       90
       +
                     in

     

       91
       91
       +
                     (removeAttrs module [

     

       92
       92
       +
                       "link"

     

       93
       93
       +
                       "funding"

     

       94
       94
       +
                     ]) // lib.optionalAttrs (src != null) {

     

       95
       95
       +
                       resolved = "file:${src}";

     

       96
       96
       +
                     } // lib.optionalAttrs (module ? dependencies) {

     

       97
       97
       +
                       dependencies = mapLockDependencies module.dependencies;

     

       98
       98
       +
                     } // lib.optionalAttrs (module ? optionalDependencies) {

     

       99
       99
       +
                       optionalDependencies = mapLockDependencies module.optionalDependencies;

     

       100
       100
       +
                     })

     

       101
       101
       +
                   packageLock.packages;

     

       102
       102
       +
             };

     

       103
       103
       +
       

     

       104
       104
       +
             mapPackageDependencies = mapAttrs (name: _: packageLock'.packages.${"node_modules/${name}"}.resolved);

     

       105
       105
       +
       

     

       106
       106
       +
             # Substitute dependency references in package.json with Nix store paths

     

       107
       107
       +
             packageJSON' = package // lib.optionalAttrs (package ? dependencies) {

     

       108
       108
       +
               dependencies = mapPackageDependencies package.dependencies;

     

       109
       109
       +
             } // lib.optionalAttrs (package ? devDependencies) {

     

       110
       110
       +
               devDependencies = mapPackageDependencies package.devDependencies;

     

       111
       111
       +
             };

     

       112
       112
       +
       

     

       113
       113
       +
             pname = package.name or "unknown";

     

       114
       114
       +
       

     

       115
       115
       +
           in

     

       116
       116
       +
           runCommand "${pname}-${version}-sources"

     

       117
       117
       +
             {

     

       118
       118
       +
               inherit pname version;

     

       119
       119
       +
       

     

       120
       120
       +
               passAsFile = [ "package" "packageLock" ];

     

       121
       121
       +
       

     

       122
       122
       +
               package = toJSON packageJSON';

     

       123
       123
       +
               packageLock = toJSON packageLock';

     

       124
       124
       +
             } ''

     

       125
       125
       +
             mkdir $out

     

       126
       126
       +
             cp "$packagePath" $out/package.json

     

       127
       127
       +
             cp "$packageLockPath" $out/package-lock.json

     

       128
       128
       +
           '';

     

       129
       129
       +
       

     

       130
       130
       +
         inherit hooks;

     

       131
       131
       +
         inherit (hooks) npmConfigHook;

     

       132
       132
       +
       

     

       133
       133
       +
         __functor = self: self.importNpmLock;

     

       134
       134
       +
       }

+52

pkgs/build-support/node/import-npm-lock/hooks/canonicalize-symlinks.js

···

       1
       1
       +
       #!/usr/bin/env node

     

       2
       2
       +
       const fs = require("fs");

     

       3
       3
       +
       const path = require("path");

     

       4
       4
       +
       

     

       5
       5
       +
       // When installing files rewritten to the Nix store with npm

     

       6
       6
       +
       // npm writes the symlinks relative to the build directory.

     

       7
       7
       +
       //

     

       8
       8
       +
       // This makes relocating node_modules tricky when refering to the store.

     

       9
       9
       +
       // This script walks node_modules and canonicalizes symlinks.

     

       10
       10
       +
       

     

       11
       11
       +
       async function canonicalize(storePrefix, root) {

     

       12
       12
       +
         console.log(storePrefix, root)

     

       13
       13
       +
         const entries = await fs.promises.readdir(root);

     

       14
       14
       +
         const paths = entries.map((entry) => path.join(root, entry));

     

       15
       15
       +
       

     

       16
       16
       +
         const stats = await Promise.all(

     

       17
       17
       +
           paths.map(async (path) => {

     

       18
       18
       +
             return {

     

       19
       19
       +
               path: path,

     

       20
       20
       +
               stat: await fs.promises.lstat(path),

     

       21
       21
       +
             };

     

       22
       22
       +
           })

     

       23
       23
       +
         );

     

       24
       24
       +
       

     

       25
       25
       +
         const symlinks = stats.filter((stat) => stat.stat.isSymbolicLink());

     

       26
       26
       +
         const dirs = stats.filter((stat) => stat.stat.isDirectory());

     

       27
       27
       +
       

     

       28
       28
       +
         // Canonicalize symlinks to their real path

     

       29
       29
       +
         await Promise.all(

     

       30
       30
       +
           symlinks.map(async (stat) => {

     

       31
       31
       +
             const target = await fs.promises.realpath(stat.path);

     

       32
       32
       +
             if (target.startsWith(storePrefix)) {

     

       33
       33
       +
               await fs.promises.unlink(stat.path);

     

       34
       34
       +
               await fs.promises.symlink(target, stat.path);

     

       35
       35
       +
             }

     

       36
       36
       +
           })

     

       37
       37
       +
         );

     

       38
       38
       +
       

     

       39
       39
       +
         // Recurse into directories

     

       40
       40
       +
         await Promise.all(dirs.map((dir) => canonicalize(storePrefix, dir.path)));

     

       41
       41
       +
       }

     

       42
       42
       +
       

     

       43
       43
       +
       async function main() {

     

       44
       44
       +
         const args = process.argv.slice(2);

     

       45
       45
       +
         const storePrefix = args[0];

     

       46
       46
       +
       

     

       47
       47
       +
         if (fs.existsSync("node_modules")) {

     

       48
       48
       +
           await canonicalize(storePrefix, "node_modules");

     

       49
       49
       +
         }

     

       50
       50
       +
       }

     

       51
       51
       +
       

     

       52
       52
       +
       main();

+13

pkgs/build-support/node/import-npm-lock/hooks/default.nix

···

       1
       1
       +
       { callPackage, lib, makeSetupHook, srcOnly, nodejs }:

     

       2
       2
       +
       {

     

       3
       3
       +
         npmConfigHook = makeSetupHook

     

       4
       4
       +
           {

     

       5
       5
       +
             name = "npm-config-hook";

     

       6
       6
       +
             substitutions = {

     

       7
       7
       +
               nodeSrc = srcOnly nodejs;

     

       8
       8
       +
               nodeGyp = "${nodejs}/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js";

     

       9
       9
       +
               canonicalizeSymlinksScript = ./canonicalize-symlinks.js;

     

       10
       10
       +
               storePrefix = builtins.storeDir;

     

       11
       11
       +
             };

     

       12
       12
       +
           } ./npm-config-hook.sh;

     

       13
       13
       +
       }

+70

pkgs/build-support/node/import-npm-lock/hooks/npm-config-hook.sh

···

       1
       1
       +
       # shellcheck shell=bash

     

       2
       2
       +
       

     

       3
       3
       +
       npmConfigHook() {

     

       4
       4
       +
           echo "Executing npmConfigHook"

     

       5
       5
       +
       

     

       6
       6
       +
           if [ -n "${npmRoot-}" ]; then

     

       7
       7
       +
             pushd "$npmRoot"

     

       8
       8
       +
           fi

     

       9
       9
       +
       

     

       10
       10
       +
           if [ -z "${npmDeps-}" ]; then

     

       11
       11
       +
               echo "Error: 'npmDeps' should be set when using npmConfigHook."

     

       12
       12
       +
               exit 1

     

       13
       13
       +
           fi

     

       14
       14
       +
       

     

       15
       15
       +
           echo "Configuring npm"

     

       16
       16
       +
       

     

       17
       17
       +
           export HOME="$TMPDIR"

     

       18
       18
       +
           export npm_config_nodedir="@nodeSrc@"

     

       19
       19
       +
           export npm_config_node_gyp="@nodeGyp@"

     

       20
       20
       +
           npm config set offline true

     

       21
       21
       +
           npm config set progress false

     

       22
       22
       +
           npm config set fund false

     

       23
       23
       +
       

     

       24
       24
       +
           echo "Installing patched package.json/package-lock.json"

     

       25
       25
       +
       

     

       26
       26
       +
           # Save original package.json/package-lock.json for closure size reductions.

     

       27
       27
       +
           # The patched one contains store paths we don't want at runtime.

     

       28
       28
       +
           mv package.json .package.json.orig

     

       29
       29
       +
           if test -f package-lock.json; then # Not all packages have package-lock.json.

     

       30
       30
       +
               mv package-lock.json .package-lock.json.orig

     

       31
       31
       +
           fi

     

       32
       32
       +
           cp --no-preserve=mode "${npmDeps}/package.json" package.json

     

       33
       33
       +
           cp --no-preserve=mode "${npmDeps}/package-lock.json" package-lock.json

     

       34
       34
       +
       

     

       35
       35
       +
           echo "Installing dependencies"

     

       36
       36
       +
       

     

       37
       37
       +
           if ! npm install --ignore-scripts $npmInstallFlags "${npmInstallFlagsArray[@]}" $npmFlags "${npmFlagsArray[@]}"; then

     

       38
       38
       +
               echo

     

       39
       39
       +
               echo "ERROR: npm failed to install dependencies"

     

       40
       40
       +
               echo

     

       41
       41
       +
               echo "Here are a few things you can try, depending on the error:"

     

       42
       42
       +
               echo '1. Set `npmFlags = [ "--legacy-peer-deps" ]`'

     

       43
       43
       +
               echo

     

       44
       44
       +
       

     

       45
       45
       +
               exit 1

     

       46
       46
       +
           fi

     

       47
       47
       +
       

     

       48
       48
       +
           patchShebangs node_modules

     

       49
       49
       +
       

     

       50
       50
       +
           npm rebuild $npmRebuildFlags "${npmRebuildFlagsArray[@]}" $npmFlags "${npmFlagsArray[@]}"

     

       51
       51
       +
       

     

       52
       52
       +
           patchShebangs node_modules

     

       53
       53
       +
       

     

       54
       54
       +
           # Canonicalize symlinks from relative paths to the Nix store.

     

       55
       55
       +
           node @canonicalizeSymlinksScript@ @storePrefix@

     

       56
       56
       +
       

     

       57
       57
       +
           # Revert to pre-patched package.json/package-lock.json for closure size reductions

     

       58
       58
       +
           mv .package.json.orig package.json

     

       59
       59
       +
           if test -f ".package-lock.json.orig"; then

     

       60
       60
       +
               mv .package-lock.json.orig package-lock.json

     

       61
       61
       +
           fi

     

       62
       62
       +
       

     

       63
       63
       +
           if [ -n "${npmRoot-}" ]; then

     

       64
       64
       +
             popd

     

       65
       65
       +
           fi

     

       66
       66
       +
       

     

       67
       67
       +
           echo "Finished npmConfigHook"

     

       68
       68
       +
       }

     

       69
       69
       +
       

     

       70
       70
       +
       postConfigureHooks+=(npmConfigHook)

pkgs/top-level/all-packages.nix

···

       10262
       10262
        
         inherit (callPackages ../build-support/node/fetch-npm-deps { })

     

       10263
       10263
        
           fetchNpmDeps prefetch-npm-deps;

     

       10264
       10264
        
       

     

       10265
       10265
       +
         importNpmLock = callPackages ../build-support/node/import-npm-lock { };

     

       10266
       10266
       +
       

     

       10265
       10267
        
         nodePackages_latest = dontRecurseIntoAttrs nodejs_latest.pkgs // { __attrsFailEvaluation = true; };

     

       10266
       10268
        
       

     

       10267
       10269
        
         nodePackages = dontRecurseIntoAttrs nodejs.pkgs // { __attrsFailEvaluation = true; };