pub

Documentation

Index

• Variables
• type Metadata
• type Package
  • func ParsePackage(r io.Reader) (*Package, error)
  • func ParsePubspecMetadata(r io.Reader) (*Package, error)

Variables

var (
	ErrMissingPubspecFile  = util.NewInvalidArgumentErrorf("Pubspec file is missing")
	ErrPubspecFileTooLarge = util.NewInvalidArgumentErrorf("Pubspec file is too large")
	ErrInvalidName         = util.NewInvalidArgumentErrorf("package name is invalid")
	ErrInvalidVersion      = util.NewInvalidArgumentErrorf("package version is invalid")
)

Types

type Metadata

type Metadata struct {
	Description      string `json:"description,omitempty"`
	ProjectURL       string `json:"project_url,omitempty"`
	RepositoryURL    string `json:"repository_url,omitempty"`
	DocumentationURL string `json:"documentation_url,omitempty"`
	Readme           string `json:"readme,omitempty"`
	Pubspec          any    `json:"pubspec"`
}

Metadata represents the metadata of a Pub package

type Package

type Package struct {
	Name     string
	Version  string
	Metadata *Metadata
}

Package represents a Pub package

func ParsePackage

func ParsePackage(r io.Reader) (*Package, error)

ParsePackage parses the Pub package file

func ParsePubspecMetadata

func ParsePubspecMetadata(r io.Reader) (*Package, error)

ParsePubspecMetadata parses a Pubspec file to retrieve the metadata of a Pub package