More `writeTextFile` Examples and Details on `writeText`, `writeTextDir`, `writeScript`, `writeScriptBin`, and `writeShellScript`

# Usage 2 of `writeTextFile` Write the string `Contents of File` to `/nix/store/<store path>`. See also the [](#trivial-builder-writeText) helper function. ```nix writeTextFile { name = "my-file"; text = '' Contents of File ''; } ``` ::: ::: {.example #ex3-writeTextFile} # Usage 3 of `writeTextFile` Write an executable script `my-script` to `/nix/store/<store path>/bin/my-script`. See also the [](#trivial-builder-writeScriptBin) helper function. ```nix writeTextFile { name = "my-script"; text = '' echo "hi" ''; executable = true; destination = "/bin/my-script"; } ``` ::: ### `writeText` {#trivial-builder-writeText} Write a text file to the Nix store `writeText` takes the following arguments: a string. `name` (String) : The name used in the Nix store path. `text` (String) : The contents of the file. The store path will include the name, and it will be a file. ::: {.example #ex-writeText} # Usage of `writeText` Write the string `Contents of File` to `/nix/store/<store path>`: ```nix writeText "my-file" '' Contents of File '' ``` ::: This is equivalent to: ```nix writeTextFile { name = "my-file"; text = '' Contents of File ''; } ``` ### `writeTextDir` {#trivial-builder-writeTextDir} Write a text file within a subdirectory of the Nix store. `writeTextDir` takes the following arguments: `path` (String) : The destination within the Nix store path under which to create the file. `text` (String) : The contents of the file. The store path will be a directory. ::: {.example #ex-writeTextDir} # Usage of `writeTextDir` Write the string `Contents of File` to `/nix/store/<store path>/share/my-file`: ```nix writeTextDir "share/my-file" '' Contents of File '' ``` ::: This is equivalent to: ```nix writeTextFile { name = "my-file"; text = '' Contents of File ''; destination = "/share/my-file"; } ``` ### `writeScript` {#trivial-builder-writeScript} Write an executable script file to the Nix store. `writeScript` takes the following arguments: `name` (String) : The name used in the Nix store path. `text` (String) : The contents of the file. The created file is marked as executable. The store path will include the name, and it will be a file. ::: {.example #ex-writeScript} # Usage of `writeScript` Write the string `Contents of File` to `/nix/store/<store path>` and make the file executable. ```nix writeScript "my-file" '' Contents of File '' ``` This is equivalent to: ```nix writeTextFile { name = "my-file"; text = '' Contents of File ''; executable = true; } ``` ::: ### `writeScriptBin` {#trivial-builder-writeScriptBin} Write a script within a `bin` subdirectory of a directory in the Nix store. This is for consistency with the convention of software packages placing executables under `bin`. `writeScriptBin` takes the following arguments: `name` (String) : The name used in the Nix store path and within the file created under the store path. `text` (String) : The contents of the file. The created file is marked as executable. The file's contents will be put into `/nix/store/<store path>/bin/<name>`. The store path will include the name, and it will be a directory. ::: {.example #ex-writeScriptBin} # Usage of `writeScriptBin` ```nix writeScriptBin "my-script" '' echo "hi" '' ``` ::: This is equivalent to: ```nix writeTextFile { name = "my-script"; text = '' echo "hi" ''; executable = true; destination = "/bin/my-script"; } ``` ### `writeShellScript` {#trivial-builder-writeShellScript} Write a Bash script to the store. `writeShellScript` takes the following arguments: `name` (String) : The name used in the Nix store path. `text` (String) : The contents of the file. The created file is marked as executable. The store path will include the name, and it will be a file. This function is almost exactly like [](#trivial-builder-writeScript), except that it prepends to the file a [shebang](https://en.wikipedia.org/wiki/Shebang_%28Unix%29) line that points to the version of Bash used in Nixpkgs.

This section expands on `writeTextFile` with more examples, then introduces several convenience functions. `writeText` simplifies writing text files, `writeTextDir` writes to a subdirectory, `writeScript` creates executable scripts, `writeScriptBin` creates executable scripts within a 'bin' subdirectory, and `writeShellScript` creates Bash scripts with a shebang line pointing to the Nixpkgs Bash version. Each function is accompanied by an example and its equivalent using `writeTextFile`.