Module

jinks/build

src/jinks/build.pooka

Discover and render everything before writing a page. A broken template should not replace yesterday's readable work with half of today's work. An owned-file manifest and staged publication carry the previous site through write failures while removing only stale generated files.

API reference

class

Output

src/jinks/build.pooka:39
class Output(name: String, text: String)
field

name

src/jinks/build.pooka:39
name: String
INFERREDString
field

text

src/jinks/build.pooka:39
text: String
INFERREDString
constructor

new

src/jinks/build.pooka:39
INFERREDfn(String, String) -> jinks/build.Output
class

Asset

src/jinks/build.pooka:41
class Asset(name: String, source: String)
field

name

src/jinks/build.pooka:41
name: String
INFERREDString
field

source

src/jinks/build.pooka:41
source: String
INFERREDString
constructor

new

src/jinks/build.pooka:41
INFERREDfn(String, String) -> jinks/build.Asset
function

prepare

src/jinks/build.pooka:43
prepare(root: String) -> Result(#(config.Config, List(Output)), String)
INFERREDfn(String) -> Result(#(jinks/config.Config, List(jinks/build.Output)), String)
function

prepare_at

src/jinks/build.pooka:49
prepare_at(root: String, today: String) -> Result(
  #(config.Config, List(Output)),
  String
)
INFERREDfn(String, String) -> Result(#(jinks/config.Config, List(jinks/build.Output)), String)

The build observes one UTC publication day. Tests can supply that day without borrowing the wall clock or changing process-wide state.

function

prepare_selected

src/jinks/build.pooka:56
prepare_selected(selected: request.Request) -> Result(
  #(config.Config, List(Output)),
  String
)
INFERREDfn(jinks/request.Request) -> Result(#(jinks/config.Config, List(jinks/build.Output)), String)
function

prepare_request

src/jinks/build.pooka:63
prepare_request(selected: request.Request, today: String) -> Result(
  #(config.Config, List(Output)),
  String
)
INFERREDfn(jinks/request.Request, String) -> Result(#(jinks/config.Config, List(jinks/build.Output)), String)
function

prepare_timed

src/jinks/build.pooka:71
prepare_timed(selected: request.Request, clock: String) -> Result(
  #(config.Config, List(Output)),
  String
)
INFERREDfn(jinks/request.Request, String) -> Result(#(jinks/config.Config, List(jinks/build.Output)), String)
function

run

src/jinks/build.pooka:234
run(root: String) -> Result(Int, String)
INFERREDfn(String) -> Result(Int, String)
function

run_report

src/jinks/build.pooka:241
run_report(root: String) -> Result(#(config.Config, Int), String)
INFERREDfn(String) -> Result(#(jinks/config.Config, Int), String)

Return the settings used by this publication so a watcher never guesses the output directory from a second, potentially newer configuration read.

function

run_selected

src/jinks/build.pooka:245
run_selected(selected: request.Request) -> Result(#(config.Config, Int), String)
INFERREDfn(jinks/request.Request) -> Result(#(jinks/config.Config, Int), String)
function

assets

src/jinks/build.pooka:259
assets(root: String, settings: config.Config) -> Result(List(Asset), String)
INFERREDfn(String, jinks/config.Config) -> Result(List(jinks/build.Asset), String)

Site assets replace theme assets by relative path, preserving binary bytes.

function

asset_files

src/jinks/build.pooka:274
asset_files(root: String) -> Result(List(Asset), String)
INFERREDfn(String) -> Result(List(jinks/build.Asset), String)
function

fingerprint

src/jinks/build.pooka:285
fingerprint(bytes: BitArray, done: List(String)) -> String
INFERREDfn(BitArray, List(String)) -> String
function

check_selected

src/jinks/build.pooka:298
check_selected(selected: request.Request) -> Result(Nil, String)
INFERREDfn(jinks/request.Request) -> Result(Nil, String)