WIP: working on any conditional command

Author: bahmutov

__snapshots__/commit-message-install-spec.js

@@ -1,3 +1,38 @@
 exports['commit-message-install getJsonBlock finds single json block 1'] = {
   "foo": "bar"
 }
+
+exports['commit-message-install getCommand returns original command from array 1'] = {
+  "args": [
+    "echo",
+    "foo",
+    "bar"
+  ],
+  "command": "echo foo bar"
+}
+
+exports['commit-message-install getCommand removes -f and its argument 1'] = {
+  "args": [
+    "-f",
+    "file.txt",
+    "echo",
+    "foo",
+    "bar"
+  ],
+  "command": "echo foo bar"
+}
+
+exports['commit-message-install getCommand removes --file and its argument 1'] = {
+  "args": [
+    "--file",
+    "file.txt",
+    "echo",
+    "foo",
+    "bar"
+  ],
+  "command": "echo foo bar"
+}
+
+exports['commit-message-install getJsonBlock returns first found json block 1'] = {
+  "foo": "bar"
+}

bin/commit-message-install.js

@@ -21,9 +21,7 @@ start.then(getJsonBlock).then(json => {
   if (!json) {
     return
   }
-  if (json) {
-    console.log('got json block from the git commit message')
-    console.log(JSON.stringify(json, null, 2))
-    return npmInstall(json)
-  }
+  console.log('got json block from the git commit message')
+  console.log(JSON.stringify(json, null, 2))
+  return npmInstall(json)
 }, console.error)

bin/commit-message-run.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+// runs any command if commit message
+//  a: does not contain JSON
+//  b: JSON does not specify a platform that disallows it
+// for example if commit message has
+//   {"platform": "win32"}
+// and CI command has
+//   run-if echo "I am running on Windows"
+// then Windows CI will show the message, and other CIs
+// will skip it
+
+const debug = require('debug')('commit-message-install')
+
+const allArgs = process.argv.slice(2)
+const args = require('minimist')(allArgs, {
+  alias: {
+    file: 'f'
+  },
+  string: 'file'
+})
+const { getMessage, getCommand, getJsonBlock, runIf } = require('..')
+
+const actualCommand = getCommand(allArgs)
+debug('command to run:', actualCommand)
+
+let start
+if (args.file) {
+  console.log('loading message from file', args.file)
+  const fs = require('fs')
+  const message = fs.readFileSync(args.file, 'utf8')
+  start = Promise.resolve(message)
+} else {
+  start = getMessage().then(x => x.body)
+}
+start.then(getJsonBlock).then(json => {
+  if (!json) {
+    return runIf(actualCommand)
+  }
+  console.log('got json block from the git commit message')
+  console.log(JSON.stringify(json, null, 2))
+  return runIf(actualCommand, json)
+}, console.error)

package.json

@@ -6,7 +6,8 @@
   "bugs": "https://github.com/bahmutov/commit-message-install/issues",
   "bin": {
     "commit-message-install": "bin/commit-message-install.js",
-    "cmi": "bin/commit-message-install.js"
+    "cmi": "bin/commit-message-install.js",
+    "run-if": "bin/commit-message-run.js"
   },
   "config": {
     "pre-git": {
@@ -67,7 +68,8 @@
     "size": "t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";",
     "test": "npm run unit",
     "unit": "mocha src/*-spec.js",
-    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
+    "semantic-release": "semantic-release pre && npm publish && semantic-release post",
+    "demo": "node bin/commit-message-run.js -f test/run-if.txt echo Foo is \\$FOO"
   },
   "release": {
     "analyzeCommits": "simple-commit-message",

src/commit-message-install-spec.js

@@ -21,6 +21,32 @@ describe('commit-message-install', () => {
     })
   })
 
+  context('getCommand', () => {
+    const { getCommand } = require('.')
+
+    it('is a function', () => {
+      la(is.fn(getCommand))
+    })
+
+    it('returns original command from array', () => {
+      const args = ['echo', 'foo', 'bar']
+      const command = getCommand(args)
+      snapshot({ args, command })
+    })
+
+    it('removes -f and its argument', () => {
+      const args = ['-f', 'file.txt', 'echo', 'foo', 'bar']
+      const command = getCommand(args)
+      snapshot({ args, command })
+    })
+
+    it('removes --file and its argument', () => {
+      const args = ['--file', 'file.txt', 'echo', 'foo', 'bar']
+      const command = getCommand(args)
+      snapshot({ args, command })
+    })
+  })
+
   context('getJsonBlock', () => {
     it('is a function', () => {
       la(is.fn(getJsonBlock))
@@ -41,6 +67,26 @@ describe('commit-message-install', () => {
       snapshot(result)
     })
 
+    it('returns first found json block', () => {
+      const message = stripIndent`
+      some text
+      \`\`\`json
+      {
+        "foo": "bar"
+      }
+      \`\`\`
+      then second block
+      \`\`\`json
+      {
+        "no": false
+      }
+      \`\`\`
+      `
+      const result = getJsonBlock(message)
+      la(is.object(result), 'result should be an object', result)
+      snapshot(result)
+    })
+
     it('ignores just the text', () => {
       const message = stripIndent`
       some text

src/index.js

@@ -7,6 +7,8 @@ const is = require('check-more-types')
 const os = require('os')
 const execa = require('execa')
 
+const prop = name => object => object[name]
+
 function getMessage () {
   return ggit.lastCommitId().then(ggit.commitMessage)
 }
@@ -68,11 +70,36 @@ const isNpmInstall = is.schema({
   packages: is.unemptyString
 })
 
+const isRunIf = is.schema({
+  platform: is.maybe.unemptyString,
+  env: is.maybe.object
+})
+
 function isPlatformAllowed (platform) {
   la(is.unemptyString(platform), 'invalid allowed platform', platform)
   return platform === '*' || platform.indexOf(os.platform()) !== -1
 }
 
+function getCommand (args) {
+  la(is.array(args), 'expected arguments', args)
+  const cloned = [...args]
+  const flags = ['-f', '--file']
+  if (flags.includes(cloned[0])) {
+    debug('found flag', cloned[0])
+    cloned.shift()
+    cloned.shift()
+  }
+  const command = cloned.join(' ')
+  debug('found command', command)
+  return command
+}
+
+function runIf (command, json) {
+  la(is.unemptyString(command), 'missing command to run', command)
+  la(isRunIf(json), 'invalid runIf json', json)
+  return execa.shell(command, { env: json.env }).then(prop('stdout'))
+}
+
 function npmInstall (json) {
   if (!json) {
     debug('missing json for npm install')
@@ -100,7 +127,14 @@ function npmInstall (json) {
   return execa('npm', ['install', json.packages], {
     env,
     stdio: 'inherit'
-  }).then(x => x.stdout)
+  }).then(prop('stdout'))
 }
 
-module.exports = { getMessage, isPlatformAllowed, getJsonBlock, npmInstall }
+module.exports = {
+  getMessage,
+  getCommand,
+  runIf,
+  isPlatformAllowed,
+  getJsonBlock,
+  npmInstall
+}

test/run-if.txt

@@ -0,0 +1,13 @@
+this is a test message
+used to simulate commit message
+
+```json
+{
+  "platform": "*",
+  "env": {
+    "FOO": "bar"
+  }
+}
+```
+
+some other text