Module

jinks/publish

src/jinks/publish.pooka

Put the next edition beside the old one before changing the sign outside. The manifest names only Jinks's files. Everything else is carried forward, and a newly generated path may not quietly claim an unowned file.

API reference

function

manifest

src/jinks/publish.pooka:18
manifest() -> String
INFERREDfn() -> String
function

validate

src/jinks/publish.pooka:24
validate(names: List(String)) -> Result(Nil, String)
INFERREDfn(List(String)) -> Result(Nil, String)

Validate names before touching staging, including case-folded collisions. This keeps an output built on Unix portable to a Windows checkout.

function

conflicts

src/jinks/publish.pooka:42
conflicts(left: String, right: String) -> Bool
INFERREDfn(String, String) -> Bool
function

decode

src/jinks/publish.pooka:57
decode(source: String) -> Result(List(String), String)
INFERREDfn(String) -> Result(List(String), String)

The on-disk format is versioned. A broken manifest never becomes permission to delete files; publication stops until the author can inspect it.

Pooka
assert publish.decode(publish.encode(["index.html"])) == Ok(["index.html"])
function

encode

src/jinks/publish.pooka:80
encode(names: List(String)) -> String
INFERREDfn(List(String)) -> String
function

owned

src/jinks/publish.pooka:89
owned(output: String) -> Result(List(String), String)
INFERREDfn(String) -> Result(List(String), String)
function

run

src/jinks/publish.pooka:101
run(
  root: String,
  output: String,
  pages: List(#(String, String)),
  assets: List(#(String, String))
) -> Result(Nil, String)
INFERREDfn(String, String, List(#(String, String)), List(#(String, String))) -> Result(Nil, String)

Build all files in a private sibling, then let the boundary exchange trees. Example ownership: deleting content/owl.md removes owl/index.html on the next build, while an unowned public/notes.txt survives unchanged.

function

copy

src/jinks/publish.pooka:144
copy(source: String, destination: String) -> Result(Nil, String)
INFERREDfn(String, String) -> Result(Nil, String)
function

clean

src/jinks/publish.pooka:158
clean(root: String, output: String) -> Result(Nil, String)
INFERREDfn(String, String) -> Result(Nil, String)

Cleaning is publication of an empty owned set. Unowned files and the versioned empty manifest remain; no source/cache directory is removed.