fix: execa call with args

Author: bahmutov

bin/commit-message-install.js

@@ -49,7 +49,7 @@ function commitMessageInstall (cliArguments) {
             stdio: 'inherit',
             shell: true
           }
-          return utils.callExeca(args.else, options)
+          return utils.callExeca(args.else, [], options)
         }
         return
       }

src/commit-message-install-spec.js

@@ -20,7 +20,7 @@ describe.only('commit-message-install', () => {
 
   context('gets last commit message', () => {
     beforeEach(() => {
-      sandbox.stub(utils, 'callExeca').withArgs(getMessageGitCommand, { shell: true }).resolves({
+      sandbox.stub(utils, 'callExeca').withArgs(getMessageGitCommand, [], { shell: true }).resolves({
         exitCode: 0,
         stdout: 'message body',
         stderr: ''
@@ -40,7 +40,7 @@ describe.only('commit-message-install', () => {
     const sha = '3d243ea'
     beforeEach(() => {
       const cmd = getMessageGitCommand + ' ' + sha
-      sandbox.stub(utils, 'callExeca').withArgs(cmd, { shell: true }).resolves({
+      sandbox.stub(utils, 'callExeca').withArgs(cmd, [], { shell: true }).resolves({
         exitCode: 0,
         stdout: 'message body',
         stderr: ''
@@ -71,7 +71,7 @@ describe.only('commit-message-install', () => {
         }
         \`\`\`
       `
-      sandbox.stub(utils, 'callExeca').withArgs(getMessageGitCommand, { shell: true }).resolves({
+      sandbox.stub(utils, 'callExeca').withArgs(getMessageGitCommand, [], { shell: true }).resolves({
         exitCode: 0,
         stdout: message,
         stderr: ''
@@ -97,7 +97,7 @@ describe.only('commit-message-install', () => {
       const json = toMarkdownJsonBlock(info)
       const message = `some text\n\n` + json
 
-      sandbox.stub(utils, 'callExeca').withArgs(getMessageGitCommand, { shell: true }).resolves({
+      sandbox.stub(utils, 'callExeca').withArgs(getMessageGitCommand, [], { shell: true }).resolves({
         exitCode: 0,
         stdout: message,
         stderr: ''
@@ -110,7 +110,7 @@ describe.only('commit-message-install', () => {
 
     it('returns undefined without valid block', () => {
       const message = 'this message has no json code'
-      sandbox.stub(utils, 'callExeca').withArgs(getMessageGitCommand, { shell: true }).resolves({
+      sandbox.stub(utils, 'callExeca').withArgs(getMessageGitCommand, [], { shell: true }).resolves({
         exitCode: 0,
         stdout: message,
         stderr: ''
@@ -126,11 +126,11 @@ describe.only('commit-message-install', () => {
     const commitMessageInstall = require('../bin/commit-message-install')
 
     beforeEach(() => {
-      sandbox.stub(utils, 'callExeca').withArgs('git show -s --pretty=%b', { shell: true }).resolves({
+      sandbox.stub(utils, 'callExeca').withArgs('git show -s --pretty=%b', [], { shell: true }).resolves({
         exitCode: 0,
         stdout: 'nothing to do',
         stderr: ''
-      }).withArgs('echo cool', { shell: true, stdio: 'inherit' }).resolves({
+      }).withArgs('echo cool', [], { shell: true, stdio: 'inherit' }).resolves({
         exitCode: 0,
         stdout: 'cool is working',
         stderr: ''

src/index.js

@@ -1,4 +1,5 @@
 'use strict'
+// @ts-check
 
 const debug = require('debug')('commit-message-install')
 const la = require('lazy-ass')
@@ -18,7 +19,7 @@ function getMessage (sha) {
     ? currentMessageCommand + ' ' + sha
     : currentMessageCommand
   debug('git command "%s"', cmd)
-  return utils.callExeca(cmd, { shell: true }).then(prop('stdout'))
+  return utils.callExeca(cmd, [], { shell: true }).then(prop('stdout'))
 }
 
 // parses given commit message text (body)
@@ -191,7 +192,7 @@ function runIf (command, json) {
     stdio: 'inherit',
     shell: true
   }
-  return utils.callExeca(command, options)
+  return utils.callExeca(command, [], options)
 }
 
 function npmInstall (json) {

src/utils.js

@@ -33,11 +33,16 @@ const toMarkdownJsonBlock = object => {
 }
 
 /**
- * Little utility function to make stubbing "execa" easier
-*/
-const callExeca = (cmd, options = {}) => {
+ * Little utility function to make stubbing "execa" easier.
+ * @param {string} cmd Command to run
+ * @param {readonly string[]} args List of arguments
+ * @param {object} options Child process options
+ */
+const callExeca = (cmd, args, options) => {
   la(is.unemptyString(cmd), 'missing command to execute', cmd)
-  return execa(cmd, options)
+  la(is.strings(args), 'arguments should be a list of string', args)
+  la(is.object(options), 'options should be an object', options)
+  return execa(cmd, args, options)
 }
 
 module.exports = {