nodejs如何執行bash腳本?本篇文章為大家介紹node執行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
腳本,就知道為啥它是神器了。
例如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
nodejs 教學》】
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); }
#!/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}
1、支援ts,自動編譯.ts為.mjs文件,.mjs檔案是node高版自帶的支援es6 module的檔案結尾,也就是這個檔案直接import模組就行,不用其它工具轉義2、自備支援管道操作pipe方法3、自備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}
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 等)
都可以直接使用,无需任何导入。
使用 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)
阅读更多的关于管道的信息:https://github.com/google/zx/blob/HEAD/examples/pipelines.md
ProcessOutput
的typescript
接口定义
class ProcessOutput { readonly stdout: string readonly stderr: string readonly exitCode: number toString(): string }
函数:
更改当前工作目录
cd('/tmp') await $`pwd` // outputs /tmp
node-fetch 包。
let resp = await fetch('http://wttr.in') if (resp.ok) { console.log(await resp.text()) }
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[] }
基于setTimeout 函数
await sleep(1000)
将 $ 的行为更改, 如果退出码不是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`)
以下的包,无需导入,直接使用
console.log(chalk.blue('Hello world!'))
类似于如下的使用方式
import {promises as fs} from 'fs' let content = await fs.readFile('./package.json')
await $`cd ${os.homedir()} && mkdir example`
配置:
指定要用的bash.
$.shell = '/usr/bin/bash'
指定用于在命令替换期间转义特殊字符的函数
默认用的是 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 nodeimport {$} from 'zx'await $`date`复制代码
zx 可以将 .ts 脚本编译为 .mjs 并执行它们
zx examples/typescript.ts
更多编程相关知识,请访问:编程视频!!
以上是淺談nodejs執行bash腳本的幾種方案的詳細內容。更多資訊請關注PHP中文網其他相關文章!