Docs: Modules

A module is a folder under the site's modules directory (default data/modules/) with a manifest, an entry script and optional templates and assets. Gansey loads every module at start, runs each on its own thread, and reloads a module when any of its files change, dropping the cached pages so the change shows on the next request; a broken save keeps the previous version running and shows the error in the admin.

data/modules/blog/
  module.toml        what it is and what it may touch
  main.gansey        entry script (Gansey Script)
  templates/*.html   rendered with ctx.render
  assets/            files the site serves for it (see Assets)
  tests/*.gansey     its tests (see Testing)

The blog module (gansey-module-blog) is the reference; every official module has its own repository, checked out in the workspace at ~/Code/gansey/modules/<id>. Install one with gansey mod add ../modules/blog, or create a starter with gansey mod new my-module (also available from Modules → Create). A module you write can be shared and installed without the hub: see Your own modules.

In this section

The manifestPermissions are enforced by core: a call outside them returns Err with a clear message, and a module that oversteps during init fails to load.Entry script and ctxinit(ctx) runs once per load and registers everything; the other functions are called later with plain values and return Ok(...) or Err.Data and filesA table holds JSON documents.Routes, forms and membersA path may name parameters, /shop/:slug, which the handler gets as req.params.slug; a trailing /* matches the rest as req.params["*"].Content, widgets and templatesWith content = "read" a module reads the site's structured content: ctx.content.types() (each with its fields, taxonomies and path), ctx.content.terms("categories"), and entries.Admin screensAn admin screen is HTML in a sandboxed frame styled like the admin.Jobs, hooks and eventsctx.jobs.every, ctx.jobs.cron (minute hour day month weekday, with *, lists, ranges, steps, mon–sun, jan–dec, @daily and the like) and ctx.jobs.daily("03:30") repeat work while the module runs; times are UTC.Gansey ScriptGansey Script is small on purpose.Testinggansey mod test <folder> loads the module (and the modules it requires, from folders beside it) and runs every fn test_…(ctx) in its tests/*.gansey files on the module's own thread, so a test can call the module's functi Publishing[signing].key_file in gansey.toml (or GANSEY_SIGNING_KEY) names a 32-byte ed25519 seed the site lends to modules with sign = true.