feat: pass commit to json, close #15

Author: bahmutov

README.md

@@ -124,9 +124,16 @@ the commit message using provided function
 ```js
 const {getInstallJson} = require('commit-message-install')
 // package(s), env, platform, branch name (optional)
-const json = getInstallJson('foo', {foo: 42}, 'linux', 'test-branch')
+const json = getInstallJson('foo',
+    {foo: 42}, 'linux', 'test-branch', 'b7ccfd8')
 // returns an object
-// {platform: "linux", env: {foo: 42}, packages: "foo", branch: "test-branch"}
+    // {
+    //   platform: "linux",
+    //   env: {foo: 42},
+    //   packages: "foo",
+    //   branch: "test-branch",
+    //   commit: "b7ccfd8"
+    // }
 ```
 
 You can pass individual package name like `debug` or several as a single string

__snapshots__/get-install-json-spec.js

@@ -26,3 +26,10 @@ exports['getInstallJson sets branch 1'] = {
   "packages": "debug chalk",
   "branch": "test-branch"
 }
+
+exports['getInstallJson sets commit 1'] = {
+  "platform": "linux",
+  "env": {},
+  "packages": "debug chalk",
+  "commit": "b7ccfd8"
+}

src/get-install-json-spec.js

@@ -27,4 +27,8 @@ describe('getInstallJson', () => {
   it('sets branch', () => {
     snapshot(getInstallJson(['debug', 'chalk'], {}, 'linux', 'test-branch'))
   })
+
+  it('sets commit', () => {
+    snapshot(getInstallJson(['debug', 'chalk'], {}, 'linux', null, 'b7ccfd8'))
+  })
 })

src/get-install-json.js

@@ -5,7 +5,7 @@ const debug = require('debug')('commit-message-install')
 const { isNpmInstall } = require('./utils')
 
 // forms JSON object that can be parsed later
-function getInstallJson (packages, env, platform, branch) {
+function getInstallJson (packages, env, platform, branch, commit) {
   if (!env) {
     env = {}
   }
@@ -33,6 +33,14 @@ function getInstallJson (packages, env, platform, branch) {
     debug('branch name', branch)
     json.branch = branch
   }
+  if (commit) {
+    la(
+      is.commitId(commit) || is.shortCommitId(commit),
+      'invalid commit',
+      commit
+    )
+    json.commit = commit
+  }
 
   la(
     isNpmInstall(json),