staticgen

Documentation

Overview

Package staticgen emits static HTML artifacts for build-time pages.

Index

• Constants
• type Artifact
• type AssetArtifact
• type BuildDiagnostic
• type BuildError
  • func (err *BuildError) Error() string
  • func (err *BuildError) Unwrap() error
• type BuildEvent
• type BuildEventLevel
• type BuildReport
• type CSSArtifact
• type MemoryResult
  • func BuildMemory(config gowdk.Config, app manifest.Manifest, outputDir string) (MemoryResult, error)
• type Result
  • func Build(config gowdk.Config, app manifest.Manifest, outputDir string) (Result, error)
  • func BuildIncremental(config gowdk.Config, app manifest.Manifest, outputDir string, ...) (Result, error)
• type SSRArtifact
  • func SSRArtifacts(config gowdk.Config, app manifest.Manifest, outputDir string) ([]SSRArtifact, error)
• type SSRReplacement

Constants

const DisableCSSDiscovery = "__gowdk_disable_css_discovery__"

Types

type Artifact

type Artifact struct {
	PageID string
	Route  string
	Path   string
}

type AssetArtifact

type AssetArtifact struct {
	Path string
}

type BuildDiagnostic

type BuildDiagnostic struct {
	Code          string              `json:"code"`
	ComponentName string              `json:"componentName,omitempty"`
	Source        string              `json:"source,omitempty"`
	Span          manifest.SourceSpan `json:"span,omitempty"`
	Message       string              `json:"message"`
}

BuildDiagnostic is a structured diagnostic produced during static planning or output generation after parser/compiler validation has already completed.

type BuildError

type BuildError struct {
	Err         error
	Report      BuildReport
	Diagnostics []BuildDiagnostic
}

func (*BuildError) Error

func (err *BuildError) Error() string

func (*BuildError) Unwrap

func (err *BuildError) Unwrap() error

type BuildEvent

type BuildEvent struct {
	Level   BuildEventLevel   `json:"level"`
	Stage   string            `json:"stage"`
	Kind    string            `json:"kind,omitempty"`
	Message string            `json:"message"`
	PageID  string            `json:"pageId,omitempty"`
	Route   string            `json:"route,omitempty"`
	Path    string            `json:"path,omitempty"`
	Data    map[string]string `json:"data,omitempty"`
}

type BuildEventLevel

type BuildEventLevel string

const (
	BuildEventDebug BuildEventLevel = "debug"
	BuildEventInfo  BuildEventLevel = "info"
	BuildEventError BuildEventLevel = "error"
)

type BuildReport

type BuildReport struct {
	Version   int          `json:"version"`
	Mode      string       `json:"mode"`
	OutputDir string       `json:"outputDir"`
	Events    []BuildEvent `json:"events"`
}

type CSSArtifact

type CSSArtifact struct {
	Path string
}

type MemoryResult

type MemoryResult struct {
	Result
	Files map[string][]byte
}

func BuildMemory

func BuildMemory(config gowdk.Config, app manifest.Manifest, outputDir string) (MemoryResult, error)

type Result

type Result struct {
	Artifacts         []Artifact
	CSSArtifacts      []CSSArtifact
	AssetArtifacts    []AssetArtifact
	RouteManifestPath string
	AssetManifestPath string
	BuildReportPath   string
	Report            BuildReport
}

func Build

func Build(config gowdk.Config, app manifest.Manifest, outputDir string) (Result, error)

func BuildIncremental

func BuildIncremental(config gowdk.Config, app manifest.Manifest, outputDir string, changedPageSources []string) (Result, error)

type SSRArtifact

type SSRArtifact struct {
	PageID       string
	Route        string
	HTML         string
	Replacements []SSRReplacement
}

func SSRArtifacts

func SSRArtifacts(config gowdk.Config, app manifest.Manifest, outputDir string) ([]SSRArtifact, error)

type SSRReplacement

type SSRReplacement struct {
	Param       string
	Placeholder string
}