tools

Documentation

Overview

Package tools provides helper functions used in scripts within the internal/tools module, as well as imports needed for a build with the "tools" build tag.

Index

• func PrintModFiles(w io.Writer, mFiles []*modfile.File) error
• type Repo
  • func FindRepoRoot() (Repo, error)
  • func (r Repo) FindModules() ([]*modfile.File, error)

Functions

func PrintModFiles

func PrintModFiles(w io.Writer, mFiles []*modfile.File) error

Types

type Repo

type Repo string

Repo represents a git repository.

func FindRepoRoot

func FindRepoRoot() (Repo, error)

FindRepoRoot retrieves the root of the repository containing the current working directory. Beginning at the current working directory (dir), the algorithm checks if joining the ".git" suffix, such as "dir.get", is a valid file. Otherwise, it will continue checking the dir's parent directory until it reaches the repo root or returns an error if it cannot be found.

func (Repo) FindModules

func (r Repo) FindModules() ([]*modfile.File, error)

FindModules returns all Go modules contained in Repo r.