用spawn 來編寫跨平臺 Node.js命令

前言

Node.js 是跨平臺的，也就是說它能運行在 Windows、OSX 和 Linux 平臺上。不少 Node.js 開發者都是在 OSX 上作開發的，而後再將代碼部署到 Linux 服務器上。因爲 OSX 和 Linux 都是基於 Unix 的，所以二者共性不少。Windows 也是 Node.js 官方支持的平臺，只要你經過正確的方式寫代碼，就能在各個平臺上毫無壓力的跑起來。

Node.js 的子進程 (child_process) 模塊下有一 spawn 函數，能夠用於調用系統上的命令，如在 Linux, macOS 等系統上，咱們能夠執行以下代碼來調用通用的 npm 命令。

const spawn = require('child_process').spawn;

spawn('npm', {
 stdio: 'inherit'
});
複製代碼

然而，一樣的語句在 Windows 上執行則會報錯。

Error: spawn npm ENOENT
 at exports._errnoException (util.js:855:11)
 at Process.ChildProcess._handle.onexit (internal/child_process.js:178:32)
 at onErrorNT (internal/child_process.js:344:16)
 at nextTickCallbackWith2Args (node.js:455:9)
 at process._tickCallback (node.js:369:17)
 at Function.Module.runMain (module.js:432:11)
 at startup (node.js:141:18)
 at node.js:980:3
複製代碼

由於在 Windows 上，當咱們執行 npm 時，咱們實際執行的是 npm.cmd 批處理，而在 Windows 上， .cmd, .bat 批處理是沒法脫離 cmd.exe 這一解釋器而單獨運行的。

所以，咱們須要顯式地調用 cmd

spawn('cmd', ['/c', 'npm'], {
 stdio: 'inherit'
});
複製代碼

或者使用在調用 spawn 函數時，設置 shell 選項爲 true 以隱式地調用 cmd

spawn('npm', {
 stdio: 'inherit',
 shell: true
});
複製代碼

另外，雖然在 Linux, macOS 等系統上不須要設置 shell 選項，命令也可以正常執行；設置 shell 爲 true 也不會妨礙命令的執行，只是會額外的產生一個本沒必要要的 shell 進程，影響性能。

所以，若是想要編寫跨平臺的 spawn 命令，而又不想增長額外的開銷的話，能夠這樣寫

const process = require('process');
const { spawn } = require('child_process');

spawn('npm', {
 stdio: 'inherit',
 // 僅在當前運行環境爲 Windows 時，才使用 shell
 shell: process.platform === 'win32'
});
複製代碼

cross-spawn第三方模塊

關於 spawn 函數的跨平臺寫法，除了本身編寫代碼的時候作處理，也有第三方模塊封裝好了相關細節，如 cross-spawn。

使用該模塊，能夠在調用 spawn 函數時，自動根據當前的運行平臺，來決定是否生成一個 shell 來執行所給的命令。對命令和參數中的字符進行轉義更爲方便。

#!/usr/bin/env node

const spawn = require('cross-spawn');
const { resolve } = require('path');
const { existsSync } = require('fs');

const version = process.env.CLI_BIN || '1.0.0';

const CLI_BIN = resolve(__dirname, process.platform, version, 'cli-bin');

if (!existsSync(CLI_BIN)) {
  console.log(`${version} 版本不存在`);
  process.exit(1);
}

spawn(CLI_BIN, process.argv.slice(2), { stdio: 'inherit' });

複製代碼