Pnpm workspaces
#PNPM WORKSPACES HOW TO#
#PNPM WORKSPACES INSTALL#
#PNPM WORKSPACES HOW TO#
You can read about how to configure it in the Nx docs. Nx also provides a cache mechanism, so it won’t execute a dependent task of a package that has not been modified since it was executed the last time, so you don’t have to care about the performance of running every dependent tasks always. Should we execute it manually before running the affected command? If we have twenty packages in the workspace, some of them containing a build command, and some others not, then should we create a build:affected script and execute it always before running the unit tests? Well, we could, but Nx provides a mechanism to define dependent tasks, so it detects whether any package have dependent tasks that should be executed before others, and it executes them in that case. Now we can run the unit tests of the affected packages with a single command, but, what about if the unit:test script in any package needs any other script to be executed before? For example, suppose that the sum-two package has a build script that must be executed before running the unit tests.
#PNPM WORKSPACES INSTALL#
We will install Jest in the workspace (as mentioned above, it is a devDependency, so we don’t have to install it on every single package):īut, if you create another branch and modify the packages/sum-one/index.js file, running pnpm test:unit:affected would execute the unit tests of both packages, because modifying sum-one also affects to sum-two. So, let’s add one unit test to our recently created package in order to see an example. The scripts of each project can be executed independently from each package folder, and we can also define scripts for the workspace. And we can also use executables of the dependencies installed in the workspace from the npm scripts of the packages! 🥳 Project and workspace scripts Note that the dependencies of all packages in the repository are installed when pnpm i is executed in the root folder. Otherwise, they will be missing when the packages are published. but note that the dependencies of each package (those required to work once they are published) must remain on their own package.json files. The one in the root folder should contain shared devDependencies across many projects, such as test, build or lint libraries, etc. Now we have two package.json files in the repository. exports = sumOne Project and workspace dependencies Here we are going to use npm to install it:įunction sumOne ( number ) There are many methods for installing it, you can check them all in the Pnpm installation docs. Installing PnpmĪs seen in the previous post, we are going to use Pnpm mainly to be able to link packages locally using its workspace feature.įirst of all you have to install Pnpm globally in order to use it as Npm client and to run the package.json scripts that we will create in next steps. I also like to keep integration or E2E tests in a different folder. In this case, all packages could be distributable and dependencies of other ones, that’s why the folder is named packages. Nx recommends as best practices to have an app folder and a libs folder for reusable libraries, but in my opinion that structure is more recommendable if you are going to include also front-end projects or other type of not versioned and distributable applications. You could store your packages depending of their type in different folders, for example. The name of the folders is something that can be changed at your convenience.