dependency

package

v0.4.0 Latest Latest Go to latest Published: Oct 10, 2023 License: AGPL-3.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/szkiba/k6x

Links

Open Source Insights

Documentation ¶

Overview ¶

Package dependency contains k6 dependency related types.

Index ¶

Variables
type Artifact
- func NewArtifact(name, version string) (*Artifact, error)
- func ParseArtifact(str string) (*Artifact, error)
type Artifacts
- func ParseArtifacts(str string) (Artifacts, error)
type Dependencies
- func FromScript(filename string, fs afero.Fs, extra Dependencies) (Dependencies, error)
- func ParseLooseArtifacts(str string) (Dependencies, error)
type Dependency
- func New(name, constraints string) (*Dependency, error)
- func ParseLooseArtifact(str string) (*Dependency, error)
type Module
- func NewModule(name, version, path string) (*Module, error)
- func (mod *Module) String() string
- func (mod *Module) Tag() string
type Modules

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrInvalidArtifact = errors.New("invalid artifact")

View Source

var (
	ErrInvalidConstraints = errors.New("invalid constraints")
)

View Source

var (
	ErrScript = errors.New("script error")
)

Functions ¶

This section is empty.

Types ¶

type Artifact ¶ added in v0.4.0

type Artifact struct {
	Name    string          `json:"name,omitempty"`
	Version *semver.Version `json:"version,omitempty"`
}

func NewArtifact ¶ added in v0.4.0

func NewArtifact(name, version string) (*Artifact, error)

func ParseArtifact ¶ added in v0.4.0

func ParseArtifact(str string) (*Artifact, error)

func (*Artifact) MarshalText ¶ added in v0.4.0

func (art *Artifact) MarshalText() ([]byte, error)

func (*Artifact) String ¶ added in v0.4.0

func (art *Artifact) String() string

func (*Artifact) ToDependency ¶ added in v0.4.0

func (art *Artifact) ToDependency() *Dependency

func (*Artifact) UnmarshalText ¶ added in v0.4.0

func (art *Artifact) UnmarshalText(text []byte) error

type Artifacts ¶ added in v0.4.0

type Artifacts map[string]*Artifact

func ParseArtifacts ¶ added in v0.4.0

func ParseArtifacts(str string) (Artifacts, error)

func (Artifacts) K6 ¶ added in v0.4.0

func (arts Artifacts) K6() (*Artifact, bool)

func (Artifacts) MarshalText ¶ added in v0.4.0

func (arts Artifacts) MarshalText() ([]byte, error)

func (Artifacts) Sorted ¶ added in v0.4.0

func (arts Artifacts) Sorted() []*Artifact

func (Artifacts) String ¶ added in v0.4.0

func (arts Artifacts) String() string

func (Artifacts) ToDependencies ¶ added in v0.4.0

func (arts Artifacts) ToDependencies() Dependencies

func (Artifacts) UnmarshalText ¶ added in v0.4.0

func (arts Artifacts) UnmarshalText(text []byte) error

type Dependencies ¶

type Dependencies map[string]*Dependency

func FromScript ¶

func FromScript(filename string, fs afero.Fs, extra Dependencies) (Dependencies, error)

func ParseLooseArtifacts ¶ added in v0.4.0

func ParseLooseArtifacts(str string) (Dependencies, error)

func (Dependencies) Extensions ¶

func (deps Dependencies) Extensions() []*Dependency

func (Dependencies) K6 ¶

func (deps Dependencies) K6() (*Dependency, bool)

func (Dependencies) MarshalJSON ¶

func (deps Dependencies) MarshalJSON() ([]byte, error)

func (Dependencies) Sorted ¶ added in v0.4.0

func (deps Dependencies) Sorted() []*Dependency

func (Dependencies) String ¶

func (deps Dependencies) String() string

type Dependency ¶

type Dependency struct {
	Name        string              `json:"name,omitempty"`
	Constraints *semver.Constraints `json:"constraints,omitempty"`
}

func New ¶

func New(name, constraints string) (*Dependency, error)

func ParseLooseArtifact ¶ added in v0.4.0

func ParseLooseArtifact(str string) (*Dependency, error)

func (*Dependency) Check ¶

func (dep *Dependency) Check(version *semver.Version) bool

func (*Dependency) GetConstraints ¶ added in v0.4.0

func (dep *Dependency) GetConstraints() *semver.Constraints

func (*Dependency) String ¶

func (dep *Dependency) String() string

type Module ¶ added in v0.4.0

type Module struct {
	*Artifact
	Path string `json:"path,omitempty"`
}

func NewModule ¶ added in v0.4.0

func NewModule(name, version, path string) (*Module, error)

func (*Module) String ¶ added in v0.4.0

func (mod *Module) String() string

func (*Module) Tag ¶ added in v0.4.0

func (mod *Module) Tag() string

type Modules ¶ added in v0.4.0

type Modules map[string]*Module

func (Modules) Extensions ¶ added in v0.4.0

func (mods Modules) Extensions() []*Module

func (Modules) Filter ¶ added in v0.4.0

func (mods Modules) Filter(deps Dependencies) Modules

func (Modules) K6 ¶ added in v0.4.0

func (mods Modules) K6() (*Module, bool)

func (Modules) MarshalJSON ¶ added in v0.4.0

func (mods Modules) MarshalJSON() ([]byte, error)

func (Modules) Resolves ¶ added in v0.4.0

func (mods Modules) Resolves(deps Dependencies) bool

func (Modules) Sorted ¶ added in v0.4.0

func (mods Modules) Sorted() []*Module

func (Modules) String ¶ added in v0.4.0

func (mods Modules) String() string

func (Modules) ToArtifacts ¶ added in v0.4.0

func (mods Modules) ToArtifacts() Artifacts

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL