files

Documentation

Index

• Constants
• Variables
• func CompareVersions(a, b Version) int
• func ConfigurableUpdateToml(w io.Writer, p PackageInfo, data []byte, unmarshal Unmarshaler, indent bool) error
• func CopyFile(src, dst string) error
• func Exists(path string) bool
• func IsSemVer(s string) bool
• func UpdateTOML(w io.Writer, p PackageInfo, data []byte, indent bool) error
• type Manifest
• type PackageInfo
  • func ConfigureableUnmarshalToPackage(data []byte, unmarshal Unmarshaler) (PackageInfo, error)
  • func LoadPackageFromDirectory(directory string) (PackageInfo, error)
  • func NewPackageInfo() *PackageInfo
  • func UnmarshalToPackage(data []byte) (PackageInfo, error)
  • func (p *PackageInfo) Bump(increment string) error
  • func (p *PackageInfo) SetVersion(version string)
  • func (p *PackageInfo) ValidateVersion() bool
• type Unmarshaler
• type Version
  • func NewVersion() Version
  • func ParseVersion(s string) (Version, error)
  • func (v *Version) Bump(increment string) error
  • func (v Version) String() string

Constants

const (
	MAJOR string = "major"
	MINOR string = "minor"
	PATCH string = "patch"
)

Variables

var ErrInvalidIncrement = errors.New("invalid version incrementation, must be one of [major|minor|patch]")

var ErrInvalidManifest = errors.New("not a valid typst manifest")

var ErrInvalidVersion = errors.New("not a valid semantic version")

var ErrLoadingTypstToml = errors.New("could not load typst.toml")

Functions

func CompareVersions

func CompareVersions(a, b Version) int

Compare two version structs. Useful to sort arrays of Versions

func ConfigurableUpdateToml

func ConfigurableUpdateToml(w io.Writer, p PackageInfo, data []byte, unmarshal Unmarshaler, indent bool) error

Write the Packageinfo (name, version and entrypoint) to io.Writer

The Unmarshal Function can be configured (e.g. for testing Purposes)

func CopyFile

func CopyFile(src, dst string) error

Copy a file from src to dst

func Exists

func Exists(path string) bool

Check if a file or directory exists

func IsSemVer

func IsSemVer(s string) bool

Check if a given string is a valid semantic version (e.g. 0.1.0)

• No Letters, just positive Numbers
• 3 Components (Numbers) separated with '.'

func UpdateTOML

func UpdateTOML(w io.Writer, p PackageInfo, data []byte, indent bool) error

Update the Packageinfo (name, version and entrypoint)

Types

type Manifest

type Manifest struct {
	Package PackageInfo `toml:"package"`
}

type PackageInfo

type PackageInfo struct {
	// The Name of the Package
	Name string `toml:"name"`
	// The Version of the Package
	Version string `toml:"version"`
	// The Entrypoint of the Package
	Entrypoint string `toml:"entrypoint"`
}

Structure with the required Typst TOML fields

func ConfigureableUnmarshalToPackage

func ConfigureableUnmarshalToPackage(data []byte, unmarshal Unmarshaler) (PackageInfo, error)

Unmarshal a byte slice into a PackageInfo Struct

The Unmarshal Function can be configured (e.g. for testing Purposes)

func LoadPackageFromDirectory

func LoadPackageFromDirectory(directory string) (PackageInfo, error)

Load a typst Package from a directory. Returns an error if not existing.

func NewPackageInfo

func NewPackageInfo() *PackageInfo

Convenient Package Struct initializer for the tests

func UnmarshalToPackage

func UnmarshalToPackage(data []byte) (PackageInfo, error)

Unmarshal a byte slice into a PackageInfo Struct

func (*PackageInfo) Bump

func (p *PackageInfo) Bump(increment string) error

func (*PackageInfo) SetVersion

func (p *PackageInfo) SetVersion(version string)

func (*PackageInfo) ValidateVersion

func (p *PackageInfo) ValidateVersion() bool

type Unmarshaler

type Unmarshaler func([]byte, any) error

type Version

type Version struct {
	Major uint64
	Minor uint64
	Patch uint64
}

A Semantic Version struct, where only positive integers are allowed

func NewVersion

func NewVersion() Version

Create a new Version struct with all Fields set to Zero

func ParseVersion

func ParseVersion(s string) (Version, error)

Parse a string into a Version Struct

func (*Version) Bump

func (v *Version) Bump(increment string) error

Bump the Version by the given increment (major, minor, patch) Returns an ErrInvalidIncrement if the wrong increment is used.

func (Version) String

func (v Version) String() string