nodejs 寫 bash 腳本終極方案!

2022-01-09 前端大全
前言

最近在學習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
exec：啟動一個子進程來執行命令，與spawn不同的是，它有一個回調函數能知道子進程的情況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[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}
複製代碼
各位看官覺得咋樣，是不是就是在寫linux命令而已，bash語法可以忽略很多，直接上js就行，而且它的優點還不止這些，有一些特點挺有意思的：
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}
複製代碼
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…[2]
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
複製代碼

相關焦點

  • [Auto.js教程]js代碼加密終極方案>js腳本解析成.class
    這種加密都不靠譜，別人一還原就是全部無損代碼；2.自己寫加密算法，比如一些比較聰明的開發者，比如x戒自閱、閱讀什麼的，把代碼放在伺服器，啟動的是時候下載加載，而下載的js都是自己經過自定義加密過的。這種最沒意思，最終代碼肯定要通過engines模塊的execScript加載，而execScript傳遞的可是string哦《log大法》代碼就和盤突出、一目了然。
  • 怎樣開發一個 Node.js 命令行工具包
    初始化項目在一個合適的地方創建項目文件夾，為了演示，本次的項目名為 demo-cli，然後執行以下命令初始化項目：npm init執行以上命令之後，會先配置一些 package.json 的基礎信息，按提示輸入即可：1.1 配置 package.json為了方便，我們把項目從 vscode 中打開，然後對 package.json
  • 終極Bash腳本指南
    而 Bash 腳本是我們最容易接觸到和上手的腳本語言。這篇博客匯總一些常用的 Bash 語法，方便日後查閱學習。Hello World不管寫啥，上來先輸出個hello world。/hello.shhello world解釋器我們看到這個hello.sh 腳本，第一行有個 #!/bin/bash 。這個是用來指定該腳本在 UNIX/Linux 下執行時用到的解釋器。
  • 從零開始Docker化你的Node.js應用
    /${zip} ${user}@${ip}:${path}ssh ${user}@${ip}如果不想每次都輸入地址/帳戶/密碼，可以寫一個簡單的自動登錄腳本ssh.sh#：創建文件touch ssh.sh# 賦予腳本可執行權力chmod +x ssh.shssh.sh
  • Node.js前世今生
    在這裡插入圖片描述Node.js是建立在Chrome V8 上面的一個JavaScript運行環境通俗點解釋: js屬於一種腳本性語言，然而腳本語言運行需要一個解析器來解析，對於我們原來寫的js代碼大部分都是運行在網頁上，所以瀏覽器本身就擔當了解析器的角色
  • 自動化部署實踐(Node.js + Egg + Git + 雲效)
    出於以上需要，筆者對整個上線流程引入了自動化部署，本文主要講解筆者在做自動化部署方案選型中的種種思考以及最終方案。需要注意的是，本文提到的策略和方案是針對該項目的架構做出的適配，並非適合所有的架構，讀者在閱讀學習時需要注意取捨。
  • Centos7下使用 nvm 安裝 nodejs 環境
    訪問nvm的github，根據介紹可以看到相關的安裝腳本，如下：image-20200811150552884執行安裝腳本」執行curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash如下：
  • Node.js介紹和環境配置(含NVM、NPM、YARN的安裝)
    mocha：功能強大的 node.js 測試框架。PM2：node 本來是單進程的，PM2可以實現和管理多進程。jade：非常優秀的模板引擎，不僅限於 js 語言。CoffeeScript：用簡潔的方式展示 JavaScript 優秀的部分。
  • dotNet 5 中執行 Node.js
    .tar.xz 解壓安裝文件；4、執行命令 mv node-v14.17.4-linux-x64 nodejs 將解壓後的文件夾命名為 nodejs；5、執行命令 cp -r nodejs /usr/local 將 nodejs 目錄複製到 /usr/local ；
  • Node.js基礎
    "scripts": { "build": "node build.js" }}二、執行順序如果 npm 腳本裡面需要執行多個任務，那麼需要明確它們的執行順序。script1.jsscript2.js"scripts": { "script1": "node script1.js", "script2": "node script2.js"}如果是並行執行（即同時的平行執行），可以使用
  • 一些小眾卻有用的 Node.js 包
    ，然後在命令行中執行 node index.js -x 3，會看到如下消息：Usage: index.js -x [num] -y [num]Options: -x [required] -y
  • 如何用 Node.js 爬蟲?
    當然，除了 Python 還有很多語言能寫爬蟲，比如今天我們要講的 Node.js。簡單的介紹一下 Node.js，它可以在服務端運行 js，做過前端開發的程式設計師肯定很熟悉，js 是一門弱語言。但現在發展很迅速，茁長成長，在 Nodejs 出現以後，使得 js 不光能寫前端的動態效果，交互效果，還能寫 web 伺服器，我們甚至能用 Nodejs 去打包桌面端程序，從此，前端工程師的觸角向後延伸了一大塊。對於前端工程師來說有時候可能想爬取點簡單的頁面，那麼 Nodejs 將是我們的好幫手，當然了，閒來無事的時候，你也可以爬取一點福利站之類的，你懂得!
  • 需要搞懂的 Node.js 的核心 Feature
    __filename 當前腳本的文件名、路徑global.python ruby 以及其他腳本)一起使用，並且不創建一個新的V8實例require('child_process').fork() 創建一個新的V8實例，實例出多個worker和spawn不同的的是 fork 只執行 node 命令require('child_process').exec() 使用Buffer，這使得它不適合比較大的數據和Stream
  • 國內 Node.js 2015 總結
    聊聊實時 Node 應用性能監測的實現Node.js 啟動方式：一道關於全局變量的題目引發的思考Node.js 啟動方式：一道關於全局變量的題目引發的思考·續Node.js的Buffer那些你可能不知道的用法解析 node-murmurhash 庫：說說 Node.js 二進位操作簡單實現Promise/A+.
  • node.js寫一個小爬蟲
    如果你不會Python語言，正好又是一個node.js小白，看完這篇文章之後，一定會覺得受益匪淺，感受到自己又新get到了一門技能，如何用node.js
  • 寫 Node.js 代碼,從學會調試開始
    在當前 Node.js v15 版本下，以前非常多的調試方式已經失效了，Node.js 傳統的調試協議也進行了許多升級，我們按照最新的方式，來告訴你如何調試。為什麼要使用調試眾所周知，代碼是寫（調）出來的，而不是猜出來的。
  • 【 Node.js】你應該知道的 NPM 知識都在這!
    "scripts": {    "test": "test.js"    "build": "tsc",  },scripts 對象中每一個屬性，對應一段腳本。比如，test 命令對應的腳本是 node test.js。
  • 淺析 NodeJs 的幾種文件路徑
    ~T_T,我們可以得出一些膚淺的結論了：__dirname: 總是返回被執行的 js 所在文件夾的絕對路徑__filename: 總是返回被執行的 js 的絕對路徑process.cwd(): 總是返回運行 node 命令時所在的文件夾的絕對路徑./: 跟 process.cwd() 一樣、一樣、一樣的嗎？
  • 【 Node.js 進階】你應該知道的 NPM 知識都在這!
    "scripts": {    "test": "test.js"    "build": "tsc",  },scripts 對象中每一個屬性，對應一段腳本。比如，test 命令對應的腳本是 node test.js。
  • 你不知道的 Npm(Node.js 進階必備好文)
    "scripts": {    "test": "test.js"    "build": "tsc",  },scripts 對象中每一個屬性，對應一段腳本。比如，test 命令對應的腳本是 node test.js。