generator-mnm 0.5.1 → 0.6.1

package/README.md

@@ -2,7 +2,7 @@
 <img src="https://cloud.githubusercontent.com/assets/1616682/11403449/409e561e-9373-11e5-9aeb-7dbea090a0bd.gif" width="400px" />
 
 <p>
-Create node modules writing ES6 today compiled with Babel, tested with ava and linted with standard on top of npm scripts
+Create node modules writing ES6/ES7 today compiled with Babel, tested with ava, bundled with rollup and linted with standard on top of npm scripts
 </p>
 
 <p>
@@ -37,7 +37,7 @@ Options:
         --skip-cache    # Do not remember prompt answers             Default: false
         --skip-install  # Do not automatically install dependencies  Default: false
   -a,   --all           # Ask all questions                          Default: false
-  -y,   --yes           # Skip some questions, like $ npm init -y     Default: false
+  -y,   --yes           # Skip some questions, like $ npm init -y    Default: false
 
 Arguments:
   name  # module name
@@ -63,17 +63,18 @@ $ yo mnm -y
    create test/index.js
    create .travis.yml
    create .babelrc
+   create rollup.config.js
 ```
 
 ## Features
 
 - Made out of many other generators, the main generator only creates a [`package.json` file](https://github.com/maurizzzio/generator-mnm/blob/master/generators/app/index.js#L225-L240) and a [minimal `.gitignore` file](https://github.com/maurizzzio/generator-mnm/blob/master/generators/app/index.js#L246-L248)
-- Composable, since the logic to create the README, cli and other files is in its own subgenerator you just have to plug as many subgenerators as you need to your own generator
-- [Babel](https://babeljs.io) for the code/tests
+- Composable, since the logic to create the README, cli and other files is on their own subgenerator
+- [Babel](https://babeljs.io) transpiles the code/tests
 - [standard](http://standardjs.com/) to lint the code
 - [ava](https://github.com/sindresorhus/ava) for testing
 - [yargs](https://github.com/bcoe/yargs) to parse cli arguments (optional)
-- [jsnext:main](https://github.com/rollup/rollup/wiki/jsnext:main) field included if you want to bundle your library using a ES6 module bundler like [Rollup](https://github.com/rollup/rollup)
+- [rollup](https://github.com/rollup/rollup) to create a common js compatible bundle
 - npm scripts as the build system
 
 ## Example
@@ -87,7 +88,7 @@ Common tasks
 | task       | description  |
 | -----      | ---          |
 | `npm test` | `ava` |
-| `npm run build` | `babel src/ -output-file dist/index.js`| 
+| `npm run build` | `rollup --config`| 
 | `npm run lint` | `standard` |
 | `npm run clean` | Removes all the files inside `dist/`|
 
@@ -132,11 +133,11 @@ This project is heavily inspired by [this article by Keith Cirkel][stop-using-gr
 - https://github.com/iamstarkov/generator-zen
 - https://github.com/keithamus/npm-scripts-example 's awesome `package.json` file
 
-I'd like to thank [iamstarkov](https://github.com/iamstarkov) for his awesome composable generators
+I'd like to thank [iamstarkov](https://github.com/iamstarkov) for his awesome work on generators that are actually composable
 
 ## Composability
 
-Just plug in any of the subgenerators or the generator itself on your generator
+Just plug in any of the subgenerators or the `app` generator itself on your generator
 
 <div align="center">
 <img src="https://camo.githubusercontent.com/f8dc3e07d956f1f8dbdea5f895800fe53772a50d/687474703a2f2f692e696d6775722e636f6d2f326771696966742e6a7067">
@@ -145,7 +146,6 @@ Just plug in any of the subgenerators or the generator itself on your generator
 Generators used in this project
 
 - [generator-babel](https://github.com/iamstarkov/generator-babel)
-- [generator-travis](https://github.com/iamstarkov/generator-travis)
 - [generator-git-init](https://github.com/iamstarkov/generator-git-init)
 - [generator-license](https://github.com/jozefizso/generator-license)
 - [generator-mnm/generators/src](./generators/src)
@@ -153,17 +153,15 @@ Generators used in this project
 - [generator-mnm/generators/cli](./generators/cli)
 - [generator-mnm/generators/readme](./generators/readme)
 
-Refer to their README files on how to include it your generators
-
 ## Workflow
 
 ```sh
 # equivalent to npm init -y
 yo mnm -y
 # see https://www.npmjs.com/package/ghrepo
-ghrepo -m "._."
+ghrepo -m "initial commit"
 # see https://www.npmjs.com/package/travisjs
-travisjs hook
+travisjs hook # or travis enable with the travis gem
 
 # if a cli is needed
 yo mnm:cli
@@ -171,7 +169,8 @@ yo mnm:cli
 
 ## Development
 
-- `npm test`, `npm test:ci` run the tests
+- `npm test`
+- `npm test:ci` run the tests (open `./test/ci/.tmp` to see a generated)
 
 ## License
 

package/generators/app/index.js

@@ -232,11 +232,13 @@ module.exports = Base.extend({
           email: this.props.email,
           url: this.props.website
         },
-        main: this.props.dist + 'index.js',
-        'jsnext:main': this.props.src + 'index.js',
+        main: this.props.dist + this.props.moduleName + '.js',
+        module: this.props.dist + this.props.moduleName + '.mjs',
+        'jsnext:main': this.props.dist + this.props.moduleName + '.mjs',
         keywords: this.props.moduleKeywords,
         repository: this.props.githubUsername + '/' + this.props.moduleName,
-        scripts: {}
+        scripts: {},
+        dependencies: {}
       }
 
       // Let's extend package.json so we're not overwriting user previous fields
@@ -249,8 +251,6 @@ module.exports = Base.extend({
   },
 
   default: function () {
-    // TODO: compose with mnm:rollup
-
     // git init
     this.composeWith('git-init', {}, {
       local: require.resolve('generator-git-init/generators/app')
@@ -267,10 +267,10 @@ module.exports = Base.extend({
 
     this.composeWith('mnm:test', {
       options: {
-        'skip-install': this.options['skip-install'],
         src: this.props.src,
         test: this.props.test,
-        coverage: this.props.coverage
+        coverage: this.props.coverage,
+        'skip-install': this.options['skip-install']
       }
     }, { local: require.resolve('../test') })
 

package/generators/base.js

@@ -2,6 +2,7 @@ var yeoman = require('yeoman-generator')
 var extend = require('extend')
 var sortedObject = require('sorted-object')
 var depsObject = require('deps-object')
+var yaml = require('yamljs')
 
 module.exports = yeoman.Base.extend({
   _saveDepsToPkg: function (deps) {
@@ -21,6 +22,22 @@ module.exports = yeoman.Base.extend({
       .catch(function (err) { throw err })
   },
 
+  _travis: function (additional) {
+    var travisPath = this.destinationPath('.travis.yml')
+    var existing = this.fs.exists(travisPath)
+            ? yaml.parse(this.fs.read(travisPath))
+            : {}
+    var result = Object.assign({
+      language: 'node_js',
+      node_js: ['stable']
+    }, existing, additional)
+
+    this.fs.write(
+      this.destinationPath('.travis.yml'),
+      yaml.stringify(result, 3, 2)
+    )
+  },
+
   _gitignore: function (ignores) {
     var giPath = this.destinationPath('.gitignore')
     var file = this.fs.read(giPath, { defaults: '' })

package/generators/cli/index.js

@@ -27,7 +27,7 @@ module.exports = Base.extend({
       type: String,
       required: false,
       defaults: 'dist/index.js',
-      desc: 'The location of the project\'s source file'
+      desc: "The location of the project's source file"
     })
   },
 

package/generators/src/index.js

@@ -1,5 +1,6 @@
 'use strict'
 var path = require('path')
+var toCase = require('to-case')
 
 var Base = require('../base')
 
@@ -29,14 +30,13 @@ module.exports = Base.extend({
       }
 
       var pkg = this.fs.readJSON(this.destinationPath('package.json'), {})
-      var distPath = path.join(this.options.dist, 'index.js')
-      var srcPath = path.join(this.options.src, 'index.js')
-      var buildScript = 'babel ' + srcPath + ' --out-file ' + distPath
+
       var scripts = pkg.scripts || {}
       setTask('clean', 'rimraf ' + this.options.dist + ' && mkdirp ' + this.options.dist)
       setTask('lint', 'standard')
+      setTask('changelog', 'conventional-changelog -p eslint -i CHANGELOG.md -s -r 0')
       setTask('prebuild', 'npm run clean -s && npm run lint -s')
-      setTask('build', buildScript)
+      setTask('build', 'rollup --config')
       setTask('build:watch', 'npm run build -- --watch')
       // instead of runnning this on prepublish which doesn't work as expecte on
       // npm@3 run it on preversion, this is because it's highly unlikely to do
@@ -64,17 +64,31 @@ module.exports = Base.extend({
     },
 
     pkgDeps: function () {
-      return this._saveDeps(['rimraf', 'mkdirp', 'standard'])
+      return this._saveDeps([
+        'rimraf', 'mkdirp', 'standard', 'conventional-changelog',
+        'rollup', 'rollup-plugin-babel', 'rollup-watch', 'babelrc-rollup'
+      ])
     },
 
     templates: function () {
+      var pkg = this.fs.readJSON(this.destinationPath('package.json'), {})
       var srcPath = path.join(this.options.src, 'index.js')
 
-      // copy template to this.options.src
+      // copy index.tpl as srcPath
+      // e.g. src/index.js
       this.fs.copyTpl(
         this.templatePath('index.tpl'),
         this.destinationPath(srcPath), {}
       )
+
+      // copy rollup.config.tpl to rollup.config.js
+      this.fs.copyTpl(
+        this.templatePath('rollup.config.tpl'),
+        this.destinationPath('rollup.config.js'), {
+          srcPath: srcPath,
+          moduleName: toCase.camel(pkg.name || this.appname)
+        }
+      )
     },
 
     gitignore: function () {
@@ -83,21 +97,16 @@ module.exports = Base.extend({
   },
 
   default: function () {
-    this.composeWith('travis', {
-      options: {
-        'skip-install': this.options['skip-install'],
-        config: {
-          script: 'npm run build'
-        }
-      }
-    }, { local: require.resolve('generator-travis/generators/app') })
+    // using my own .travis generator because the other one force defaults
+    this._travis({
+      script: 'npm run build'
+    })
 
     this.composeWith('babel', {
       options: {
         'skip-install': this.options['skip-install'],
         config: {
-          plugins: ['add-module-exports'],
-          sourceMaps: true
+          plugins: ['external-helpers']
         }
       }
     }, { local: require.resolve('generator-babel/generators/app') })

package/generators/src/templates/rollup.config.tpl

@@ -0,0 +1,19 @@
+import babel from 'rollup-plugin-babel'
+import babelrc from 'babelrc-rollup'
+
+let pkg = require('./package.json')
+let external = Object.keys(pkg.dependencies)
+
+export default {
+  entry: '<%= srcPath %>',
+  plugins: [ babel(babelrc()) ],
+  external: external,
+  targets: [{
+    dest: pkg['main'],
+    format: 'cjs'
+  }, {
+    dest: pkg['jsnext:main'],
+    format: 'es'
+  }]
+}
+

package/generators/test/index.js

@@ -85,14 +85,10 @@ module.exports = Base.extend({
 
   default: function () {
     if (this.options.coverage) {
-      this.composeWith('travis', {
-        options: {
-          config: {
-            before_install: 'npm install codecov && npm install nyc',
-            after_success: 'npm run coverage'
-          }
-        }
-      }, { local: require.resolve('generator-travis/generators/app') })
+      this._travis({
+        before_install: 'npm install codecov && npm install nyc',
+        after_success: 'npm run coverage'
+      })
     }
   },
 

package/package.json

@@ -1,15 +1,11 @@
 {
   "name": "generator-mnm",
-  "version": "0.5.1",
+  "version": "0.6.1",
   "description": "Create node modules writing ES6 today compiled with Babel, tested with ava and linted with standard on top of npm scripts Create node modules with es6, test with tape on top of npm scripts",
   "license": "MIT",
   "main": "index.js",
-  "repository": "maurizzzio/generator-mnm",
-  "author": {
-    "name": "Mauricio Poppe",
-    "email": "mauricio.poppe@gmail.com",
-    "url": "https://github.com/maurizzzio"
-  },
+  "repository": "mauriciopoppe/generator-mnm",
+  "author": "Mauricio Poppe (https://mauriciopoppe.com)",
   "engines": {
     "node": ">=4"
   },
@@ -44,7 +40,6 @@
     "generator-babel": "^2.0.2",
     "generator-git-init": "^1.0.4",
     "generator-license": "^3.1.1",
-    "generator-travis": "^1.2.2",
     "github-username": "^2.1.0",
     "is-url": "^1.2.1",
     "mkdirp": "^0.5.1",
@@ -53,6 +48,7 @@
     "relative": "^3.0.2",
     "sorted-object": "^2.0.0",
     "to-case": "^2.0.0",
+    "yamljs": "^0.2.8",
     "yeoman-generator": "^0.22.6"
   },
   "devDependencies": {