writer-function

Nixのwriter系関数

ファイルやスクリプトを生成するderivationを作るための関数群です。

無印とBinサフィックスの違い

多くのwriter関数には無印版とBinサフィックス版があります。

無印(writeShellScript等)

$outがファイルそのもの。 ${myScript}でバイナリパスを直接参照できる。

Bin(writeShellScriptBin等):

$out/bin/<name>にファイルを出力しmeta.mainProgramを設定する。

lib.getExe myPkgや${myPkg}/bin/<name>でパスを得る。 lib.getExeの使用を推奨します。

ファイルそのものではないので、 environment.systemPackagesやruntimeInputsに入れて$PATHに載せられます。

writeShellApplicationは名前にBinが付いていませんが$out/bin/<name>に出力するためBin系と同じ構造です。

trivial-builders (pkgs.*)

nixpkgs/pkgs/build-support/trivial-builders/default.nix に定義されています。

テキスト系

• writeTextFile: 全テキスト系writerの基盤関数
• writeText name text: テキストファイルを生成
• writeTextDir path text: ディレクトリ構造付きでテキストファイルを生成

汎用スクリプト系

• writeScript name text / writeScriptBin name text: 実行可能スクリプト、シバンは手動で記述する

シェルスクリプト系

• writeShellScript name text / writeShellScriptBin name text: シバン自動付与、構文チェックあり
• writeShellApplication: シェルスクリプト用の最高機能writer

その他

• writeCBin pname code: Cソースをコンパイルしてバイナリを生成
• concatTextFile: 複数ファイルを連結
• concatText name files: concatTextFileのラッパー
• concatScript name files: 実行可能な連結ファイルを生成
• writeClosure paths: ランタイム依存クロージャのパス一覧を書き出す
• writeDirectReferencesToFile path: 直接参照のパス一覧を書き出す
• writeStringReferencesToFile string: 文字列コンテキストの依存パスを書き出す

writers (pkgs.writers.*)

nixpkgs/pkgs/build-support/writers/scripts.nix 配下に定義されています。 各関数にBinサフィックス版があり、 $out/bin/に配置します。

基盤関数

• makeScriptWriter: インタープリタ言語用スクリプトの基盤
• makeBinWriter: コンパイル言語用バイナリの基盤

シェル系

• writeBash / writeBashBin
• writeDash / writeDashBin
• writeFish / writeFishBin
• writeNu / writeNuBin

スクリプト言語系

• writeBabashka / writeBabashkaBin
• writeGuile / writeGuileBin
• writeJS / writeJSBin
• writeLua / writeLuaBin
• writePerl / writePerlBin
• writePyPy2 / writePyPy2Bin
• writePyPy3 / writePyPy3Bin
• writePython3 / writePython3Bin
• writeRuby / writeRubyBin

コンパイル言語系

• writeFSharp / writeFSharpBin
• writeHaskell / writeHaskellBin
• writeNim / writeNimBin
• writeRust / writeRustBin

データ形式系

nixpkgs/pkgs/build-support/writers/data.nix に定義されています。

• writeJSON name data: Nixの値をJSONファイルとして書き出す
• writeTOML name data: Nixの値をTOMLファイルとして書き出す
• writeYAML name data: Nixの値をYAMLファイルとして書き出す

writeShellApplicationを優先する理由

シェルスクリプトを書く場合はwriteShellApplicationを優先的に使用します。

writeShellApplication {
  name = "my-script";
  runtimeInputs = with pkgs; [ curl jq ];
  text = ''
    response=$(curl -s "https://api.example.com/data")
    echo "$response" | jq '.items[]'
  '';
}

writeShellScript/writeShellScriptBinと比較した利点:

• set -o errexit, set -o nounset, set -o pipefailが自動適用されること。 いわゆるset -euo pipefailがデフォルトで有効になります。 bashOptionsで制御可能です。
• ビルド時にshellcheckが自動実行される
• runtimeInputsでPATH管理ができ、実行時依存が明示的になる
• runtimeEnvで環境変数を設定できる