xtemplate

Jul 28, 2026

Changes in this version

+ var DefaultControllerType = "os"

+ func CheckLegacyTemplateKeys(data []byte) error

+ func ControllerTypeFromRaw(raw json.RawMessage) (string, error)

+ func RegisterController(name string, ctor func() ServerController)

+ func RegisterProvider(name string, ctor ProviderFactory)

+ func RegisteredControllerTypes() []string

+ type Closer interface

+ Close func() error

type Config

+ Controller ServerController

+ ControllerRaw json.RawMessage

+ TemplateFS afero.Fs

+ func (c *Config) MaterializeController(preferType string) (string, error)

+ func (c *Config) UnmarshalJSON(data []byte) error

+ type Duration time.Duration

+ func (d *Duration) UnmarshalJSON(data []byte) error

+ func (d *Duration) UnmarshalText(text []byte) error

+ func (d Duration) Duration() time.Duration

+ func (d Duration) MarshalJSON() ([]byte, error)

+ func (d Duration) MarshalText() ([]byte, error)

+ func (d Duration) String() string

+ type Finalizer interface

+ Finalize func(value any, err error) error

+ type Initializer interface

+ Init func(context.Context) error

type Instance

+ func (x *Instance) Close() error

type Option

+ func WithContext(ctx context.Context) Option

+ func WithController(s ServerController) Option

+ func WithMinify(minify bool) Option

+ func WithOnClose(fn func() error) Option

+ func WithTemplateDir(dir string) Option

+ type OsFsController struct

+ Path string

+ func (s *OsFsController) Init(_ context.Context, _ *slog.Logger) ([]Option, error)

+ func (s *OsFsController) Start(_ *Server) error

+ type Provider interface

+ FieldName func() string

+ Prototype func() any

+ Value func(w http.ResponseWriter, r *http.Request) (any, error)

+ type ProviderFactory func() Provider

type Server

+ func (server *Server) Context() context.Context

+ func (server *Server) Logger() *slog.Logger

+ func (server *Server) Shutdown(ctx context.Context) error

+ type ServerController interface

+ Init func(ctx context.Context, log *slog.Logger) (sticky []Option, err error)

+ Start func(server *Server) error

+ func NewController(name string) (ServerController, error)

+ func ResolveController(raw json.RawMessage) (ServerController, error)

Jul 12, 2026

Changes in this version

+ func Register(name string, ctor func() DotConfig)

type Config

+ Providers []DotConfig

+ ProvidersRaw []json.RawMessage

type InstanceStats

+ InitializationTemplates int

type Server

+ func (x *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

Jun 23, 2026

Changes in this version

type Config

+ Precompress []string

Jun 22, 2026

Changes in this version

+ type MarkdownDoc struct

+ Body template.HTML

+ Meta map[string]any

Jun 19, 2026

Changes in this version

+ func AddMarkdownConfig(name string, md goldmark.Markdown)

+ func FuncWithArgs(dot any, args ...any) (any, error)

type Config

+ CrossOrigin CrossOriginConfig

+ Handlers []HandlerRoute

+ Reload <-chan []Option

+ func (config *Config) SetDefaults() *Config

+ type CrossOriginConfig struct

+ Disabled bool

+ InsecureBypassPatterns []string

+ TrustedOrigins []string

type Dir

+ func (d Dir) Chroot(path string) (Dir, error)

+ func (d Dir) ExistsDir(dirname string) bool

+ func (d Dir) ReadDir(path string) ([]fs.FileInfo, error)

type DotDirConfig

+ FS afero.Fs

+ Type string

+ type HandlerRoute struct

+ Handler http.Handler

+ Pattern string

type Option

+ func WithHandler(pattern string, h http.Handler) Option

Dec 27, 2024

Changes in this version

type Config

+ CustomProviders []DotConfig

+ Databases []DotDBConfig

+ Directories []DotDirConfig

+ Flags []DotFlagsConfig

+ Nats []DotNatsConfig

+ type Dir struct

+ func (d Dir) Dir(name string) (Dir, error)

+ func (d Dir) Exists(name string) bool

+ func (d Dir) List(name string) ([]fs.DirEntry, error)

+ func (d Dir) Open(name string) (fs.File, error)

+ func (d Dir) Read(name string) (string, error)

+ func (d Dir) Stat(name string) (fs.FileInfo, error)

type DotConfig

+ FieldName func() string

+ Init func(context.Context) error

+ Value func(Request) (any, error)

+ type DotDB struct

+ func (c *DotDB) Commit() (string, error)

+ func (c *DotDB) Exec(query string, params ...any) (result sql.Result, err error)

+ func (c *DotDB) QueryRow(query string, params ...any) (map[string]any, error)

+ func (c *DotDB) QueryRows(query string, params ...any) (rows []map[string]any, err error)

+ func (c *DotDB) QueryVal(query string, params ...any) (any, error)

+ func (c *DotDB) Rollback() (string, error)

+ type DotDBConfig struct

+ Connstr string

+ Driver string

+ MaxOpenConns int

+ Name string

+ func (d *DotDBConfig) FieldName() string

+ func (d *DotDBConfig) Init(ctx context.Context) error

+ func (d *DotDBConfig) Value(r Request) (any, error)

+ func (dp *DotDBConfig) Cleanup(v any, err error) error

+ type DotDirConfig struct

+ Name string

+ Path string

+ func (c *DotDirConfig) FieldName() string

+ func (p *DotDirConfig) Cleanup(a any, err error) error

+ func (p *DotDirConfig) Init(ctx context.Context) error

+ func (p *DotDirConfig) Value(r Request) (any, error)

+ type DotFlags struct

+ func (d DotFlags) Value(key string) string

+ type DotFlagsConfig struct

+ Name string

+ Values map[string]string

+ func (d *DotFlagsConfig) FieldName() string

+ func (d *DotFlagsConfig) Init(_ context.Context) error

+ func (d *DotFlagsConfig) Value(_ Request) (any, error)

+ type DotKV struct

+ func (d *DotKV) Delete(key string) error

+ func (d *DotKV) Get(key string) (string, error)

+ func (d *DotKV) Purge(key string) error

+ func (d *DotKV) Put(key, value string) error

+ func (d *DotKV) Watch(keys string) (<-chan jetstream.KeyValueEntry, error)

+ type DotNats struct

+ func (d *DotNats) Publish(subject, message string) error

+ func (d *DotNats) Request(subject, data string, timeout_ ...time.Duration) (*nats.Msg, error)

+ func (d *DotNats) Subscribe(subject string) (<-chan *nats.Msg, error)

+ type DotNatsConfig struct

+ Conn *nats.Conn

+ Name string

+ func (d *DotNatsConfig) FieldName() string

+ func (d *DotNatsConfig) Init(ctx context.Context) error

+ func (d *DotNatsConfig) Value(r Request) (any, error)

+ type NatsConfig struct

+ ConnOptions *nats.Options

+ InProcessServerOptions *server.Options

+ JetStreamOptions []jetstream.JetStreamOpt

type Option

+ func WithDir(name string, fs fs.FS) Option

+ func WithFlags(name string, flags map[string]string) Option

+ func WithNats(name string, serverOpts *server.Options, connOpts *nats.Options, ...) Option

Sep 30, 2024

Changes in this version

+ func FuncFailf(format string, args ...any) (string, error)

Apr 29, 2024

Changes in this version

type Config

+ func (c *Config) Options(options ...Option) (*Config, error)

type Server

+ func (x *Server) Stop()

Apr 6, 2024

Changes in this version

+ func GetLogger(ctx context.Context) *slog.Logger

+ func GetRequestId(ctx context.Context) string

type DotFlush

+ func (f *DotFlush) SendSSE(args ...string) error

+ type ErrorStatus int

+ func (e ErrorStatus) Error() string

+ type Option func(*Config) error

Mar 28, 2024

Changes in this version

+ func AddBlueMondayPolicy(name string, policy *bluemonday.Policy)

+ func AddMarkdownConifg(name string, md goldmark.Markdown)

+ func FuncHumanize(formatType, data string) (string, error)

+ func FuncIdx(idx int, arr any) any

+ func FuncKsuid() ksuid.KSUID

+ func FuncMarkdown(input string, configName ...string) (template.HTML, error)

+ func FuncReturn() (string, error)

+ func FuncSanitizeHtml(policyName string, html string) (template.HTML, error)

+ func FuncSplitFrontMatter(input string) (parsedMarkdownDoc, error)

+ func FuncTrustAttr(s string) template.HTMLAttr

+ func FuncTrustHtml(s string) template.HTML

+ func FuncTrustJS(s string) template.JS

+ func FuncTrustJSStr(s string) template.JSStr

+ func FuncTrustSrcSet(s string) template.Srcset

+ func FuncTry(fn any, args ...any) (*result, error)

+ func GetCtxLogger(r *http.Request) *slog.Logger

+ func RegisterDot(r RegisteredDotProvider)

+ type CleanupDotProvider interface

+ Cleanup func(any, error) error

type Config

+ Dot []DotConfig

+ LDelim string

+ Minify bool

+ RDelim string

+ TemplateExtension string

+ TemplatesDir string

+ TemplatesFS fs.FS

type ConfigOverride

+ func WithProvider(name string, p DotProvider) ConfigOverride

+ type DotConfig struct

+ Name string

+ Type string

+ func (d *DotConfig) MarshalJSON() ([]byte, error)

+ func (d *DotConfig) MarshalText() ([]byte, error)

+ func (d *DotConfig) UnmarshalJSON(b []byte) error

+ func (d *DotConfig) UnmarshalText(b []byte) error

+ type DotFlush struct

+ func (f *DotFlush) Flush() string

+ func (f *DotFlush) Repeat(max_ ...int) <-chan int

+ func (f *DotFlush) Sleep(ms int) (string, error)

+ func (f *DotFlush) WaitForServerStop() (string, error)

+ type DotProvider interface

+ Value func(Request) (any, error)

+ type DotReq struct

+ type DotResp struct

+ func (d *DotResp) ServeContent(path_ string, modtime time.Time, content string) (string, error)

+ func (h *DotResp) AddHeader(field, val string) string

+ func (h *DotResp) DelHeader(field string) string

+ func (h *DotResp) ReturnStatus(status int) (string, error)

+ func (h *DotResp) SetHeader(field, val string) string

+ func (h *DotResp) SetStatus(status int) string

+ type DotX struct

+ func (c DotX) Func(name string) any

+ func (c DotX) Template(name string, dot any) (template.HTML, error)

+ func (d DotX) StaticFileHash(urlpath string) (string, error)

type Instance

+ func (instance *Instance) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type RegisteredDotProvider interface

+ New func() DotProvider

+ Type func() string

+ type Request struct

+ R *http.Request

+ ServerCtx context.Context

+ W http.ResponseWriter

Mar 12, 2024

Changes in this version

+ var LoggerKey = reflect.TypeOf((*slog.Logger)(nil))

type Config

+ Ctx context.Context

+ func (config *Config) Defaults() *Config

+ func (config Config) Instance() (Instance, error)

+ func (config Config) Server() (Server, error)

+ type ConfigOverride func(*Config)

+ type Instance interface

+ Id func() int64

+ Routes func() []InstanceRoute

+ Stats func() InstanceStats

+ type InstanceRoute struct

+ Handler http.Handler

+ Pattern string

+ type InstanceStats struct

+ Routes int

+ StaticFiles int

+ StaticFilesAlternateEncodings int

+ TemplateDefinitions int

+ TemplateFiles int

+ TemplateInitializers int

+ type Server interface

+ Handler func() http.Handler

+ Instance func() Instance

+ Reload func() error

+ Serve func(listen_addr string) error

+ type TemplateConfig map[string]string

+ func (c *TemplateConfig) Set(arg string) error

+ func (c TemplateConfig) String() string

Mar 6, 2024

Changes in this version

+ func WithTemplateFS(fs fs.FS) override

type Config

+ func (config *Config) FillDefaults()

Mar 6, 2024

Changes in this version

type CancelHandler

+ Id func() int64

Feb 22, 2024

Changes in this version

+ var LevelDebug slog.Level = slog.LevelDebug

+ var LevelDebug1 slog.Level = slog.LevelDebug + 1

+ var LevelDebug2 slog.Level = slog.LevelDebug + 2

+ var LevelDebug3 slog.Level = slog.LevelDebug + 3

+ func WithContextFS(fs fs.FS) override

+ func WithDB(db *sql.DB) override

+ func WithFuncMaps(fm ...template.FuncMap) override

+ func WithLogger(logger *slog.Logger) override

type CancelHandler

+ func Build(config *Config) (CancelHandler, error)

+ type Config struct

+ Context struct{ ... }

+ Database struct{ ... }

+ FuncMaps []template.FuncMap

+ LogLevel int

+ Logger *slog.Logger

+ Template struct{ ... }

+ UserConfig UserConfig

+ func (c *Config) WithTemplateFS(fs fs.FS)

+ type UserConfig map[string]string

+ func (c *UserConfig) Set(arg string) error

+ func (c UserConfig) String() string

Feb 10, 2024

Changes in this version

+ func Main(userConfig ...*config)

+ type CancelHandler interface

+ Cancel func()

+ type Handler func(w http.ResponseWriter, r *http.Request, log *slog.Logger, server *xtemplate)

Oct 19, 2023

Changes in this version

+ func New() *config

Oct 14, 2023

Changes in this version

type TemplateContext

+ func (c *TemplateContext) SRI(path string) (string, error)

+ func (c *TemplateContext) ServeFile() (string, error)

Oct 13, 2023

Changes in this version

type TemplateContext

+ Headers WrappedHeader

+ func (c *TemplateContext) Status(status int) string

Oct 9, 2023

Changes in this version

+ type FuncHandlerError struct

+ func (fhe FuncHandlerError) Error() string

+ func (fhe FuncHandlerError) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type HandlerError interface

+ Error func() string

+ ServeHTTP func(w http.ResponseWriter, r *http.Request)

+ func NewHandlerError(name string, fn func(w http.ResponseWriter, r *http.Request)) HandlerError

+ type ReturnError struct

+ func (ReturnError) Error() string

+ type TemplateContext struct

+ Config map[string]string

+ Params pathmatcher.Params

+ Req *http.Request

+ RespHeader WrappedHeader

+ RespStatus func(int) string

+ func (c *TemplateContext) Cookie(name string) string

+ func (c *TemplateContext) Exec(query string, params ...any) (result sql.Result, err error)

+ func (c *TemplateContext) FileExists(filename string) (bool, error)

+ func (c *TemplateContext) Funcs() template.FuncMap

+ func (c *TemplateContext) Host() (string, error)

+ func (c *TemplateContext) ListFiles(name string) ([]string, error)

+ func (c *TemplateContext) QueryRow(query string, params ...any) (map[string]any, error)

+ func (c *TemplateContext) QueryRows(query string, params ...any) (rows []map[string]any, err error)

+ func (c *TemplateContext) QueryStats() struct{ ... }

+ func (c *TemplateContext) QueryVal(query string, params ...any) (any, error)

+ func (c *TemplateContext) ReadFile(filename string) (string, error)

+ func (c *TemplateContext) RemoteIP() string

+ func (c *TemplateContext) StatFile(filename string) (fs.FileInfo, error)

+ func (c *TemplateContext) Template(name string, context any) (string, error)

+ func (c *TemplateContext) WithVars(vars map[string]any) TemplateContextVars

+ type TemplateContextVars struct

+ Vars map[string]any

+ type WrappedHeader struct

+ func (h WrappedHeader) Add(field, val string) string

+ func (h WrappedHeader) Del(field string) string

+ func (h WrappedHeader) Set(field, val string) string

+ type XTemplate struct

+ Config map[string]string

+ ContextFS fs.FS

+ DB *sql.DB

+ Delims struct{ ... }

+ ExtraFuncs []template.FuncMap

+ Log *slog.Logger

+ TemplateFS fs.FS

+ func (t *XTemplate) Reload() error

+ func (t *XTemplate) ServeHTTP(w http.ResponseWriter, r *http.Request)