nodejs如何執(zhí)行bash腳本?本篇文章給大家介紹一下node執(zhí)行bash腳本的幾種方案。
前言
最近在學習bash
腳本語法,但是如果對bash語法不是熟手的話,感覺非常容易出錯,比如說:顯示未定義的變量shell
中變量沒有定義,仍然是可以使用的,但是它的結(jié)果可能不是你所預期的。舉個例子:
#!/bin/bash # 這里是判斷變量var是否等于字符串a(chǎn)bc,但是var這個變量并沒有聲明 if [ "$var" = "abc" ] then # 如果if判斷里是true就在控制臺打印 “ not abc” echo " not abc" else # 如果if判斷里是false就在控制臺打印 “ abc” echo " abc " fi
結(jié)果是打印了abc,但問題是,這個腳本應該報錯啊,變量并沒有賦值算是錯誤吧。
為了彌補這些錯誤,我們學會在腳本開頭加入:set -u
這句命令的意思是腳本在頭部加上它,遇到不存在的變量就會報錯,并停止執(zhí)行。
再次運行就會提示:test.sh: 3: test.sh: num: parameter not set
再想象一下,你本來想刪除:rm -rf $dir/*
然后dir是空的時候,變成了什么?rm -rf
是刪除命令,$dir
是空的話,相當于執(zhí)行 rm -rf /*
,這是刪除所有文件和文件夾。。。然后,你的系統(tǒng)就沒了,這就是傳說中的刪庫跑路嗎~~~~
如果是node
或者瀏覽器環(huán)境,我們直接var === 'abc'
肯定是會報錯的,也就是說很多javascript編程經(jīng)驗無法復用到bash
來,如果能復用的話,該多好啊。
后來就開始探索,如果用node
腳本代替bash
該多好啊,經(jīng)過一天折騰逐漸發(fā)現(xiàn)一個神器,Google
旗下的zx
庫,先別著急,我先不介紹這個庫,我們先看看目前主流用node
如何編寫bash
腳本,就知道為啥它是神器了。
node執(zhí)行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
模塊無法執(zhí)行命令時,該對象不為空。例如,查找一個文件找不到該文件,則error對象不為空。但是,如果命令成功運行并將消息寫入標準錯誤流,則該stderr
對象不會為空。
當然我們可以使用同步的exec
命令,execSync
// 引入 exec 命令 from child_process 模塊 const { execSync } = require("child_process"); // 同步創(chuàng)建了一個hello的文件夾 execSync("mkdir hello");
再簡單介紹一下child_process的其它能夠執(zhí)行bash命令的api
- spawn: 啟動一個子進程來執(zhí)行命令
- exec:啟動一個子進程來執(zhí)行命令,與spawn不同的是,它有一個回調(diào)函數(shù)能知道子進程的情況
- execFile:啟動一子進程來執(zhí)行可執(zhí)行文件
- fork:與spawn類似,不同點是它需要指定子進程需要需執(zhí)行的javascript文件
exec跟ececFile不同的是,exec適合執(zhí)行命令,eexecFile適合執(zhí)行文件。
【推薦學習:《nodejs 教程》】
node執(zhí)行bash腳本: 進階方案 shelljs
const shell = require('shelljs'); # 刪除文件命令 shell.rm('-rf', 'out/Release'); // 拷貝文件命令 shell.cp('-R', 'stuff/', 'out/Release'); # 切換到lib目錄,并且列出目錄下到.js結(jié)尾到文件,并替換文件內(nèi)容(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('..'); # 除非另有說明,否則同步執(zhí)行給定的命令。 在同步模式下,這將返回一個 ShellString #(與 ShellJS v0.6.x 兼容,它返回一個形式為 { code:..., stdout:..., stderr:... } 的對象)。 # 否則,這將返回子進程對象,并且回調(diào)接收參數(shù)(代碼、標準輸出、標準錯誤)。 if (shell.exec('git commit -am "Auto-commit"').code !== 0) { shell.echo('Error: Git commit failed'); shell.exit(1); }
從上面代碼上看來,shelljs真的已經(jīng)算是非常棒的nodejs寫bash腳本的方案了,如果你們那邊的node環(huán)境不能隨便升級,我覺得shelljs確實夠用了。
接著我們看看今天的主角zx,start已經(jīng)17.4k了。
zx庫
官方網(wǎng)址:https://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就行,而且它的優(yōu)點還不止這些,有一些特點挺有意思的:
1、支持ts,自動編譯.ts為.mjs文件,.mjs文件是node高版本自帶的支持es6 module的文件結(jié)尾,也就是這個文件直接import模塊就行,不用其它工具轉(zhuǎn)義
2、自帶支持管道操作pipe方法
3、自帶fetch庫,可以進行網(wǎng)絡請求,自帶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 ,轉(zhuǎn)義參數(shù)并提供合理的默認值。
安裝
npm i -g zx
需要的環(huán)境
Node.js >= 14.8.0
將腳本寫入擴展名為 .mjs
的文件中,以便能夠在頂層使用await
。
將以下 shebang
添加到 zx
腳本的開頭:
#!/usr/bin/env zx 現(xiàn)在您將能夠像這樣運行您的腳本: chmod +x ./script.mjs ./script.mjs
或者通過 zx
可執(zhí)行文件:
zx ./script.mjs
所有函數(shù)($、cd、fetch 等)
都可以直接使用,無需任何導入。
$`command`
使用 child_process
包中的 spawn 函數(shù)執(zhí)行給定的字符串, 并返回 ProcessPromise.
let count = parseInt(await $`ls -1 | wc -l`) console.log(`Files count: ${count}`)
例如,要并行上傳文件:
如果執(zhí)行的程序返回非零退出代碼,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)
閱讀