fs

The fs module provides file system operations.

Import

import fs
import { read_file, write_file, exists } from fs

Reading Files

read_file

Read entire file as string:

@content = @fs#read_file("example.txt")

read_file_bytes

Read file as byte array:

@bytes = @fs#read_file_bytes("image.png")

read_lines

Read file as array of lines:

@lines = @fs#read_file_lines("data.csv")

read_file_lines_lazy

Lazily iterate over lines:

@lines = @fs#read_file_lines_lazy("huge_file.txt")
for @line in @lines
    process(@line)
fin for.

Writing Files

write_file

Write string to file (overwrites):

@fs#write_file("output.txt", "Hello, World!")

write_file_bytes

Write byte array to file:

@fs#write_file_bytes("data.bin", @bytes)

append_file

Append to file:

@fs#append_file("log.txt", "New entry\n")

write_lines

Write array of lines:

@lines = ["line 1", "line 2", "line 3"]
@fs#write_lines("output.txt", @lines)

File Information

exists

Check if path exists:

if @fs#exists("file.txt")
    write("File exists")
fin if.

is_file

Check if path is a file:

if @fs#is_file("file.txt")
    write("It's a file")
fin if.

is_directory

Check if path is a directory:

if @fs#is_directory("src")
    write("It's a directory")
fin if.

size

Get file size in bytes:

@bytes = @fs#size("file.txt")

modified_time

Get last modified time:

@time = @fs#modified_time("file.txt")

created_time

Get creation time:

@time = @fs#created_time("file.txt")

permissions

Get file permissions:

@perms = @fs#permissions("file.txt")

File Operations

copy

Copy a file:

@fs#copy("source.txt", "destination.txt")

move

Move/rename a file:

@fs#move("old_name.txt", "new_name.txt")

remove

Delete a file:

@fs#remove("file.txt")

rename

Rename a file:

@fs#rename("old.txt", "new.txt")

truncate

Truncate file to size:

@fs#truncate("file.txt", 1024)

Directory Operations

create_dir

Create a directory:

@fs#create_dir("new_directory")

create_dir_all

Create directory and all parents:

@fs#create_dir_all("path/to/nested/dir")

remove_dir

Remove empty directory:

@fs#remove_dir("empty_dir")

remove_dir_all

Remove directory and all contents:

@fs#remove_dir_all("dir_with_contents")

list_dir

List directory contents:

@entries = @fs#list_dir("src")
for @entry in @entries
    write(@entry)
fin for.

walk_dir

Recursively walk directory:

@files = @fs#walk_dir("src")
for @file in @files
    if @fs#is_file(@file)
        process(@file)
    fin if.
fin for.

current_dir

Get current working directory:

@cwd = @fs#current_dir()

set_current_dir

Change working directory:

@fs#set_current_dir("/tmp")

temp_dir

Get temporary directory:

@tmp = @fs#temp_dir()

Path Operations

join

Join path components:

@path = @fs#join("src", "main.draft")
@// "src/main.draft"

parent

Get parent directory:

@parent = @fs#parent("/home/user/file.txt")
@// "/home/user"

file_name

Get file name:

@name = @fs#file_name("/home/user/file.txt")
@// "file.txt"

file_stem

Get file name without extension:

@stem = @fs#file_stem("/home/user/file.txt")
@// "file"

extension

Get file extension:

@ext = @fs#extension("/home/user/file.txt")
@// ".txt"

is_absolute

Check if path is absolute:

@fs#is_absolute("/home/user")   @// true
@fs#is_absolute("relative/path") @// false

canonicalize

Resolve to absolute path:

@abs = @fs#canonicalize("./relative/path")

Permissions

set_permissions

Set file permissions:

@fs#set_permissions("file.txt", 0o644)

is_readable

Check if file is readable:

@fs#is_readable("file.txt")

is_writable

Check if file is writable:

@fs#is_writable("file.txt")

is_executable

Check if file is executable:

@fs#is_executable("script.sh")

File Watching

watch

Watch for file changes:

@watcher = @fs#watch(".")
for @event in @watcher
    write("File changed: " + @event#path)
fin for.

fs