mirror of
https://github.com/SebastianWendel/nixpkgs.git
synced 2024-09-20 04:19:00 +02:00
b6e4b86809
This is an alternative to `fetchNpmDeps` that is notably different in that it uses metadata from `package.json` & `package-lock.json` instead of specifying a fixed-output hash. Notable features: - IFD free. - Only fetches a node dependency once. No massive FODs. - Support for URL, Git and path dependencies. - Uses most of the existing `npmHooks` `importNpmLock` can be used _only_ in the cases where we need to check in a `package-lock.json` in the tree. Currently this means that we have 13 packages that would be candidates to use this function, though I expect most usage to be in private repositories. This is upstreaming the builder portion of https://github.com/adisbladis/buildNodeModules into nixpkgs (different naming but the code is the same). I will archive this repository and consider nixpkgs the new upstream once it's been merged. For more explanations and rationale see https://discourse.nixos.org/t/buildnodemodules-the-dumbest-node-to-nix-packaging-tool-yet/35733 Example usage: ``` nix stdenv.mkDerivation { pname = "my-nodejs-app"; version = "0.1.0"; src = ./.; nativeBuildInputs = [ importNpmLock.hooks.npmConfigHook nodejs nodejs.passthru.python # for node-gyp npmHooks.npmBuildHook npmHooks.npmInstallHook ]; npmDeps = buildNodeModules.fetchNodeModules { npmRoot = ./.; }; } ```
89 lines
2.7 KiB
Nix
89 lines
2.7 KiB
Nix
{ lib
|
|
, stdenv
|
|
, fetchNpmDeps
|
|
, buildPackages
|
|
, nodejs
|
|
, darwin
|
|
} @ topLevelArgs:
|
|
|
|
{ name ? "${args.pname}-${args.version}"
|
|
, src ? null
|
|
, srcs ? null
|
|
, sourceRoot ? null
|
|
, prePatch ? ""
|
|
, patches ? [ ]
|
|
, postPatch ? ""
|
|
, nativeBuildInputs ? [ ]
|
|
, buildInputs ? [ ]
|
|
# The output hash of the dependencies for this project.
|
|
# Can be calculated in advance with prefetch-npm-deps.
|
|
, npmDepsHash ? ""
|
|
# Whether to force the usage of Git dependencies that have install scripts, but not a lockfile.
|
|
# Use with care.
|
|
, forceGitDeps ? false
|
|
# Whether to force allow an empty dependency cache.
|
|
# This can be enabled if there are truly no remote dependencies, but generally an empty cache indicates something is wrong.
|
|
, forceEmptyCache ? false
|
|
# Whether to make the cache writable prior to installing dependencies.
|
|
# Don't set this unless npm tries to write to the cache directory, as it can slow down the build.
|
|
, makeCacheWritable ? false
|
|
# The script to run to build the project.
|
|
, npmBuildScript ? "build"
|
|
# Flags to pass to all npm commands.
|
|
, npmFlags ? [ ]
|
|
# Flags to pass to `npm ci`.
|
|
, npmInstallFlags ? [ ]
|
|
# Flags to pass to `npm rebuild`.
|
|
, npmRebuildFlags ? [ ]
|
|
# Flags to pass to `npm run ${npmBuildScript}`.
|
|
, npmBuildFlags ? [ ]
|
|
# Flags to pass to `npm pack`.
|
|
, npmPackFlags ? [ ]
|
|
# Flags to pass to `npm prune`.
|
|
, npmPruneFlags ? npmInstallFlags
|
|
# Value for npm `--workspace` flag and directory in which the files to be installed are found.
|
|
, npmWorkspace ? null
|
|
, nodejs ? topLevelArgs.nodejs
|
|
, npmDeps ? fetchNpmDeps {
|
|
inherit forceGitDeps forceEmptyCache src srcs sourceRoot prePatch patches postPatch;
|
|
name = "${name}-npm-deps";
|
|
hash = npmDepsHash;
|
|
}
|
|
# Custom npmConfigHook
|
|
, npmConfigHook ? null
|
|
# Custom npmBuildHook
|
|
, npmBuildHook ? null
|
|
# Custom npmInstallHook
|
|
, npmInstallHook ? null
|
|
, ...
|
|
} @ args:
|
|
|
|
let
|
|
# .override {} negates splicing, so we need to use buildPackages explicitly
|
|
npmHooks = buildPackages.npmHooks.override {
|
|
inherit nodejs;
|
|
};
|
|
in
|
|
stdenv.mkDerivation (args // {
|
|
inherit npmDeps npmBuildScript;
|
|
|
|
nativeBuildInputs = nativeBuildInputs
|
|
++ [
|
|
nodejs
|
|
# Prefer passed hooks
|
|
(if npmConfigHook != null then npmConfigHook else npmHooks.npmConfigHook)
|
|
(if npmBuildHook != null then npmBuildHook else npmHooks.npmBuildHook)
|
|
(if npmInstallHook != null then npmInstallHook else npmHooks.npmInstallHook)
|
|
nodejs.python
|
|
]
|
|
++ lib.optionals stdenv.isDarwin [ darwin.cctools ];
|
|
buildInputs = buildInputs ++ [ nodejs ];
|
|
|
|
strictDeps = true;
|
|
|
|
# Stripping takes way too long with the amount of files required by a typical Node.js project.
|
|
dontStrip = args.dontStrip or true;
|
|
|
|
meta = (args.meta or { }) // { platforms = args.meta.platforms or nodejs.meta.platforms; };
|
|
})
|