types

package
v0.0.0-...-a89fe16 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 6, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Dependencies

type Dependencies []Dependency

func (Dependencies) Len

func (deps Dependencies) Len() int

func (Dependencies) Less

func (deps Dependencies) Less(i, j int) bool

func (Dependencies) Swap

func (deps Dependencies) Swap(i, j int)

type Dependency

type Dependency struct {
	ID        string
	DependsOn []string
}

type ExternalRef

type ExternalRef struct {
	Type RefType
	URL  string
}

type Identifier

type Identifier struct {
	UID string `json:"uid,omitempty"`
}

Identifier uniquely identifies a package

type LangType

type LangType string

LangType represents the type of package/language

const (
	Conan      LangType = "conan"
	DotNetCore LangType = "dotnet-core"
	GoModule   LangType = "go-module"
	GoBinary   LangType = "go-binary"
	Jar        LangType = "jar"
	Pom        LangType = "pom"
	Gradle     LangType = "gradle"
	Sbt        LangType = "sbt"
	Conda      LangType = "conda"
	RustBinary LangType = "rust-binary"
	Cargo      LangType = "cargo"
	Swift      LangType = "swift"
	Cocoapods  LangType = "cocoapods"
	Pub        LangType = "pub"
	Hex        LangType = "hex"
	NodePkg    LangType = "node-pkg"
	Pnpm       LangType = "pnpm"
	Yarn       LangType = "yarn"
	NuGet      LangType = "nuget"
	Composer   LangType = "composer"
	Poetry     LangType = "poetry"
	PyLock     LangType = "pylock"
	Bun        LangType = "bun"
	Uv         LangType = "uv"
	Bundler    LangType = "bundler"
	Npm        LangType = "npm"
	Pip        LangType = "pip"
)

type Libraries

type Libraries []Library

func (Libraries) Len

func (libs Libraries) Len() int

func (Libraries) Less

func (libs Libraries) Less(i, j int) bool

func (Libraries) Swap

func (libs Libraries) Swap(i, j int)

type Library

type Library struct {
	ID                 string `json:",omitempty"`
	Name               string
	Version            string
	Dev                bool
	Indirect           bool          `json:",omitempty"`
	License            string        `json:",omitempty"`
	ExternalReferences []ExternalRef `json:",omitempty"`
	Locations          Locations     `json:",omitempty"`
	FilePath           string        `json:",omitempty"` // Required to show nested jars
}

type Location

type Location struct {
	StartLine int `json:",omitempty"`
	EndLine   int `json:",omitempty"`
}

Location in lock file

type Locations

type Locations []Location

func (Locations) Len

func (locs Locations) Len() int

func (Locations) Less

func (locs Locations) Less(i, j int) bool

func (Locations) Swap

func (locs Locations) Swap(i, j int)

type Package

type Package struct {
	ID                 string        `json:",omitempty"`
	Name               string        `json:",omitempty"`
	Version            string        `json:",omitempty"`
	LangType           LangType      `json:",omitempty"`
	Locations          Locations     `json:",omitempty"`
	Relationship       Relationship  `json:",omitempty"`
	DependsOn          []string      `json:",omitempty"`
	ExternalReferences []ExternalRef `json:",omitempty"`
	Licenses           []string      `json:",omitempty"`
	Dev                bool          `json:",omitempty"`
	Indirect           bool          `json:",omitempty"`
	Identifier         Identifier    `json:",omitempty"`
	Module             bool          `json:",omitempty"`
	FilePath           string        `json:",omitempty"`
}

Package represents a dependency package

type Packages

type Packages []Package

Packages is a slice of Package

func (Packages) Len

func (pkgs Packages) Len() int

func (Packages) Less

func (pkgs Packages) Less(i, j int) bool

func (Packages) Swap

func (pkgs Packages) Swap(i, j int)

type Parser

type Parser interface {
	// Parse parses the dependency file
	Parse(r xio.ReadSeekerAt) ([]Library, []Dependency, error)
}

type RefType

type RefType string
const (
	RefWebsite      RefType = "website"
	RefLicense      RefType = "license"
	RefVCS          RefType = "vcs"
	RefIssueTracker RefType = "issue-tracker"
	RefOther        RefType = "other"
)

type Relationship

type Relationship string

Relationship represents the dependency relationship

const (
	RelationshipRoot      Relationship = "root"
	RelationshipDirect    Relationship = "direct"
	RelationshipIndirect  Relationship = "indirect"
	RelationshipUnknown   Relationship = "unknown"
	RelationshipWorkspace Relationship = "workspace"
)

type UserError

type UserError struct {
	Message string
}

UserError is an error that should be surfaced to the user as-is.

func (*UserError) Error

func (e *UserError) Error() string

Jump to

Keyboard shortcuts

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