Testing yeoman generator locally

Question

I'm creating a yeoman generator for my web projects.

But I wonder how I can try and test my changes before publishing it?

Since I have installed it once, it will not run my local development version, instead it runs my installed version.

Any suggestions on how can test-run my local development version?

score 33 · Accepted Answer · edited Dec 11 '19 at 00:10

33

I finally found some information on how to accomplish this:

if you wish to develop on the generators code base, and debug locally, a common way to do so is to rely on npm link

git clone the generators repo locally
cd into that repository and run npm link. It'll install required dependencies and install the package globally, using a symbolic link to your local version.
If you want to install sub generators, you need to do so in the context of a yeoman-generator package linked earlier. Cd into the sub generators package you have cloned locally and run npm link.
We now have everything linked and known on the system, we now need to link the sub-generator repo into the parent one, yeoman-generator cloned and linked in step 1 & 2.

EDIT:

edited Dec 11 '19 at 00:10

micrub

answered Jun 05 '14 at 11:27

Andreas Norman

1

The latest docs for this are at: http://yeoman.io/authoring/index.html (under _"Running the generator"_) – Jess Telford Jul 14 '16 at 06:30
Is there no way to test the generator without installing it globally? I would like to test my generator without affecting the global npm installation. – tttppp Jun 27 '19 at 13:20
1

@tttppp You can run a generator from a path using `yo /path/to/generator/module`. That path would be the path to the generator module itself. – ankon Jul 15 '19 at 09:49
I send you so much love <3 – Maelig Jan 21 '22 at 13:08

score 4 · Answer 2 · answered Mar 22 '18 at 12:50

If by "running locally" you mean the ability to test your generator and its flow you can simply do this.

In your project directory folder run npm link. If this passes in flying colors, go to step 2.
Open a terminal and cd into the folder you wish to initiate a project.
Run yo generator-theNameOfYourGenerator. This will run your generator.

2 Answers2