simplifile

Simplifile provides synchronous operations for working with files and directories that work for all non-browser targets (Erlang, Node, Deno, and Bun).

When should I use `simplifile`?

Simplifile makes a simple tradeoff: it confines itself to a subset of purely synchronous file/directory utilities so that it can have one API for all targets. Erlang and JavaScript have fundamentally different concurrency models, so bindings to async code will simply be different for different targets.

You should use simplifile if

The same code running on JS and Erlang targets is important
Sync file operations will not be a major performance bottleneck (dev tooling, configuration, scripting, etc.)
You just wanna do some basic file operations and get on with life

If you think you need a different solutions, these projects may be helpful: File streams (erlang target)

Upgrading to 2.0

Please consult the changelog, but basically: The deprecated is_file, is_directory functions have been removed. The verify_is_file, verify_is_directory, and verify_is_symlink have had their verify_ prefixes removed (now is_file, is_directory, is_symlink respectively). The Unknown variant of FileError now has an inner String.

Example

let filepath = "./test/hello.txt"
let assert Ok(_) = "Hello, World" |> write(to: filepath)
let assert Ok(_) = "Goodbye, Mars" |> append(to: filepath)
let assert Ok("Hello, WorldGoodbye, Mars") = read(from: filepath)
let assert Ok(_) = delete(filepath)
let assert Error(_) = read(from: filepath)

Installation

If available on Hex this package can be added to your Gleam project:

gleam add simplifile

and its documentation can be found at https://hexdocs.pm/simplifile.

Contributing