Add support for scoped package (Fix #272)

__tests__/app.js

@@ -108,6 +108,95 @@ describe('node:app', () => {
     });
   });
 
+  describe('--name', () => {
+    it('allows scopes in names', () => {
+      return helpers
+        .run(require.resolve('../generators/app'))
+        .withOptions({
+          name: '@some-scope/generator-node',
+          githubAccount: 'yeoman'
+        })
+        .then(() => {
+          assert.file('lib/__tests__/someScopeGeneratorNode.test.js');
+
+          assert.file('package.json');
+          assert.jsonFileContent('package.json', {
+            name: '@some-scope/generator-node',
+            repository: 'yeoman/generator-node'
+          });
+
+          assert.file('README.md');
+          assert.fileContent(
+            'README.md',
+            "const someScopeGeneratorNode = require('@some-scope/generator-node');"
+          );
+          assert.fileContent(
+            'README.md',
+            '$ npm install --save @some-scope/generator-node'
+          );
+          assert.fileContent(
+            'README.md',
+            '[travis-image]: https://travis-ci.org/yeoman/generator-node.svg?branch=master'
+          );
+          assert.fileContent(
+            '.git/config',
+            '[remote "origin"]\n	url = git@github.com:yeoman/generator-node.git'
+          );
+        });
+    });
+
+    it('throws when an invalid name is supplied', () => {
+      const promises = [];
+
+      for (let name of ['@/invalid-name', 'invalid@name']) {
+        let threw = false;
+
+        promises.push(
+          helpers
+            .run(require.resolve('../generators/app'))
+            .withOptions({
+              name,
+              githubAccount: 'yeoman'
+            })
+            .catch(() => {
+              threw = true;
+            })
+            .then(() => assert.ok(threw, `Resolved with invalid name ${name}`))
+        );
+      }
+
+      return Promise.all(promises);
+    });
+  });
+
+  describe('--repository-name', () => {
+    it('can be set separately from --name', () => {
+      return helpers
+        .run(require.resolve('../generators/app'))
+        .withOptions({
+          name: 'generator-node',
+          githubAccount: 'yeoman',
+          repositoryName: 'not-generator-node'
+        })
+        .then(() => {
+          assert.file('package.json');
+          assert.jsonFileContent('package.json', {
+            repository: 'yeoman/not-generator-node'
+          });
+
+          assert.file('README.md');
+          assert.fileContent(
+            'README.md',
+            '[travis-image]: https://travis-ci.org/yeoman/not-generator-node.svg?branch=master'
+          );
+          assert.fileContent(
+            '.git/config',
+            '[remote "origin"]\n	url = git@github.com:yeoman/not-generator-node.git'
+          );
+        });
+    });
+  });
+
   describe('--no-travis', () => {
     it('skip .travis.yml', () => {
       return helpers

__tests__/git.js

@@ -7,26 +7,82 @@ describe('node:git', () => {
     return helpers
       .run(require.resolve('../generators/git'))
       .withOptions({
-        repositoryPath: 'yeoman/generator-node'
+        githubAccount: 'yeoman',
+        repositoryName: 'generator-node'
       })
       .then(() => {
         assert.file('.gitignore');
         assert.file('.gitattributes');
         assert.file('.git');
+
+        assert.file('package.json');
+        assert.jsonFileContent('package.json', {
+          repository: 'yeoman/generator-node'
+        });
+
+        assert.fileContent(
+          '.git/config',
+          '[remote "origin"]\n	url = git@github.com:yeoman/generator-node.git'
+        );
       });
   });
 
   it('respects --generate-into option', () => {
     return helpers
       .run(require.resolve('../generators/git'))
       .withOptions({
-        repositoryPath: 'yeoman/generator-node',
+        githubAccount: 'other-account',
+        repositoryName: 'other-name',
         generateInto: 'other/'
       })
       .then(() => {
         assert.file('other/.gitignore');
         assert.file('other/.gitattributes');
         assert.file('other/.git');
+
+        assert.file('other/package.json');
+        assert.jsonFileContent('other/package.json', {
+          repository: 'other-account/other-name'
+        });
+
+        assert.fileContent(
+          'other/.git/config',
+          '[remote "origin"]\n	url = git@github.com:other-account/other-name.git'
+        );
+      });
+  });
+
+  it("doesn't add remote `origin` when `githubAccount` isn't passed", () => {
+    return helpers
+      .run(require.resolve('../generators/git'))
+      .withOptions({
+        repositoryName: 'other-name'
+      })
+      .then(() => {
+        assert.file('.gitignore');
+        assert.file('.gitattributes');
+        assert.file('.git');
+        assert.file('package.json');
+
+        assert.noFileContent('package.json', '"repository"');
+        assert.noFileContent('.git/config', '[remote "origin"]');
+      });
+  });
+
+  it("doesn't add remote `origin` when `repositoryName` isn't passed", () => {
+    return helpers
+      .run(require.resolve('../generators/git'))
+      .withOptions({
+        githubAccount: 'other-account'
+      })
+      .then(() => {
+        assert.file('.gitignore');
+        assert.file('.gitattributes');
+        assert.file('.git');
+        assert.file('package.json');
+
+        assert.noFileContent('package.json', '"repository"');
+        assert.noFileContent('.git/config', '[remote "origin"]');
       });
   });
 });

generators/app/index.js

@@ -7,6 +7,7 @@ const githubUsername = require('github-username');
 const path = require('path');
 const askName = require('inquirer-npm-name');
 const chalk = require('chalk');
+const validatePackageName = require('validate-npm-package-name');
 const pkgJson = require('../../package.json');
 
 module.exports = class extends Generator {
@@ -66,6 +67,12 @@ module.exports = class extends Generator {
       desc: 'GitHub username or organization'
     });
 
+    this.option('repositoryName', {
+      type: String,
+      required: false,
+      desc: 'Name of the GitHub repository'
+    });
+
     this.option('projectRoot', {
       type: String,
       required: false,
@@ -88,9 +95,24 @@ module.exports = class extends Generator {
       name: this.pkg.name,
       description: this.pkg.description,
       version: this.pkg.version,
-      homepage: this.pkg.homepage
+      homepage: this.pkg.homepage,
+      repositoryName: this.options.repositoryName
     };
 
+    if (this.options.name) {
+      const name = this.options.name;
+      const packageNameValidity = validatePackageName(name);
+
+      if (packageNameValidity.validForNewPackages) {
+        this.props.name = name;
+      } else {
+        throw new Error(
+          packageNameValidity.errors[0] ||
+            'The name option is not a valid npm package name.'
+        );
+      }
+    }
+
     if (_.isObject(this.pkg.author)) {
       this.props.authorName = this.pkg.author.name;
       this.props.authorEmail = this.pkg.author.email;
@@ -103,25 +125,51 @@ module.exports = class extends Generator {
     }
   }
 
+  _getModuleNameParts(name) {
+    const moduleName = {
+      name,
+      repositoryName: this.props.repositoryName
+    };
+
+    if (moduleName.name.startsWith('@')) {
+      const nameParts = moduleName.name.slice(1).split('/');
+
+      Object.assign(moduleName, {
+        scopeName: nameParts[0],
+        localName: nameParts[1]
+      });
+    } else {
+      moduleName.localName = moduleName.name;
+    }
+
+    if (!moduleName.repositoryName) {
+      moduleName.repositoryName = moduleName.localName;
+    }
+
+    return moduleName;
+  }
+
   _askForModuleName() {
-    if (this.pkg.name || this.options.name) {
-      this.props.name = this.pkg.name || _.kebabCase(this.options.name);
-      return Promise.resolve();
+    let askedName;
+
+    if (this.props.name) {
+      askedName = Promise.resolve({
+        name: this.props.name
+      });
+    } else {
+      askedName = askName(
+        {
+          name: 'name',
+          default: path.basename(process.cwd())
+        },
+        this
+      );
     }
 
-    return askName(
-      {
-        name: 'name',
-        message: 'Module Name',
-        default: path.basename(process.cwd()),
-        filter: _.kebabCase,
-        validate(str) {
-          return str.length > 0;
-        }
-      },
-      this
-    ).then(answer => {
-      this.props.name = answer.name;
+    return askedName.then(answer => {
+      const moduleNameParts = this._getModuleNameParts(answer.name);
+
+      Object.assign(this.props, moduleNameParts);
     });
   }
 
@@ -184,17 +232,25 @@ module.exports = class extends Generator {
       return Promise.resolve();
     }
 
-    return githubUsername(this.props.authorEmail)
-      .then(username => username, () => '')
-      .then(username => {
-        return this.prompt({
-          name: 'githubAccount',
-          message: 'GitHub username or organization',
-          default: username
-        }).then(prompt => {
-          this.props.githubAccount = prompt.githubAccount;
-        });
+    let usernamePromise;
+    if (this.props.scopeName) {
+      usernamePromise = Promise.resolve(this.props.scopeName);
+    } else {
+      usernamePromise = githubUsername(this.props.authorEmail).then(
+        username => username,
+        () => ''
+      );
+    }
+
+    return usernamePromise.then(username => {
+      return this.prompt({
+        name: 'githubAccount',
+        message: 'GitHub username or organization',
+        default: username
+      }).then(prompt => {
+        this.props.githubAccount = prompt.githubAccount;
       });
+    });
   }
 
   prompting() {
@@ -209,7 +265,7 @@ module.exports = class extends Generator {
 
     const pkg = extend(
       {
-        name: _.kebabCase(this.props.name),
+        name: this.props.name,
         version: '0.0.0',
         description: this.props.description,
         homepage: this.props.homepage,
@@ -260,7 +316,8 @@ module.exports = class extends Generator {
 
     this.composeWith(require.resolve('../git'), {
       name: this.props.name,
-      githubAccount: this.props.githubAccount
+      githubAccount: this.props.githubAccount,
+      repositoryName: this.props.repositoryName
     });
 
     this.composeWith(require.resolve('generator-jest/generators/app'), {
@@ -291,6 +348,7 @@ module.exports = class extends Generator {
         name: this.props.name,
         description: this.props.description,
         githubAccount: this.props.githubAccount,
+        repositoryName: this.props.repositoryName,
         authorName: this.props.authorName,
         authorUrl: this.props.authorUrl,
         coveralls: this.props.includeCoveralls,