composer

Documentation

Index

• Constants
• Variables
• type Author
• type Comments
  • func (c *Comments) UnmarshalJSON(data []byte) error
• type Licenses
  • func (l *Licenses) UnmarshalJSON(data []byte) error
• type Metadata
• type Package
  • func ParseComposerFile(archive *zip.Reader, pathPrefix string, r io.Reader) (*Package, error)
  • func ParsePackage(r io.ReaderAt, size int64) (*Package, error)

Constants

const TypeProperty = "composer.type"

TypeProperty is the name of the property for Composer package types

Variables

var (
	// ErrMissingComposerFile indicates a missing composer.json file
	ErrMissingComposerFile = util.NewInvalidArgumentErrorf("composer.json file is missing")
	// ErrInvalidName indicates an invalid package name
	ErrInvalidName = util.NewInvalidArgumentErrorf("package name is invalid")
	// ErrInvalidVersion indicates an invalid package version
	ErrInvalidVersion = util.NewInvalidArgumentErrorf("package version is invalid")
)

Types

type Author

type Author struct {
	Name     string `json:"name,omitempty"`
	Email    string `json:"email,omitempty"`
	Homepage string `json:"homepage,omitempty"`
}

Author represents an author

type Comments

type Comments []string

Comments represents the comments of a Composer package

func (*Comments) UnmarshalJSON

func (c *Comments) UnmarshalJSON(data []byte) error

UnmarshalJSON reads from a string or array

type Licenses

type Licenses []string

Licenses represents the licenses of a Composer package

func (*Licenses) UnmarshalJSON

func (l *Licenses) UnmarshalJSON(data []byte) error

UnmarshalJSON reads from a string or array

type Metadata

type Metadata struct {
	Description string            `json:"description,omitempty"`
	Readme      string            `json:"readme,omitempty"`
	Keywords    []string          `json:"keywords,omitempty"`
	Comments    Comments          `json:"_comments,omitempty"`
	Homepage    string            `json:"homepage,omitempty"`
	License     Licenses          `json:"license,omitempty"`
	Authors     []Author          `json:"authors,omitempty"`
	Bin         []string          `json:"bin,omitempty"`
	Autoload    map[string]any    `json:"autoload,omitempty"`
	AutoloadDev map[string]any    `json:"autoload-dev,omitempty"`
	Extra       map[string]any    `json:"extra,omitempty"`
	Require     map[string]string `json:"require,omitempty"`
	RequireDev  map[string]string `json:"require-dev,omitempty"`
	Suggest     map[string]string `json:"suggest,omitempty"`
	Provide     map[string]string `json:"provide,omitempty"`
}

Metadata represents the metadata of a Composer package

type Package

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

Package represents a Composer package

func ParseComposerFile

func ParseComposerFile(archive *zip.Reader, pathPrefix string, r io.Reader) (*Package, error)

ParseComposerFile parses a composer.json file to retrieve the metadata of a Composer package

func ParsePackage

func ParsePackage(r io.ReaderAt, size int64) (*Package, error)

ParsePackage parses the metadata of a Composer package file