Bun でクロスプラットフォームなシェルスクリプト
Bun の `$` を使うと、クロスプラットフォームなシェルスクリプト（Bun Shell）を書くことができます。Bun Shell は macOS (zsh)、Linux (bash)、および Windows (cmd) と OS の違いを気にせずにシェルスクリプトを書ける、JavaScript オブジェクトとのやりとりが可能であることが特徴です。
Bun v1.0.24 で、クロスプラットフォームなシェルスクリプトを書くための機能（Bun Shell）が追加されました。
Bun Shell は現在開発中の機能です。
bun モジュールから $ を import して、タグ付きテンプレートリテラルとして使うことでシェルとして実行できる文字列を生成できます。
import { $ } from "bun";
await $`ls`;上記のコードを実行すると、以下のような標準出力が得られます。
$ bun run index.ts
bun.lockb
node_modules
README.md
package.json
tsconfig.json
index.tsBun Shell は macOS (zsh)、Linux (bash)、および Windows (cmd) と OS の違いを気にせずにシェルスクリプトを書くことができます。
出力を取得する
シェルの出力をテキストとして取得するには .text() メソッドを使います。この場合標準出力には何も出力されません。
import { $ } from "bun";
const text = await $`ls`.text();
// ファイルの数を数える
const count = text.split("\n").length;
console.log(count); // => 7lines() メソッドを使うと、出力を行ごとに分割したイテレータを取得できます。
import { $ } from "bun";
for await (const line of $`cat ./index.ts ./package.json`.lines()) {
console.log(line);
}json() メソッドを使うと、出力を JSON としてパースした結果を取得できます。
import { $ } from "bun";
const json = await $`cat ./package.json`.json();
console.log(json.devDependencies); // => {"@types/bun": "latest"}blob() メソッドを使うと、出力を Blob オブジェクトとして取得できます。
import { $ } from "bun";
const blob = await $`cat ./package.json`.blob();
console.log(blob); // => Blob { size: 123, type: "text/plain" }stdout, stderr, 終了コードを取得するには text(), lines(), json(), blob() といったメソッドを呼び出さずに単に返り値を参照します。
import { $ } from "bun";
const { stdout, stderr, exitCode } = await $`echo "Hello, world!"`;
console.log(stdout); // => Hello, world!
console.error(stderr); // => Buffer
console.log(exitCode); // => 0または run(), quiet() メソッドを使用しても stdout, stderr, 終了コードを取得できます。quiet() は標準出力を抑制して実行するメソッドです。
import { $ } from "bun";
const { stdout, stderr, exitCode } = await $`echo "Hello, world!"`.quiet(); // 標準出力には何も出力されないリダイレクト
Bun Shell では >, <, | を使用したリダイレクトをサポートしており、JavaScript オブジェクトとのやりとりが可能です。
> は標準出力を JavaScript オブジェクトにリダイレクトします。
import { $ } from "bun";
const buffer = Buffer.alloc(1024);
await $`echo "Hello, world!" > ${buffer}`;
console.log(buffer.toString()); // => Hello, world!\nリダイレクト先に Bun.file() を使うと、ファイルに書き込まれます。
import { file, $ } from "bun";
await $`echo "Hello, world!" > ${file("./hello.txt")}`;Hello, world!
< は JavaScript オブジェクトを標準入力にリダイレクトします。< では Buffer オブジェクトの他に Response オブジェクトを受け取ることもできます。
import { $ } from "bun";
const response = await fetch("https://example.com");
await $`cat < ${response}`; // => <!doctype html>...| オペレーターで JavaScript オブジェクトをパイプできます。
import { $ } from "bun";
const response = await fetch("https://jsonplaceholder.typicode.com/todos/1");
await $`cat < ${response} | jq .title`; // => delectus aut autem環境変数
bash と同じように環境変数を設定できます。
import { $ } from "bun";
await $`FOO=foo bun -e 'console.log(process.env.FOO)'`; // fooenv() メソッドを使って環境変数を設定することもできます。
import { $ } from "bun";
// グローバルで環境変数が設定される
$.env({ FOO: "foo" });
await $`echo $FOO`; // foo
// ローカルで環境変数が設定される
await $`echo $FOO`.env({ FOO: "bar" }); // fooセキュリティ
Bun Shell はデフォルトですべての文字列をエスケープします。これにより、シェルスクリプトのインジェクション攻撃を防ぐことができます。
import { $ } from "bun";
const name = `'; rm -rf /; echo '`;
await $`echo ${name}`; // => ; rm -rf /; echoエスケープを無効にしたい場合には、{ raw: 'str' } オブジェクトでラップします。
import { $ } from "bun";
const name = `$(foo) "bar"`;
await $`echo ${{ raw: name }}`;
// bun: command not found: foo
// bar$.escape() メソッドは Bun 内部で使われているエスケープ関数です。
import { $ } from "bun";
console.log($.escape(`$(foo) "bar"`)); // => "\$(foo) \"bar\""単純なシェルスクリプト
.bun.sh で終わるファイルを bun コマンドに渡すと、シェルスクリプトとして実行できます。
echo "Hello, world!"$ bun run hello.bun.sh
Hello, world!
