From 33e99e794b60d9fdf7f7d82348ec0efdf77717ab Mon Sep 17 00:00:00 2001 From: Jaafar El Harouchi Date: Sat, 8 Jul 2023 23:01:40 +0100 Subject: [PATCH] update documentation for Generator development setup [skip ci] document that `npm ci` should be run before `npm link` Fix #22732 --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f344fbffcbc3..a14cdb27ff64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -221,12 +221,12 @@ Go to the [generator-jhipster project](https://github.com/jhipster/generator-jhi ### Set NPM to use the cloned project -In your cloned `generator-jhipster` project, run `npm link` and then run `npm ci`. - -`npm link` will make a symbolic link from the global `node_modules` version to point to this folder, so when we run `jhipster`, you will now use the development version of JHipster. +In your cloned `generator-jhipster` project, run `npm ci` and then run `npm link`. `npm ci` will do a clean installation of all the project dependencies. +`npm link` will make a symbolic link from the global `node_modules` version to point to this folder, so when we run `jhipster`, you will now use the development version of JHipster. + For testing, you will want to generate an application, and there is a specific issue here: for each application, JHipster installs a local version of itself. This is made to enable several applications to each use a specific JHipster version (application A uses JHipster 3.1.0, and application B uses JHipster 3.2.0). To overcome this you need to run `npm link generator-jhipster` on the generated project folder as well, so that the local version has a symbolic link to the development version of JHipster.