Skip to content

Commit

Permalink
update documentation for Generator development setup [skip ci]
Browse files Browse the repository at this point in the history
document that `npm ci` should be run before `npm link`

Fix jhipster#22732
  • Loading branch information
jelharou committed Jul 8, 2023
1 parent 4eb0dba commit 33e99e7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 33e99e7

Please sign in to comment.