deps

Documentation

Index

• type Dependency
  • func ExtractFromDirectory(dirPath string) ([]Dependency, error)
  • func ExtractFromSource(content []byte) []Dependency
  • func ParseDependency(pkgName string) Dependency
  • func (s Dependency) IsComplete() bool
  • func (s Dependency) IsPartial() bool
  • func (s Dependency) IsValid() bool
  • func (s Dependency) RelPath() string
  • func (s Dependency) String() string

Types

type Dependency

type Dependency struct {
	Namespace string
	Name      string
	Version   string
}

Dependency represents a parsed Typst package import.

func ExtractFromDirectory

func ExtractFromDirectory(dirPath string) ([]Dependency, error)

ExtractFromDirectory walks a local directory, scanning all .typ files for imports.

func ExtractFromSource

func ExtractFromSource(content []byte) []Dependency

ExtractFromSource scans a single .typ file's content for package imports.

func ParseDependency

func ParseDependency(pkgName string) Dependency

ParseDependency parses a package spec in the format @namespace/name:version Returns namespace, name, and version (version may be empty)

func (Dependency) IsComplete

func (s Dependency) IsComplete() bool

IsComplete reports whether s fully identifies one package version.

func (Dependency) IsPartial

func (s Dependency) IsPartial() bool

IsPartial reports whether s identifies a package without a pinned version.

func (Dependency) IsValid

func (s Dependency) IsValid() bool

IsValid reports whether s identifies at least a package (partial or complete).

func (Dependency) RelPath

func (s Dependency) RelPath() string

RelPath returns the file system path of the package relative to the cache dir. It returns an empty path unless s is complete.

func (Dependency) String

func (s Dependency) String() string

String returns the normalized string form of the package.