回調蛋糕 —— cake下順序執行命令

cake是CoffeeScript自帶的make工具，簡單易用。不過有一個問題，由於Node.js默認是異步的，因此你很難保證執行順序。

如何解決呢？其實用回調函數就能夠。

例如，假定咱們平時使用config.json（方便開發和測試），可是在發佈NPM包的時候，但願發佈config.json.example。這就要求咱們在npm publish先後修改文件名——也就是說，要保證執行的順序，不能出現文件名還沒改好就發佈的狀況。若是用sh表達的話，就是：

mv config.json config.json.example
npm publish
mv config.json.example config.json

硬來的話，是這麼寫：

{spawn} = require 'child_process'

spawn 'mv', ['config.json', 'config.json.example']
spawn 'npm', ['publish']
spawn 'mv', ['config.json.example', 'congfig.json']

硬蛋糕可很差吃！這樣是不行的，由於child_process.spawn是異步的。

因此，咱們須要把上面的代碼改爲回調的形式，確保上一步退出時才調用下一步：

mv = spawn 'mv', ['config.json', 'config.json.example']
mv.on 'exit', ->
  npm_publish = spawn 'npm', ['publish']
  npm_publish.on 'exit', ->'
    spawn 'mv', ['config.json.example', 'congfig.json']

這樣就能夠了。但是每次這麼寫還蠻煩的。咱們把它抽象成一個函數。

嗯，該怎麼寫呢？首先，咱們肯定這個函數的輸入，函數應當接受一個命令，後面是一串回調函數。所以：

shell_commands = (args...) ->

args...是splats，用來表示參數數目不定。

而後咱們須要作的就是執行這個命令，在命令執行完畢以後，運行那一串回調函數。

所以，咱們首先獲得須要執行的命令，這很簡單，pop掉最後的一串回調函數，再交給spawn執行便可。

args.pop()
[command, args...] = args
spawn command, args

注意上面的args...一樣是splats，此次用於模式匹配。

而後加上運行回調函數的代碼，咱們的函數基本就成形了：

shell_commands = (args...) ->
  callback = args.pop()
  [command, args..] = args
  shell_command = spawn command, args
  shell_command.on 'exit' ->
    callback()

有個問題，回調到最後，會是單純的命令，沒有回調函數了。所以咱們加一個判斷，若是args的最後一項不是函數的話，那就不pop了，直接執行命令就好了：

shell_commands = (args...) ->
  if typeof(args[a.length - 1]) is 'function'
    callback = args.pop()
  else
    callback = ->
  [command, args..] = args
  shell_command = spawn command, args
  shell_command.on 'exit' ->
    callback()

抽象出了這個函數之後，咱們原先的代碼就能夠這麼寫了：

shell_commands 'mv', 'config.json', 'config.json.example', ->
  shell_commands 'npm', 'publish', ->
    shell_commands 'mv', 'config.json.example', 'config.json'

是否是清爽多了？

沒有處理的問題是，萬一在重命名的過程當中出問題了，那麼咱們不該該發佈NPM包。因此，咱們加一下判斷，若是進程的exit code不爲0（這就意味着有錯誤），那麼繼續執行。

shell_commands = (args...) ->
  if typeof(args[a.length - 1]) is 'function'
    callback = args.pop()
  else
    callback = ->
  [command, args..] = args
  shell_command = spawn command, args
  shell_command.on 'exit', (code) ->
    if code isnt 0
      callback(code)
    else
      console.log("Exited with status: " + code)

相應地，調用的時候也須要傳入code：

shell_commands 'mv', 'config.json', 'config.json.example', (code) ->
  shell_commands 'npm', 'publish', (code) ->
    shell_commands 'mv', 'config.json.example', 'config.json'

一般你們喜歡verbose的輸出，那麼咱們就在終端顯示一下執行的命令：

console.log(command, " ", args.join(" "))

最終的CakeFile相似這樣：

{spawn} = require 'child_process'

shell_commands = (args...) ->
  if typeof(args[a.length - 1]) is 'function'
    callback = args.pop()
  else
    callback = ->
  [command, args..] = args
  console.log(command, " ", args.join(" "))
  shell_command = spawn command, args
  shell_command.on 'exit', (code) ->
    if code isnt 0
      callback(code)
    else
      console.log("Exited with status: " + code)

task "publish", "publish NPM", ->
  shell_commands 'mv', 'config.json', 'config.json.example', (code) ->
    shell_commands 'npm', 'publish', (code) ->
      shell_commands 'mv', 'config.json.example', 'config.json'

task "test", "run unit tests", ->
  shell_commands './node_module/.bin/mocha'