state

package
v3.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 29, 2025 License: GPL-3.0 Imports: 7 Imported by: 0

Documentation

Overview

Package state defines the asbstracted state struct

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type State

type State struct {
	Config                   *config.Config
	Templates                *template.Template
	NodeMap                  map[nodepath.NodePath]node.Node
	UserAssetMap             map[assetpath.AssetPath]bool
	SkippedNodePathMap       map[nodepath.NodePath]bool
	NodegroupWithoutIndexMap map[nodepath.NodePath]bool
	NodePathLinksMap         map[nodepath.NodePath][]nodepathlink.NodePathLink
	InputDir                 string
	OutputDir                string
	ConfigFile               string
	NodePaths                []nodepath.NodePath
	NodeTags                 []tag.Tag
	ShowVersion              bool
	Debug                    bool
	DryRun                   bool
}

State struct centralises all computed values so we can pass it into child functions with ease.

* SkippedNodePathMap: map of NodePaths that shouldn't be rendered because its nodegroup is of Log listing type.

* NodegroupWithoutIndexMap: map of Nodegroups that don't have an index file

func Init

func Init() State

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL