👏 nodejs寫bash腳本終極方案！

前言

最近在學習bash腳本語法，可是若是對bash語法不是熟手的話，感受很是容易出錯，好比說：顯示未定義的變量shell中變量沒有定義，仍然是可使用的，可是它的結果可能不是你所預期的。舉個例子：

#！/bin/bash

# 這裏是判斷變量var是否等於字符串abc，可是var這個變量並無聲明
if [ "$var" = "abc" ] 
then
   # 若是if判斷裏是true就在控制檯打印 「 not abc」
   echo  " not abc" 
else
   # 若是if判斷裏是false就在控制檯打印 「 abc」
   echo " abc "
fi
複製代碼

結果是打印了abc，但問題是，這個腳本應該報錯啊，變量並無賦值算是錯誤吧。

爲了彌補這些錯誤，咱們學會在腳本開頭加入：set -u 這句命令的意思是腳本在頭部加上它，遇到不存在的變量就會報錯，並中止執行。

再次運行就會提示：test.sh: 3: test.sh: num: parameter not set

再想象一下，你原本想刪除：rm -rf $dir/*而後dir是空的時候，變成了什麼？rm -rf是刪除命令，$dir是空的話，至關於執行 rm -rf /*,這是刪除全部文件和文件夾。。。而後，你的系統就沒了，這就是傳說中的刪庫跑路嗎~~~~

若是是node或者瀏覽器環境，咱們直接var === 'abc' 確定是會報錯的,也就是說不少javascript編程經驗沒法複用到bash來，若是能複用的話，該多好啊。

後來就開始探索，若是用node腳本代替bash該多好啊，通過一天折騰逐漸發現一個神器，Google旗下的zx庫，先彆着急，我先不介紹這個庫，咱們先看看目前主流用node如何編寫bash腳本，就知道爲啥它是神器了。

node執行bash腳本: 勉強解決方案：child_process API

例如 child_process的API裏面exec命令

const { exec } = require("child_process");

exec("ls -la", (error, stdout, stderr) => {
    if (error) {
        console.log(`error: ${error.message}`);
        return;
    }
    if (stderr) {
        console.log(`stderr: ${stderr}`);
        return;
    }
    console.log(`stdout: ${stdout}`);
});
複製代碼

這裏須要注意的是，首先exec是異步的，可是咱們bash腳本命令不少都是同步的。

並且注意：error對象不一樣於stderr. error當child_process模塊沒法執行命令時，該對象不爲空。例如，查找一個文件找不到該文件，則error對象不爲空。可是，若是命令成功運行並將消息寫入標準錯誤流，則該stderr對象不會爲空。

固然咱們可使用同步的exec命令，execSync

// 引入 exec 命令 from child_process 模塊
const { execSync } = require("child_process");

// 同步建立了一個hello的文件夾
execSync("mkdir hello");
複製代碼

再簡單介紹一下child_process的其它可以執行bash命令的api

• spawn： 啓動一個子進程來執行命令
• exec：啓動一個子進程來執行命令，與spawn不一樣的是，它有一個回調函數能知道子進程的狀況
• execFile：啓動一子進程來執行可執行文件
• fork：與spawn相似，不一樣點是它須要指定子進程須要需執行的javascript文件

exec跟ececFile不一樣的是，exec適合執行命令，eexecFile適合執行文件。

node執行bash腳本: 進階方案 shelljs

const shell = require('shelljs');
 
# 刪除文件命令
shell.rm('-rf', 'out/Release');
// 拷貝文件命令
shell.cp('-R', 'stuff/', 'out/Release');
 
# 切換到lib目錄，而且列出目錄下到.js結尾到文件，並替換文件內容（sed -i 是替換文字命令）
shell.cd('lib');
shell.ls('*.js').forEach(function (file) {
  shell.sed('-i', 'BUILD_VERSION', 'v0.1.2', file);
  shell.sed('-i', /^.*REMOVE_THIS_LINE.*$/, '', file);
  shell.sed('-i', /.*REPLACE_LINE_WITH_MACRO.*\n/, shell.cat('macro.js'), file);
});
shell.cd('..');
 
# 除非另有說明，不然同步執行給定的命令。 在同步模式下，這將返回一個 ShellString
#（與 ShellJS v0.6.x 兼容，它返回一個形式爲 { code:..., stdout:..., stderr:... } 的對象）。
# 不然，這將返回子進程對象，而且回調接收參數（代碼、標準輸出、標準錯誤）。
if (shell.exec('git commit -am "Auto-commit"').code !== 0) {
  shell.echo('Error: Git commit failed');
  shell.exit(1);
}
複製代碼

從上面代碼上看來，shelljs真的已經算是很是棒的nodejs寫bash腳本的方案了，若是大家那邊的node環境不能隨便升級，我以爲shelljs確實夠用了。

接着咱們看看今天的主角zx，start已經17.4k了。

zx庫

官方網址：www.npmjs.com/package/zx

咱們先看看怎麼用

#!/usr/bin/env zx

await $`cat package.json | grep name`

let branch = await $`git branch --show-current`
await $`dep deploy --branch=${branch}`

await Promise.all([
  $`sleep 1; echo 1`,
  $`sleep 2; echo 2`,
  $`sleep 3; echo 3`,
])

let name = 'foo bar'
await $`mkdir /tmp/${name}
複製代碼

各位看官以爲咋樣，是否是就是在寫linux命令而已，bash語法能夠忽略不少，直接上js就行，並且它的優勢還不止這些，有一些特色挺有意思的：

一、支持ts，自動編譯.ts爲.mjs文件，.mjs文件是node高版本自帶的支持es6 module的文件結尾，也就是這個文件直接import模塊就行，不用其它工具轉義

二、自帶支持管道操做pipe方法

三、自帶fetch庫，能夠進行網絡請求，自帶chalk庫，能夠打印有顏色的字體，自帶錯誤處理nothrow方法，若是bash命令出錯，能夠包裹在這個方法裏忽略錯誤

完整中文文檔（在下翻譯水平通常，請見諒）

#!/usr/bin/env zx

await $`cat package.json | grep name`

let branch = await $`git branch --show-current`
await $`dep deploy --branch=${branch}`

await Promise.all([
  $`sleep 1; echo 1`,
  $`sleep 2; echo 2`,
  $`sleep 3; echo 3`,
])

let name = 'foo bar'
await $`mkdir /tmp/${name}
複製代碼

Bash 很棒，可是在編寫腳本時，人們一般會選擇更方便的編程語言。 JavaScript 是一個完美的選擇，但標準的 Node.js 庫在使用以前須要額外的作一些事情。 zx 基於 child_process ，轉義參數並提供合理的默認值。

安裝

npm i -g zx
複製代碼

須要的環境

Node.js >= 14.8.0
複製代碼

將腳本寫入擴展名爲 .mjs 的文件中，以便可以在頂層使用await。

將如下 shebang添加到 zx 腳本的開頭：

#!/usr/bin/env zx
如今您將可以像這樣運行您的腳本：

chmod +x ./script.mjs
./script.mjs
複製代碼

或者經過 zx可執行文件：

zx ./script.mjs
複製代碼

全部函數（$、cd、fetch 等）均可以直接使用，無需任何導入。

$`command`

使用 child_process 包中的 spawn 函數執行給定的字符串, 並返回 ProcessPromise.

let count = parseInt(await $`ls -1 | wc -l`)
console.log(`Files count: ${count}`)
複製代碼

例如，要並行上傳文件：

若是執行的程序返回非零退出代碼，ProcessOutput 將被拋出

try {
  await $`exit 1`
} catch (p) {
  console.log(`Exit code: ${p.exitCode}`)
  console.log(`Error: ${p.stderr}`)
}
複製代碼

ProcessPromise，如下是promise typescript的接口定義

class ProcessPromise<T> extends Promise<T> {
  readonly stdin: Writable
  readonly stdout: Readable
  readonly stderr: Readable
  readonly exitCode: Promise<number>
  pipe(dest): ProcessPromise<T>
}
複製代碼

pipe() 方法可用於重定向標準輸出：

await $`cat file.txt`.pipe(process.stdout)
複製代碼

閱讀更多的關於管道的信息 github.com/google/zx/b…

ProcessOutput的typescript接口定義

class ProcessOutput {
  readonly stdout: string
  readonly stderr: string
  readonly exitCode: number
  toString(): string
}
複製代碼

函數：

cd()

更改當前工做目錄

cd('/tmp')
await $`pwd` // outputs /tmp
複製代碼

fetch()

node-fetch 包。

let resp = await fetch('http://wttr.in')
if (resp.ok) {
  console.log(await resp.text())
}
複製代碼

question()

readline包

let bear = await question('What kind of bear is best? ')
let token = await question('Choose env variable: ', {
  choices: Object.keys(process.env)
})
複製代碼

在第二個參數中，能夠指定選項卡自動完成的選項數組

如下是接口定義

function question(query?: string, options?: QuestionOptions): Promise<string> type QuestionOptions = { choices: string[] }
複製代碼

sleep()

基於setTimeout 函數

await sleep(1000)
複製代碼

nothrow()

將 $ 的行爲更改, 若是退出碼不是0，不跑出異常.

ts接口定義

function nothrow<P>(p: P): P 複製代碼

await nothrow($`grep something from-file`)
// 在管道內:

await $`find ./examples -type f -print0`
  .pipe(nothrow($`xargs -0 grep something`))
  .pipe($`wc -l`)
複製代碼

如下的包，無需導入，直接使用

chalk

console.log(chalk.blue('Hello world!'))
複製代碼

fs

相似於以下的使用方式

import {promises as fs} from 'fs'
let content = await fs.readFile('./package.json')
複製代碼

os

await $`cd ${os.homedir()} && mkdir example`
複製代碼

配置：

$.shell

指定要用的bash.

$.shell = '/usr/bin/bash'
複製代碼

$.quote

指定用於在命令替換期間轉義特殊字符的函數

默認用的是 shq 包.

注意：

__filename & __dirname這兩個變量是在commonjs中的。咱們用的是.mjs結尾的es6 模塊。

在ESM模塊中，Node.js 不提供__filename和 __dirname 全局變量。 因爲此類全局變量在腳本中很是方便，所以 zx 提供了這些以在 .mjs 文件中使用（當使用 zx 可執行文件時）

require也是commonjs中的導入模塊方法， 在 ESM 模塊中，沒有定義 require() 函數。zx提供了 require() 函數，所以它能夠與 .mjs 文件中的導入一塊兒使用（當使用 zx 可執行文件時）

傳遞環境變量

process.env.FOO = 'bar'
await $`echo $FOO`
複製代碼

傳遞數組

若是值數組做爲參數傳遞給 $，數組的項目將被單獨轉義並經過空格鏈接 Example:

let files = [1,2,3]
await $`tar cz ${files}`
複製代碼

能夠經過顯式導入來使用 $ 和其餘函數

#!/usr/bin/env node
import {$} from 'zx'
await $`date`
複製代碼

zx 能夠將 .ts 腳本編譯爲 .mjs 並執行它們

zx examples/typescript.ts
複製代碼