hugo

Documentation

Index

• Constants
• Variables
• func BuildVersionString() string
• func CompareVersion(version any) int
• func Deprecate(item, alternative string, version string)
• func DeprecateLevel(item, alternative, version string, level logg.Level)
• func GetDependencyList() []string
• func GetDependencyListNonGo() []string
• func GetExecEnviron(workDir string, cfg config.AllProvider, fs afero.Fs) []string
• func GoMinorVersion() int
• func IsDartSassV2() bool
• func IsRunningAsTest() bool
• type ConfigProvider
• type Dependency
• type HugoInfo
  • func NewInfo(conf ConfigProvider, deps []*Dependency) HugoInfo
  • func (i HugoInfo) Deps() []*Dependency
  • func (i HugoInfo) Generator() template.HTML
  • func (i HugoInfo) IsDevelopment() bool
  • func (i HugoInfo) IsExtended() bool
  • func (i HugoInfo) IsProduction() bool
  • func (i HugoInfo) IsServer() bool
  • func (i HugoInfo) Version() VersionString
  • func (i HugoInfo) WorkingDir() string
• type Version
  • func MustParseVersion(s string) Version
  • func ParseVersion(s string) (Version, error)
  • func (h Version) Compare(other any) int
  • func (v Version) Next() Version
  • func (v Version) NextPatchLevel(level int) Version
  • func (v Version) Prev() Version
  • func (v Version) ReleaseVersion() Version
  • func (v Version) String() string
  • func (v Version) Version() VersionString
• type VersionString
  • func (h VersionString) Compare(other any) int
  • func (h VersionString) Eq(other any) bool
  • func (h VersionString) String() string
  • func (h VersionString) Version() Version

Constants

const (
	EnvironmentDevelopment = "development"
	EnvironmentProduction  = "production"
)

Variables

var CurrentVersion = Version{
	Major:      0,
	Minor:      123,
	PatchLevel: 5,
	Suffix:     "",
}

CurrentVersion represents the current build version. This should be the only one.

var DartSassBinaryName string

DartSassBinaryName is the name of the Dart Sass binary to use. TODO(beop) find a better place for this.

var IsExtended = false

Functions

func BuildVersionString

func BuildVersionString() string

BuildVersionString creates a version string. This is what you see when running "hugo version".

func CompareVersion

func CompareVersion(version any) int

CompareVersion compares the given version string or number against the running Hugo version. It returns -1 if the given version is less than, 0 if equal and 1 if greater than the running version.

func Deprecate

func Deprecate(item, alternative string, version string)

Deprecate informs about a deprecation starting at the given version.

A deprecation typically needs a simple change in the template, but doing so will make the template incompatible with older versions. Theme maintainers generally want 1. No warnings or errors in the console when building a Hugo site. 2. Their theme to work for at least the last few Hugo versions.

func DeprecateLevel

func DeprecateLevel(item, alternative, version string, level logg.Level)

DeprecateLevel informs about a deprecation logging at the given level.

func GetDependencyList

func GetDependencyList() []string

GetDependencyList returns a sorted dependency list on the format package="version". It includes both Go dependencies and (a manually maintained) list of C(++) dependencies.

func GetDependencyListNonGo

func GetDependencyListNonGo() []string

GetDependencyListNonGo returns a list of non-Go dependencies.

func GetExecEnviron

func GetExecEnviron(workDir string, cfg config.AllProvider, fs afero.Fs) []string

GetExecEnviron creates and gets the common os/exec environment used in the external programs we interact with via os/exec, e.g. postcss.

func GoMinorVersion

func GoMinorVersion() int

func IsDartSassV2

func IsDartSassV2() bool

func IsRunningAsTest

func IsRunningAsTest() bool

IsRunningAsTest reports whether we are running as a test.

Types

type ConfigProvider

type ConfigProvider interface {
	Environment() string
	Running() bool
	WorkingDir() string
}

ConfigProvider represents the config options that are relevant for HugoInfo.

type Dependency

type Dependency struct {
	// Returns the path to this module.
	// This will either be the module path, e.g. "github.com/gohugoio/myshortcodes",
	// or the path below your /theme folder, e.g. "mytheme".
	Path string

	// The module version.
	Version string

	// Whether this dependency is vendored.
	Vendor bool

	// Time version was created.
	Time time.Time

	// In the dependency tree, this is the first module that defines this module
	// as a dependency.
	Owner *Dependency

	// Replaced by this dependency.
	Replace *Dependency
}

Dependency is a single dependency, which can be either a Hugo Module or a local theme.

type HugoInfo

type HugoInfo struct {
	CommitHash string
	BuildDate  string

	// The build environment.
	// Defaults are "production" (hugo) and "development" (hugo server).
	// This can also be set by the user.
	// It can be any string, but it will be all lower case.
	Environment string

	// version of go that the Hugo binary was built with
	GoVersion string
	// contains filtered or unexported fields
}

HugoInfo contains information about the current Hugo environment

func NewInfo

func NewInfo(conf ConfigProvider, deps []*Dependency) HugoInfo

NewInfo creates a new Hugo Info object.

func (HugoInfo) Deps

func (i HugoInfo) Deps() []*Dependency

Deps gets a list of dependencies for this Hugo build.

func (HugoInfo) Generator

func (i HugoInfo) Generator() template.HTML

Generator a Hugo meta generator HTML tag.

func (HugoInfo) IsDevelopment

func (i HugoInfo) IsDevelopment() bool

IsDevelopment reports whether the current running environment is "development".

func (HugoInfo) IsExtended

func (i HugoInfo) IsExtended() bool

IsExtended reports whether the Hugo binary is the extended version.

func (HugoInfo) IsProduction

func (i HugoInfo) IsProduction() bool

IsProduction reports whether the current running environment is "production".

func (HugoInfo) IsServer

func (i HugoInfo) IsServer() bool

IsServer reports whether the built-in server is running.

func (HugoInfo) Version

func (i HugoInfo) Version() VersionString

Version returns the current version as a comparable version string.

func (HugoInfo) WorkingDir

func (i HugoInfo) WorkingDir() string

WorkingDir returns the project working directory.

type Version

type Version struct {
	Major int

	Minor int

	// Increment this for bug releases
	PatchLevel int

	// HugoVersionSuffix is the suffix used in the Hugo version string.
	// It will be blank for release versions.
	Suffix string
}

Version represents the Hugo build version.

func MustParseVersion

func MustParseVersion(s string) Version

MustParseVersion parses a version string and panics if any error occurs.

func ParseVersion

func ParseVersion(s string) (Version, error)

ParseVersion parses a version string.

func (Version) Compare

func (h Version) Compare(other any) int

Compare implements the compare.Comparer interface.

func (Version) Next

func (v Version) Next() Version

Next returns the next Hugo release version.

func (Version) NextPatchLevel

func (v Version) NextPatchLevel(level int) Version

NextPatchLevel returns the next patch/bugfix Hugo version. This will be a patch increment on the previous Hugo version.

func (Version) Prev

func (v Version) Prev() Version

Prev returns the previous Hugo release version.

func (Version) ReleaseVersion

func (v Version) ReleaseVersion() Version

ReleaseVersion represents the release version.

func (Version) String

func (v Version) String() string

func (Version) Version

func (v Version) Version() VersionString

Version returns the Hugo version.

type VersionString

type VersionString string

VersionString represents a Hugo version string.

func (VersionString) Compare

func (h VersionString) Compare(other any) int

Compare implements the compare.Comparer interface.

func (VersionString) Eq

func (h VersionString) Eq(other any) bool

Eq implements the compare.Eqer interface.

func (VersionString) String

func (h VersionString) String() string

func (VersionString) Version

func (h VersionString) Version() Version