depsy

README

Installation • Usage example • CI Status • Contributing • License

depsy is simple Go package with minimal dependencies for parsing dependencies info in from go.mod files.

FAQ

Q: Why should I use depsy instead of using runtime/debug.ReadBuildInfo() for reading already embedded info?

A: First of all — size:

Binary	Size (in bytes)
Original binary	1819094
depsy + embedded go.mod	1861531 (+ 42,437)
runtime/debug	1891541 (+ 72,447)

Second reason — with debug package, you can't print only direct dependencies.

Installation

Make sure you have a working Go 1.22+ workspace (instructions), then:

go get github.com/essentialkaos/depsy

Usage example

package main

import (
  _ "embed"

  "fmt"

  "github.com/essentialkaos/depsy"
)

//go:embed go.mod
var modules []byte

func main() {
  deps := depsy.Extract(modules, false)

  for _, dep := range deps {
    fmt.Println(dep)
  }
}

CI Status

Branch	Status
master
develop

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0

Documentation

Index

• type Dependencies
  • func Extract(data []byte, withIndirect bool) Dependencies
• type Dependency
  • func (d Dependency) PrettyPath() string
  • func (d Dependency) String() string

Examples

• Extract

Types

type Dependencies

type Dependencies []Dependency

Dependencies is slice with dependencies info

func Extract

func Extract(data []byte, withIndirect bool) Dependencies

Extract extracts data from go.mod data

Example

data, err := os.ReadFile("go.mod")

if err != nil {
	panic(err.Error())
}

deps := Extract(data, true)

for _, dep := range deps {
	fmt.Println(dep)
}

type Dependency

type Dependency struct {
	Path    string
	Version string
	Extra   string
}

Dependency contains info about used module

func (Dependency) PrettyPath

func (d Dependency) PrettyPath() string

PrettyPath strips major version info from the path

func (Dependency) String

func (d Dependency) String() string

String returns string representation of dependency