charge/fs

Types

Extension

pub type Extension {
  MD
  MDX
  HTML
  JPG
  PNG
  JPEG
  WEBP
}

Constructors

```
MD
```
```
MDX
```
```
HTML
```
```
JPG
```
```
PNG
```
```
JPEG
```
```
WEBP
```

Path

opaque </>

An absolute path based on the filesystem root

pub opaque type Path

SitePath

opaque </>

An absolute path based on the site root

pub opaque type SitePath

Values

concat_site_path

</>

pub fn concat_site_path(a: SitePath, b: SitePath) -> SitePath

Just does a string concat of two site paths, dropping the leading slash of the second path

copy_site_dir

</>

pub fn copy_site_dir(
  out: Path,
  from: Path,
  to: SitePath,
) -> Result(Nil, error.ChargeError)

cwd

</>

pub fn cwd() -> Path

delete_dir

</>

pub fn delete_dir(dir: Path) -> Result(Nil, error.ChargeError)

delete_dir_if_exists

</>

pub fn delete_dir_if_exists(
  dir: Path,
) -> Result(Nil, error.ChargeError)

ensure_dir

</>

pub fn ensure_dir(path: Path) -> Result(Nil, error.ChargeError)

ensure_relative_dir

</>

pub fn ensure_relative_dir(
  rel: String,
) -> Result(Path, error.ChargeError)

ext

</>

pub fn ext(file: Path) -> Result(String, Nil)

file_name_only

</>

pub fn file_name_only(file: Path) -> String

from_cwd

</>

pub fn from_cwd(rel: String) -> Result(Path, error.ChargeError)

has_ext

</>

pub fn has_ext(file: Path, exts: List(Extension)) -> Bool

is_file

</>

pub fn is_file(path: Path) -> Bool

ls_dir

</>

pub fn ls_dir(at: Path) -> Result(List(Path), error.ChargeError)

parent

</>

pub fn parent(path: Path) -> Result(Path, error.ChargeError)

path_to_string

</>

pub fn path_to_string(p: Path) -> String

Converts a path to string within the current working directory. This should only be used for printing data and not for working with paths

read_text_file

</>

pub fn read_text_file(
  p: Path,
) -> Result(String, error.ChargeError)

resolve

</>

pub fn resolve(
  dir: Path,
  relative: String,
) -> Result(Path, error.ChargeError)

site_path_from_string

</>

pub fn site_path_from_string(
  site_path: String,
) -> Result(SitePath, error.ChargeError)

site_path_parts

</>

pub fn site_path_parts(path: SitePath) -> List(String)

site_path_starts_with

</>

pub fn site_path_starts_with(
  path: SitePath,
  prefix: SitePath,
) -> Bool

site_path_to_href

</>

pub fn site_path_to_href(p: SitePath) -> #(String, String)

site_path_to_path

</>

pub fn site_path_to_path(
  out_dir: Path,
  path: SitePath,
) -> Result(Path, error.ChargeError)

site_path_to_src

</>

pub fn site_path_to_src(p: SitePath) -> #(String, String)

site_path_to_string

</>

pub fn site_path_to_string(p: SitePath) -> String

to_abs_string

</>

pub fn to_abs_string(p: Path) -> String

Gets the absolute path as a string

to_site_path

</>

pub fn to_site_path(
  dir: Path,
  p: Path,
  replace_ext: dict.Dict(Extension, Extension),
) -> SitePath

write_site_file

</>

pub fn write_site_file(
  out_dir: Path,
  path: SitePath,
  content: String,
) -> Result(Nil, error.ChargeError)