goblhtml

README

gobl.html

Generate HTML files from GOBL documents.

Released under the Apache 2.0 LICENSE, Copyright 2024 Invopop Ltd..

Development

Generate Templates

GOBL HTML uses templ to define a set of components in Go. To generate the templates, run:

templ generate

During development, it can help massive to have hot reload to be able to make changes and see them quickly. There are two mechanisms we're currently using:

Air

Air is a great tool to auto reload potentially any project, but works great with Go. Install with:

go install github.com/cosmtrek/air@latest

The .toml is already configured and ready in this repository, so simply run:

air

Air is a bit more reliable at detecting file changes, especially for stylesheets. You'll always need to wait a few seconds before page reloads to give the system chance to recompile. A proxy is available with Air, but we didn't find it to be very reliable and was breaking with query parameters, it obvously also wouldn't work for PDF reloads.

Templ Watcher

Templ comes with a watch flag that can also be useful. It has the disadvantage however that it uses .txt files for comparisons and the generated code should not be uploaded to git directly. Start the process with:

templ generate --watch --cmd="go run ./cmd/gobl.html serve --pdf prince"

Before uploading changes to git, be sure to re-run the regular templ generate command, as the live version makes temporary modifications to files that need to be replaced.

Testing

Tests are currently pretty limited. To ensure the basics are covered, the contents of the examples directory are converted to HTML, pretty printed, and output to the examples/out directory. The tests will ensure the output is as expected. To update the output test data run:

go test ./... --update

Documentation

Overview

Package goblhtml provides a simple way to render HTML documents from GOBL envelopes.

Index

• func Render(ctx context.Context, env *gobl.Envelope, opts ...Option) ([]byte, error)
• type Option
  • func WithCalFormatter(date, dateTime string, loc *time.Location) Option
  • func WithEmbeddedStylesheets() Option
  • func WithLocale(locale i18n.Code) Option
  • func WithLogo(logo *org.Image) Option
  • func WithNotes(txt string) Option
  • func WithNumFormatter(nf num.Formatter) Option

Functions

func Render

func Render(ctx context.Context, env *gobl.Envelope, opts ...Option) ([]byte, error)

Render takes the GOBL envelope and attempts to render an HTML document from it.

Types

type Option

type Option func(*internal.Opts)

Option defines a configuration option to use for rendering.

func WithCalFormatter

func WithCalFormatter(date, dateTime string, loc *time.Location) Option

WithCalFormatter prepares simple date and datetime formatting.

func WithEmbeddedStylesheets

func WithEmbeddedStylesheets() Option

WithEmbeddedStylesheets indicates that the stylesheets should be embedded inside the HTML document as opposed to links.

func WithLocale

func WithLocale(locale i18n.Code) Option

WithLocale sets the locale to use for rendering.

func WithLogo

func WithLogo(logo *org.Image) Option

WithLogo overrides whatever logo was defined in the original envelope, if at all, using the provided logo according to the document type.

func WithNotes

func WithNotes(txt string) Option

WithNotes adds the provided string to the envelope notes.

func WithNumFormatter

func WithNumFormatter(nf num.Formatter) Option

WithNumFormatter defines a customer number formatter to use instead of that provided by default for the currency.