feat(code): bin and api

Author: bahmutov

README.md

@@ -18,6 +18,43 @@ npm install --save make-empty-github-commit
 
 ## Use
 
+### CLI
+
+From command line
+
+```
+$(npm bin)/empty-commit --repo <username/repo> --message "Empty commit message"
+```
+
+You can pass repo in different format, it will be parsed using
+[parse-github-repo-url](https://github.com/repo-utils/parse-github-repo-url).
+
+Optional arguments:
+
+```
+--branch <master> 
+```
+
+Aliases: `--repo -r`, `--message -m`, `--branch -b`
+
+### API
+
+```js
+const emptyGitHubCommit = require('make-empty-github-commit')
+emptyGitHubCommit({
+  owner: 'username',
+  repo: 'repo name',
+  token: process.env.TOKEN,
+  fullyQualifiedRef: 'heads/develop'
+}).then(console.log, e => {
+  console.error(e)
+  process.exit(1)
+})
+```
+
+Uses [http://mikedeboer.github.io/node-github](http://mikedeboer.github.io/node-github)
+to make API calls.
+
 ### Debugging
 
 Run the tool with environment variable `DEBUG=make-empty-github-commit`

bin/empty.js

@@ -1,35 +1,47 @@
 #!/usr/bin/env node
 
-const parse = require('parse-github-repo-url')
-const emptyGitHubCommit = require('..')
-
 const token = process.env.TOKEN || process.env.GITHUB_TOKEN
 if (!token) {
   console.error('Cannot find TOKEN or GITHUB_TOKEN')
   process.exit(1)
 }
-const repoWhat = process.argv[2]
-const message = process.argv[3]
-if (!repoWhat || !message) {
-  repoWhat.log('usage: empty-commit <repo url> <commit message>')
+
+const parse = require('parse-github-repo-url')
+const options = require('minimist')(process.argv, {
+  alias: {
+    repo: 'r',
+    message: 'm',
+    branch: 'b'
+  },
+  default: {
+    branch: 'master'
+  }
+})
+const emptyGitHubCommit = require('..')
+
+if (!options.repo || !options.message) {
+  console.log('usage: empty-commit --repo <github repo> --message <commit message>')
+  console.log('optional args')
+  console.log('  --branch <master>')
   process.exit(1)
 }
-console.log('Making empty commit in', repoWhat)
-console.log('message:', message)
+console.log('Making empty commit in', options.repo)
+console.log('message:', options.message)
+console.log('branch:', options.branch)
 
-const parsed = parse(repoWhat)
+const parsed = parse(options.repo)
 const user = parsed[0]
 const repo = parsed[1]
 if (!user || !repo) {
-  console.error('Could not parse repo', repoWhat)
+  console.error('Could not parse GitHub repo', options.repo)
   process.exit(1)
 }
 
 emptyGitHubCommit({
   owner: user,
   repo: repo,
-  token: process.env.TOKEN,
-  fullyQualifiedRef: 'heads/master'
+  token: token,
+  fullyQualifiedRef: `heads/${options.branch}`
 }).then(console.log, e => {
   console.error(e)
   process.exit(1)

package.json

@@ -89,6 +89,7 @@
   "dependencies": {
     "debug": "3.1.0",
     "github": "11.0.0",
+    "minimist": "1.2.0",
     "parse-github-repo-url": "1.4.1"
   }
 }