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