Add support for pnpm workspaces #35
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It is likely that a user may want to specify environment variables
during the build phase as well as during pnpm install. Add an argument
for a build specific environment. This allows the user to avoid
duplicating the environment between a configure or prebuild step and
installEnv, by using something like:
let
sharedEnv = { ... };
buildEnvOverrides = { ... };
installEnvOverrides = { ... };
in
mkPnpmPackage {
buildEnv = sharedEnv // buildEnvOverrides;
installEnv = sharedEnv // installEnvOverrides;
...
}
Allow a caller to specify a workspace and a list of components rather than a single source directory. This allows for the building of pnpm monorepo projects with dependency links between the various projects and a single pnpm-lock.yaml for the whole workspace. Requires that the script has the same name in all components. The location of all of the per-component package.json files is overridable. A workspace project can still specify the location of the root package.json via packageJSON, as well as the components' package.json files via componentPackageJSONs. The list defaults to c/package.json for c in components. Similarly, the list of distDirs for the components is overridable. For a workspace, the distDirs are all subdirs of $out rather than dist becoming $out. The default list is c/dist for c in components. Allowing for override handles the case where one component is built by a different tool like next and produces a different directory like ".next" NB: Any "link:" dependencies will need to be recreated as a preBuild step. pnpm will create the symlinks during install, and nix removes them because when the node_modules derivation is built, they are dangling. Attempts to leave the non-workspace pnpm package support intact.
A user may want the node_modules and package artifacts as a part of the output in order to have a runnable build artifact without needing the node-modules derivation or the sources available. Add options to control additional copies as a part of the install. Simplify the values used in the derivation so that the conditional logic is almost all in the let rather than in the derivation body. Some of this change should probably rebased into the first commit.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently a monorepo with multiple components doesn't work with the current pnpm2nix.
You can try to build the entire monorepo, but then fail to copy out all of the
node_modulesdirectories or you can try and build individual components, but pnpm complains if you pass it the project-wide lockfile for a specific component.Add
workspaceandcomponentsas an alternative tosrc. When building thenode-modulesderivation, copy out thenode_modulesdirectory for every named component in addition to thenode_modulesdirectory at the root.When building, pass the list of components as a filter to
pnpm run --recursive ${script}. When doing the install, allow the user to specify which directories to copy out, with a default of${component}/distfor each component.Currently doesn't have support for building individual components as separate derivations with shared
pnpm-storeandnode-modulesderivations.This works for building a project where we needed workspace support.