feat: use options object to pass json

BREAKING CHANGE change from ordered arguments to `getInstallJson` to
a single options object

```js
const json = {
  packages: 'debug',
  env: { foo: 42 },
  platform: 'linux'
}
getInstallJson(json)
```

Author: bahmutov

README.md

@@ -43,15 +43,15 @@ The install will happen on all platforms
     ```json
     {
         "platform": "*",
+        "architecture": "x64",
         "packages": "debug,chalk"
     }
     ```
 
 Happy installation
 ```
 
-**note** `platform` can be `*` or specific one like `darwin` (from Node `os.platform()`) or a
-list of several platforms like `darwin,linux`
+**note** `platform` can be `*` or specific one like `darwin` (from Node `os.platform()`) or a list of several platforms like `darwin,linux`. `architecture` is usually 64 bit `x64` as returned by `os.arch()`.
 
 ### Specific commit
 

src/commit-message-install-spec.js

@@ -70,7 +70,13 @@ describe('commit-message-install', () => {
         repo: 'bar',
         sha: '2d8687c143165218c6b52a76018b76cf99137e48'
       }
-      const info = getInstallJson(['debug', 'chalk'], {}, 'linux', null, null, status)
+      const options = {
+        packages: ['debug', 'chalk'],
+        env: {},
+        platform: 'linux',
+        status
+      }
+      const info = getInstallJson(options)
       const json = toMarkdownJsonBlock(info)
       const message = `some text\n\n` + json
 

src/get-install-json-spec.js

@@ -13,23 +13,47 @@ describe('getInstallJson', () => {
   })
 
   it('sets properties and all platforms', () => {
-    snapshot(getInstallJson('debug', { foo: 42 }, '*'))
+    const json = { packages: 'debug', env: { foo: 42 }, platform: '*' }
+    snapshot(getInstallJson(json))
   })
 
   it('sets given platform', () => {
-    snapshot(getInstallJson('debug', { foo: 42 }, 'linux'))
+    const json = {
+      packages: 'debug',
+      env: { foo: 42 },
+      platform: 'linux'
+    }
+    snapshot(getInstallJson(json))
   })
 
   it('sets several modules', () => {
-    snapshot(getInstallJson(['debug', 'chalk'], {}, 'linux'))
+    const json = {
+      packages: ['debug', 'chalk'],
+      env: {},
+      platform: 'linux'
+    }
+    snapshot(getInstallJson(json))
   })
 
   it('sets branch', () => {
-    snapshot(getInstallJson(['debug', 'chalk'], {}, 'linux', 'test-branch'))
+    const json = {
+      packages: ['debug', 'chalk'],
+      env: {},
+      platform: 'linux',
+      branch: 'test-branch'
+    }
+    snapshot(getInstallJson(json))
   })
 
   it('sets commit', () => {
-    snapshot(getInstallJson(['debug', 'chalk'], {}, 'linux', null, 'b7ccfd8'))
+    const json = {
+      packages: ['debug', 'chalk'],
+      env: {},
+      platform: 'linux',
+      branch: null,
+      commit: 'b7ccfd8'
+    }
+    snapshot(getInstallJson(json))
   })
 
   it('sets status object', () => {
@@ -38,6 +62,12 @@ describe('getInstallJson', () => {
       repo: 'bar',
       sha: '2d8687c143165218c6b52a76018b76cf99137e48'
     }
-    snapshot(getInstallJson(['debug', 'chalk'], {}, 'linux', null, null, status))
+    const json = {
+      packages: ['debug', 'chalk'],
+      env: {},
+      platform: 'linux',
+      status
+    }
+    snapshot(getInstallJson(json))
   })
 })

src/get-install-json.js

@@ -11,13 +11,25 @@ const isStatus = is.schema({
 })
 
 // forms JSON object that can be parsed later
-function getInstallJson (packages, env, platform, branch, commit, status) {
+function getInstallJson ({
+  packages,
+  env,
+  platform,
+  arch,
+  branch,
+  commit,
+  status
+}) {
   if (!env) {
     env = {}
   }
   if (!platform) {
     platform = os.platform()
   }
+  if (!arch) {
+    arch = os.arch()
+  }
+
   la(
     is.unemptyString(packages) || is.strings(packages),
     'invalid package / list of packages',