nix-community/dream2nix
1
1
Fork 0
mirror of https://github.com/nix-community/dream2nix.git synced 2024-12-02 14:55:25 +03:00
Code Issues Projects Releases Wiki Activity

devShell allowing for good interop with npm

Browse Source 
The shellHook always overwrites existing ./node_modules with a full
flat copy of all transitive dependencies produced by dream2nix from
the lock file.

This allows good interop with npm. npm is still needed to update or
add dependencies. npm can write to the ./node_modules without
any issues and add or replace dependencies.

If npm modifies ./node_modules, then its contents will be a mix of
dream2nix installed packages and npm installed packages until the
devShell is re-entered and dream2nix overwrites the ./node_modules
with a fully reproducible copy again.
This commit is contained in:
DavHau 2022-07-23 23:41:44 +02:00
parent 59f305953f
commit 81739947c4
1 changed files with 56 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
src/subsystems/nodejs/builders/granular/default.nix
View File

@ -243,20 +243,67 @@
passthru.dependencies = passthruDeps;
/*
devShell allowing for good interop with npm
The shellHook always overwrites existing ./node_modules with a full
flat copy of all transitive dependencies produced by dream2nix from
the lock file.
This allows good interop with npm. npm is still needed to update or
add dependencies. npm can write to the ./node_modules without
any issues and add or replace dependencies.
If npm modifies ./node_modules, then its contents will be a mix of
dream2nix installed packages and npm installed packages until the
devShell is re-entered and dream2nix overwrites the ./node_modules
with a fully reproducible copy again.
*/
passthru.devShell = pkgs.mkShell {
buildInputs = [
nodejs
];
shellHook = ''
shellHook = let
/*
This uses the existig package derivation, and modifies it, to
disable all phases but the one which creates the ./node_modules.
The result is a derivation only generating the node_modules and
.bin directories.
TODO: This is be a bit hacky and could be abstracted better
TODO: Don't always delete all of ./node_modules. Only overwrite
missing or changed modules.
*/
nodeModulesDrv = pkg.overrideAttrs (old: {
buildPhase = ":";
installMethod = "copy";
src = "";
dontUnpack = true;
dontPatch = true;
dontBuild = true;
dontInstall = true;
dontFixup = true;
# the configurePhase fails if these variables are not set
d2nPatchPhase = ''
nodeModules=$out/lib/node_modules
mkdir -p $nodeModules/$packageName
cd $nodeModules/$packageName
'';
});
nodeModulesDir = "${nodeModulesDrv}/lib/node_modules/${packageName}/node_modules";
binDir = "${nodeModulesDrv}/lib/node_modules/.bin";
in ''
# create the ./node_modules directory
if [ -e ./node_modules ] && [ ! -L ./node_modules ]; then
echo -e "\nFailed creating the ./node_modules symlink to ${nodeModulesDir}"
echo -e "\n./node_modules already exists and is a directory, which means it is managed by another program. Please delete ./node_modules first and re-enter the dev shell."
else
rm -f ./node_modules
ln -s ${nodeModulesDir} ./node_modules
export PATH="$PATH:$(realpath ./node_modules)/.bin"
fi
rm -rf ./node_modules
mkdir -p ./node_modules/.bin
cp -r ${nodeModulesDir}/* ./node_modules/
for link in $(ls ${binDir}); do
target=$(readlink ${binDir}/$link | cut -d'/' -f4-)
ln -s ../$target ./node_modules/.bin/$link
done
chmod -R +w ./node_modules
export PATH="$PATH:$(realpath ./node_modules)/.bin"
'';
};