1.1.5

Author: ungoldman

CHANGELOG.md

@@ -3,8 +3,14 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 This change log adheres to [keepachangelog.com](http://keepachangelog.com).
 
+## [1.1.5] - 2015-04-02
+* more improvements to CLI style & formatting
+* bump `changelog-parser` to 2.x
+* bump `standard` to 3.x
+* readme updates
+
 ## [1.1.4] - 2015-04-01
-* Improve preview style & formatting ([#15](https://github.com/ngoldman/gh-release/issues/15) & [#24](https://github.com/ngoldman/gh-release/pull/24))
+* improve preview style & formatting ([#15](https://github.com/ngoldman/gh-release/issues/15) & [#24](https://github.com/ngoldman/gh-release/pull/24))
 
 ## [1.1.3] - 2015-03-22
 * Handle error when release number already exists on github
@@ -63,7 +69,8 @@ This change log adheres to [keepachangelog.com](http://keepachangelog.com).
 * define basic node interface
 * define basic cli interface
 
-[1.1.3]: https://github.com/ngoldman/gh-release/compare/v1.1.3...v1.1.4
+[1.1.5]: https://github.com/ngoldman/gh-release/compare/v1.1.4...v1.1.5
+[1.1.4]: https://github.com/ngoldman/gh-release/compare/v1.1.3...v1.1.4
 [1.1.3]: https://github.com/ngoldman/gh-release/compare/v1.1.2...v1.1.3
 [1.1.2]: https://github.com/ngoldman/gh-release/compare/v1.1.1...v1.1.2
 [1.1.1]: https://github.com/ngoldman/gh-release/compare/v1.1.0...v1.1.1

README.md

@@ -10,12 +10,17 @@ Uses the [Github Releases API](https://developer.github.com/v3/repos/releases/)
 
 ![gh-release example](demo.gif)
 
-## Usage
+## Command-line interface
 
-### CLI
+### Install
+
+```
+$ npm install gh-release -g
+```
+
+### Usage
 
 ```
-$ npm install -g gh-release
 $ gh-release --help
 Usage: gh-release [options]
 
@@ -37,19 +42,18 @@ $ gh-release
 Your GitHub username: ngoldman
 Your GitHub password: ✔✔✔✔✔✔✔✔
 
+creating release v1.1.2 for ngoldman/gh-release
+
+name:             v1.1.2
 tag_name:         v1.1.2
 target_commitish: ffed090688fb1b853aa07a546ac2e3965a02bb1d
-name:             v1.1.2
-body:             * add `dry-run` and `workpath` options
-                  * improve change log
-owner:            ngoldman
-repo:             gh-release
 draft:            false
 prerelease:       false
+body:             * add `dry-run` and `workpath` options
+                  * improve change log
 dryRun:           false
-workpath:         /Users/ng/dev/github/gh-release
 
-? does this look right? (y/N) y
+? publish release to github? (y/N) y
 https://github.com/ngoldman/gh-release/releases/tag/v1.1.2
 ```
 
@@ -61,12 +65,16 @@ Prints release URL to terminal on success.
 
 Saves github API token to `$HOME/.config/gh-release.json` after first authentication.
 
-### Node
+## Node
+
+### Install
 
 ```
 $ npm install gh-release --save-dev
 ```
 
+### Usage
+
 ```js
 var ghRelease = require('gh-release')
 
@@ -116,7 +124,7 @@ All default values taken from `package.json` unless specified otherwise.
 | `draft` | publish as draft | false |
 | `prerelease` | publish as prerelease | false |
 
-Override defaults with flags ([cli](#cli)) or the `options` object ([node](#node)).
+Override defaults with flags (CLI) or the `options` object (node).
 
 ## Standards
 
@@ -129,7 +137,7 @@ All [releases](https://github.com/ngoldman/gh-release/releases) of `gh-release`
 
 ## Motivation
 
-There are packages that already do something like this, and they're great, but I want something that does this one thing really well and nothing else, leans heavily on standards in `package.json` and `CHANGELOG.md`, and can work both as a cli tool and programmatically in node.
+There are packages that already do something like this, and they're great, but I want something that does this one thing really well and nothing else, leans heavily on standards in `package.json` and `CHANGELOG.md`, and can work both as a CLI tool and programmatically in node.
 
 ## Contributing
 

bin/cli.js

@@ -104,8 +104,7 @@ function handleDefaults (err, defaults) {
   var options = extend(defaults, argv)
 
   Object.keys(options).forEach(function (key) {
-    if (whitelist.indexOf(key) === -1)
-      delete options[key]
+    if (whitelist.indexOf(key) === -1) delete options[key]
   })
 
   ghRelease(options, auth, handleRelease)

index.js

@@ -1,3 +1,5 @@
+module.exports = ghRelease
+
 var getDefaults = require(__dirname + '/lib/get-defaults')
 var extend = require('util')._extend
 var GHAPI = require('github')
@@ -6,16 +8,15 @@ var wrap = require('word-wrap')
 var size = require('window-size')
 var client = new GHAPI({
   version: '3.0.0',
-  headers: {
-    'user-agent': 'gh-release'
-  }
+  headers: { 'user-agent': 'gh-release' }
 })
 var inquirer = require('inquirer')
+var columnWidth = 18
 var questions = [
   {
     type: 'confirm',
     name: 'confirm',
-    message: 'does this look right?',
+    message: 'publish release to github?',
     default: false,
     validate: function (input) {
       if (!input) return false
@@ -24,81 +25,41 @@ var questions = [
   }
 ]
 
-function justify (word) {
-  var justifiedWord = word + ':'
-  while (justifiedWord.length < 18) {
-    justifiedWord += ' '
-  }
-  return justifiedWord
-}
-
-function indentBody (body) {
-  var lines = wrap(body, {
-    indent: '',
-    width: size.width - 18
-  })
-  .split('\n')
-  .filter(function (line) {
-    return line !== ''
-  })
-  return lines.map(function (line, i) {
-    if (i === 0) {
-      return {column1: justify('body'), column2: line}
-    } else {
-      return {column1: '                  ', column2: line}
-    }
-  })
-}
+function ghRelease (options, auth, callback) {
+  var hasToken = auth && auth.token
+  var hasUser = auth && auth.username
+  var hasPass = auth && auth.password
+  var hasBasic = hasUser && hasPass
+  var authOptions
 
-function formatOptions (options) {
-  var prettyOptions = []
-  var keys = Object.keys(options)
-  keys.forEach(function (key) {
-    var column1 = justify(key)
-    if (key === 'body') {
-      var body = indentBody(options.body)
-      prettyOptions.push.apply(prettyOptions, body)
-    } else {
-      prettyOptions.push({column1: column1, column2: options[key]})
-    }
-  })
-  return prettyOptions
-}
+  if (!hasToken && !hasBasic) return callback(new Error('missing auth info'))
 
-function ghRelease (options, auth, callback) {
-  if (auth && auth.token) {
-    client.authenticate({
+  if (hasToken) {
+    authOptions = {
       type: 'oauth',
       token: auth.token
-    })
-  } else if (auth && auth.username && auth.password) {
-    client.authenticate({
+    }
+  } else {
+    authOptions = {
       type: 'basic',
       username: auth.username,
       password: auth.password
-    })
-  } else {
-    return callback(new Error('missing auth info'))
+    }
   }
 
+  client.authenticate(authOptions)
+
   getDefaults(options.workpath, function (err, defaults) {
     if (err) return callback(err)
 
     var releaseOptions = extend(defaults, options || {})
-    var prettyOptions = formatOptions(releaseOptions)
 
-    prettyOptions.forEach(function (option) {
-      console.log(chalk.blue(option.column1) + chalk.green(option.column2))
-    })
-    console.log('')
+    showPreview(releaseOptions)
 
     if (options.dryRun) process.exit(0)
 
     inquirer.prompt(questions, function (answers) {
-      if (!answers.confirm) {
-        console.log('release canceled')
-        process.exit(0)
-      }
+      if (!answers.confirm) return process.exit(0)
 
       var checkCommitForm = {
         user: releaseOptions.owner,
@@ -111,26 +72,88 @@ function ghRelease (options, auth, callback) {
           console.log('Couldn\'t find the target commit on GitHub.')
           console.log('Make sure you\'ve pushed everything up to ' + releaseOptions.owner + '/' + releaseOptions.repo + ' and try again')
           console.log('Target commit: ' + releaseOptions.target_commitish)
-          process.exit(1)
-        } else {
-          client.releases.createRelease(releaseOptions, function (err, res) {
-            if (err) {
-              var message = JSON.parse(err.message)
-              var tagExists = (message.errors[0].code === 'already_exists')
-              if (err.code === 422 && tagExists) {
-                console.log('A release already exists for the tag ' + releaseOptions.tag_name)
-                console.log('Try bumping the version in your package.json.\nThen push to ' + releaseOptions.owner + '/' + releaseOptions.repo + ' and try again.')
-              } else {
-                console.error(err)
-              }
-              process.exit(1)
-            }
-            callback(null, res)
-          })
+          return process.exit(1)
         }
+
+        client.releases.createRelease(releaseOptions, function (err, res) {
+          if (err) {
+            var message = JSON.parse(err.message)
+            var tagExists = (message.errors[0].code === 'already_exists')
+            if (err.code === 422 && tagExists) {
+              console.log('A release already exists for the tag ' + releaseOptions.tag_name)
+              console.log('Try bumping the version in your package.json.\nThen push to ' + releaseOptions.owner + '/' + releaseOptions.repo + ' and try again.')
+            } else {
+              console.error(err)
+            }
+            return process.exit(1)
+          }
+
+          callback(null, res)
+        })
       })
     })
   })
 }
 
-module.exports = ghRelease
+function showPreview (opts) {
+  var intro = '\ncreating release ' + chalk.bold(opts.tag_name) +
+    ' for ' + chalk.bold(opts.owner + '/' + opts.repo) + '\n'
+  var prettyOptions = formatOptions(opts)
+
+  console.log(intro)
+
+  prettyOptions.forEach(function (option) {
+    console.log(chalk.cyan(option.column1) + option.column2)
+  })
+
+  console.log('')
+}
+
+function formatOptions (options) {
+  var opts = extend({}, options)
+
+  delete opts.owner
+  delete opts.repo
+  delete opts.dryRun
+  delete opts.workpath
+
+  var prettyOptions = []
+  var keys = Object.keys(opts)
+
+  keys.forEach(function (key) {
+    var column1 = justify(key)
+    if (key === 'body') {
+      var body = indentBody(opts.body)
+      prettyOptions.push.apply(prettyOptions, body)
+    } else {
+      prettyOptions.push({column1: column1, column2: opts[key]})
+    }
+  })
+
+  return prettyOptions
+}
+
+function indentBody (body) {
+  var lines = wrap(body, {
+      indent: '',
+      width: size.width - columnWidth
+    })
+    .split('\n')
+    .filter(function (line) {
+      return line !== ''
+    })
+
+  return lines.map(function (line, i) {
+    if (i === 0) {
+      return { column1: justify('body'), column2: line }
+    } else {
+      return { column1: new Array(columnWidth).join(' '), column2: line }
+    }
+  })
+}
+
+function justify (word) {
+  var justifiedWord = word + ':'
+  while (justifiedWord.length < columnWidth) justifiedWord += ' '
+  return justifiedWord
+}

lib/get-defaults.js

@@ -28,16 +28,16 @@ module.exports = function getDefaults (workPath, callback) {
     var version = pkg.version ? 'v' + pkg.version : null
 
     callback(null, {
-      tag_name: version,
-      target_commitish: commit,
-      name: version,
-      body: log.body,
       owner: owner,
       repo: repo,
-      draft: false,
-      prerelease: false,
       dryRun: false,
-      workpath: process.cwd()
+      workpath: process.cwd(),
+      body: log.body,
+      prerelease: false,
+      draft: false,
+      target_commitish: commit,
+      tag_name: version,
+      name: version
     })
   })
 }