generator-iojs/app/index.js

A basic node module template, that includes handy git hooks, a release script, and auto-changelog generation.

var path = require('path')
  , npm = require('npm')
  , npmName = require('npm-name')
  , yeoman = require('yeoman-generator')
  , getUsername = require('username')
  , getFullname = require('fullname')
  , _ = require('lodash')
  , mkdirp = require('mkdirp')
  , updateNotifier = require('update-notifier')
  , pkg = require('../package.json')
  , cwd = process.cwd()

module.exports = yeoman.generators.Base.extend({
  init: function init () {
    var done = this.async()
      , notifier = updateNotifier({pkg: pkg})

    this.pkg = pkg

    this.log(notifier.update)

    this.log(
      'The name of your project shouldn\'t contain "node" or "js" and' +
      '\nshould be a unique ID not already in use at npmjs.org.')

    // init npm
    npm.load(done)
  }

, askForModuleName: function askForModuleName () {
    var done = this.async()
      , prompts

    prompts = [{
      name: 'name'
      , message: 'Module Name'
      , default: path.basename(cwd)
    }
    , {
      type: 'confirm'
      , name: 'pkgName'
      , message: 'The name above already exists on npm, choose another?'
      , default: true
      , when: function when (answers) {
          var whenDone = this.async()

          npmName(answers.name, function gotNPMName (err, available) {
            if (err || !available){
              return void whenDone(true)
            }

            whenDone(false)
          })
        }
    }]

    this.prompt(prompts, function onPrompt (props) {
      if (props.pkgName) return this.askForModuleName()

      this.slugname = _.deburr(props.name).split(' ').join('-')
      this.escapedSlugname = encodeURIComponent(props.name)
      this.safeSlugname = this.slugname.replace(/-+([a-zA-Z0-9])/g, function safedTheSlugName (g) {
        return g[1].toUpperCase()
      }).replace('@', '').replace('/', '-')

      done()
    }.bind(this))
  }

, askFor: function askFor () {
    var done = this.async()
      , fullname = ''
      , prompts

    getFullname(function gotFullname (err, name) {
      if (err) console.info('could not get fullname from system')
      fullname = name

      prompts = [{
        name: 'description'
        , message: 'Description'
        , default: 'The best module ever.'
      }
      , {
        name: 'homepage'
        , message: 'Homepage'
      }
      , {
        name: 'keywords'
        , message: 'Key your keywords (comma to split)'
      }
      , {
        name: 'license'
        , message: 'License'
        , default: 'Artistic-2.0'
        , store: true
        // TODO: present options from https://spdx.org/licenses/
      }
      , {
        name: 'githubUsername'
        , message: 'GitHub username'
        , default: getUsername.sync()
        , store: true
      }
      , {
        name: 'authorName'
        , message: 'Author\'s Name'
        , default: npm.config.get('init.author.name') || fullname
        , store: true
      }
      , {
        name: 'authorEmail'
        , message: 'Author\'s Email'
        , default: npm.config.get('init.author.email')
        , store: true
      }
      , {
        name: 'authorUrl'
        , message: 'Author\'s Homepage'
        , default: npm.config.get('init.author.site')
        , store: true
      }
      , {
        name: 'isEs6'
        , message: 'Will you use ES6 or JSX?'
        , type: 'confirm'
        , default: true
      }
      , {
        name: 'isServer'
        , message: 'Is this a node module? (Will it run on the server)'
        , type: 'confirm'
        , default: true
      }
      , {
        name: 'isBrowser'
        , message: 'Will this run in the browser?'
        , type: 'confirm'
        , default: true
      }
      , {
        name: 'isCLI'
        , message: 'Will have a CLI API?'
        , type: 'confirm'
        , default: false
      }
      , {
        name: 'extension'
        , message: 'Default extension?'
        , default: '.js'
      }
      , {
        name: 'isPrivate'
        , message: 'Is this a private module?'
        , store: true
        , type: 'confirm'
        , default: true
      }]

      this.currentYear = (new Date()).getFullYear()

      this.prompt(prompts, function onPrompt (props) {
        this.repoName = this.slugname.split('/').filter(function removeName (part, i) {
          if (i === 0 && part.toLowerCase() === '@' + props.githubUsername.toLowerCase()) return false
          else return true
        }).join('-')

        if (props.githubUsername){
          this.repoUrl = props.githubUsername + '/' + this.repoName.replace('@', '')
        }
        else {
          this.repoUrl = 'user/repo'
        }

        this.keywords = props.keywords.split(',')
          .map(function trimKeywords (el) {
            return el.trim()
          })
          .filter(Boolean)
          .sort()

        this.publicness = props.isPrivate ? 'restricted' : 'public'

        props.extension = props.extension.trim()
        if (props.extension.indexOf('.') !== 0) {
          props.extension = '.' + props.extension
        }

        props.isServerAndBrowser = (props.isServer || props.isCLI) && props.isBrowser
        props.isJSX = /jsx$/.test(props.extension)

        this.props = props

        done()
      }.bind(this))
    }.bind(this))
  }

, app: function app () {
    this.config.save()
    this.copy('editorconfig', '.editorconfig')
    this.copy('gitignore', '.gitignore')
    this.copy('eslintignore', '.eslintignore')
    this.copy('npmrc', '.npmrc')
    this.copy('scripts.sh', 'scripts.sh')

    if (this.props.isEs6) {
      this.copy('babelrc', '.babelrc')
    }

    this.template('travis.yml', '.travis.yml')
    this.template('eslintrc', '.eslintrc')
    this.template('npmignore', '.npmignore')
    this.template('README.md', 'README.md')
    this.template('_package.json', 'package.json')
    this.template('CONTRIBUTING.md', '.github/CONTRIBUTING.md')
    this.template('ISSUE_TEMPLATE.md', '.github/ISSUE_TEMPLATE.md')
    this.template('PULL_REQUEST_TEMPLATE.md', '.github/PULL_REQUEST_TEMPLATE.md')
    this.template('CHANGELOG.md', 'CHANGELOG.md')
    this.template('LICENSE', 'LICENSE')
  }

, projectfiles: function projectfiles () {
    this.template('index.js', 'index' + this.props.extension)
    mkdirp(path.join(cwd, 'test'))
    this.template('test/test.js', 'test/test' + this.props.extension)
    if (this.props.isCLI) {
      mkdirp(path.join(cwd, 'bin'))
      this.template('bin/cli', 'bin/' + this.repoName)
    }
  }

, install: function install () {
    this.installDependencies({
      bower: false
      , skipInstall: this.options['skip-install']
    })
  }
})