feat: add run-if command, close #2

Author: bahmutov

.travis.yml

@@ -13,6 +13,7 @@ script:
   - DEBUG=commit-message-install node ./bin/commit-message-install.js
   # synthetic test case
   - DEBUG=commit-message-install node ./bin/commit-message-install.js -f test/message.txt
+  - npm run demo
 after_success:
   - npm run semantic-release
 branches:

README.md

@@ -52,6 +52,24 @@ Happy installation
 **note** `platform` can be `*` or specific one like `darwin` (from Node `os.platform()`) or a 
 list of several platforms like `darwin,linux`
 
+### Run or skip command based on platform
+
+If the commit message allows a specific platform, you can run any command, while
+setting environment variables from the commit message. For example if th
+commit message embeds the following JSON block
+
+```json
+{
+    "platform": "win32",
+    "env": {
+        "FOO": "bar"
+    }
+}
+```
+
+and the CI has command `run-if echo Foo is \\$FOO`, then on Windows CI it will print
+`Foo is bar` and on other platforms it will skip this step.
+
 ## Debugging
 
 - Run this tool with `DEBUG=commit-message-install` environment variable set

__snapshots__/commit-message-install-spec.js

@@ -36,3 +36,51 @@ exports['commit-message-install getCommand removes --file and its argument 1'] =
 exports['commit-message-install getJsonBlock returns first found json block 1'] = {
   "foo": "bar"
 }
+
+exports['commit-message-install isPlatformAllowed compares platforms isPlatformAllowed 1'] = {
+  "name": "isPlatformAllowed",
+  "behavior": [
+    {
+      "given": [
+        "win32",
+        "win32"
+      ],
+      "expect": true
+    },
+    {
+      "given": [
+        "win32",
+        "linux"
+      ],
+      "expect": false
+    },
+    {
+      "given": [
+        "*",
+        "linux"
+      ],
+      "expect": true
+    },
+    {
+      "given": [
+        "win32,linux",
+        "linux"
+      ],
+      "expect": true
+    },
+    {
+      "given": [
+        "win32|linux",
+        "linux"
+      ],
+      "expect": true
+    },
+    {
+      "given": [
+        "win32, linux",
+        "linux"
+      ],
+      "expect": true
+    }
+  ]
+}

src/commit-message-install-spec.js

@@ -21,6 +21,26 @@ describe('commit-message-install', () => {
     })
   })
 
+  context('isPlatformAllowed', () => {
+    const { isPlatformAllowed } = require('.')
+
+    it('is a function', () => {
+      la(is.fn(isPlatformAllowed))
+    })
+
+    it('compares platforms', () => {
+      snapshot(
+        isPlatformAllowed,
+        ['win32', 'win32'],
+        ['win32', 'linux'],
+        ['*', 'linux'],
+        ['win32,linux', 'linux'],
+        ['win32|linux', 'linux'],
+        ['win32, linux', 'linux']
+      )
+    })
+  })
+
   context('getCommand', () => {
     const { getCommand } = require('.')
 

src/index.js

@@ -75,9 +75,13 @@ const isRunIf = is.schema({
   env: is.maybe.object
 })
 
-function isPlatformAllowed (platform) {
+function isPlatformAllowed (platform, osPlatform = os.platform()) {
+  if (!platform) {
+    return true
+  }
+  debug('checking platform, allowed platform is', platform)
   la(is.unemptyString(platform), 'invalid allowed platform', platform)
-  return platform === '*' || platform.indexOf(os.platform()) !== -1
+  return platform === '*' || platform.indexOf(osPlatform) !== -1
 }
 
 function getCommand (args) {
@@ -97,25 +101,33 @@ function getCommand (args) {
 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'))
+
+  if (!isPlatformAllowed(json.platform, os.platform())) {
+    console.log('Required platform: %s', json.platform)
+    console.log('Current platform: %s', os.platform())
+    console.log('skipping command')
+    return Promise.resolve()
+  }
+
+  const options = {
+    env: json.env,
+    stdio: 'inherit'
+  }
+  return execa.shell(command, options).then(prop('stdout'))
 }
 
 function npmInstall (json) {
   if (!json) {
     debug('missing json for npm install')
-    return
+    return Promise.resolve()
   }
   la(isNpmInstall(json), 'invalid JSON to install format', json)
 
-  if (json.platform) {
-    debug('checking platform, expecting', json.platform)
-    la(is.unemptyString(json.platform), 'invalid json platform', json.platform)
-    if (!isPlatformAllowed(json.platform)) {
-      console.log('Required platform: %s', json.platform)
-      console.log('Current platform: %s', os.platform())
-      console.log('skipping install')
-      return
-    }
+  if (!isPlatformAllowed(json.platform, os.platform())) {
+    console.log('Required platform: %s', json.platform)
+    console.log('Current platform: %s', os.platform())
+    console.log('skipping install')
+    return Promise.resolve()
   }
 
   const env = json.env || {}

test/run-if.txt

@@ -3,7 +3,7 @@ used to simulate commit message
 
 ```json
 {
-  "platform": "*",
+  "platform": "darwin|linux",
   "env": {
     "FOO": "bar"
   }