Expose the directory where the generator is being executed

[ericmorand]

This PR propose an elegant solution to issue #947.

By exposing the directory where the generator was executed, we give the opportunity to subgenerators to scaffold into the current folder instead of the project folder.

Tests have been implemented. I hope the name contextRoot for the property is OK to everyone.

[ericmorand]

Can someone relaunch the checks? There was a timeout on one of them that has nothing to do with that PR.

[mischah]

Restarted Node 6.

[ericmorand]

@mischah Thanks a lot!

[sindresorhus]

Please give the pull request a descriptive title ;)

[ericmorand]

Done. I also clarified the description.

[SBoudrias]

So, this.env.cwd is always available (it doesn't change when the destinationRoot changes). Any reason you want to also make it available as this.contextRoot?

[ericmorand]

this.env.cwd does change when destinationRoot() is called:

Base.prototype.destinationRoot = function (rootPath) {
  if (_.isString(rootPath)) {
    this._destinationRoot = path.resolve(rootPath);

    if (!pathExists.sync(rootPath)) {
      mkdirp.sync(rootPath);
    }

    process.chdir(rootPath);
    this.env.cwd = rootPath;

    // Reset the storage
    this.config = this._getStorage();
  }

  return this._destinationRoot || this.env.cwd;
};

That's exactly the point of the issue #947 .

[ericmorand]

To go further on that point, I didn't want to change the behavior of destinationRoot() regarding this.env.cwd because I'm pretty sure a lot of already available generators are written with that behavior in mind - when destinationRoot() is called, this.env.cwd is changed.

That's why I did add a new property to store the initial value of this.env.cwd.

[SBoudrias]

Thanks for the answer. I missed that line reading through the code yesterday. Sounds good to merge :)

[ericmorand]

I'm not sure about how to update the documentation. Should I create an issueand PR now on yeoman/yeoman.github.io or should I wait for the version that contains that PR to be released?

[mischah]

Hej @ericmorand,

open now and reference yeoman/yeoman.io#700

Thanks for your help

[mischah]

Even better:
Create PR against the branch doc/yeoman-generator/1.0.0 instead of against the default source branch 😘