pesde

jiwonz/pathfs

luau-path + @lune/fs

Yanked

lune-path-fs

luau-path + @lune/fs

Changes in v0.3.0 (breaking changes)

  • Moved fs into pathfs.fs. old:
local pathfs = require("./path/to/pathfs")

pathfs.writeFile("path")

new:

local pathfs = require("./path/to/pathfs")
local fs = pathfs.fs

fs.writeFile("path")
  • Removed pathfs.gt.
  • Added Directory utility class.
local dir = pathfs.Directory.new("new_dir") -- just represents a directory path.
dir:writeDir()
dir:removeDir()

local dir = pathfs.Directory.create("new_dir") -- writes a directory if there is no file/dir at this path already.

local dir = pathfs.Directory.fromExisting("new_dir") -- gets/creates a Directory object from existing directory path.
  • Added File utility class.
local file = pathfs.File.new("new_file") -- just represents a file path.
file:writeFile("hello")
file:removeFile()

local file = pathfs.File.create("new_dir", "initial contents") -- writes a file if there is no file/dir at this path already.

local file = pathfs.File.fromExisting("new_dir") -- gets/creates a File object from existing file path.

Note

This library is based on luau-path by seaofvoices

Features

  • Includes typed luau-path utility (now fully typed)
  • @lune/fs library but supports path objects (AsPath objects which include string and Path objects)
  • Does not require node & npm anymore (now dependency luau_path is published to pesde!)
  • Includes runtime type checkers via greentea.

Installation

Install via pesde

pesde add jiwonz/pathfs

Usage

pathfs.writeFile("something.json", "{ \"message\": \"Hello, world!\" }")

local path = pathfs.Path.from("something.json")

print(pathfs.readFile(path))