cmd

package
v0.0.0-...-7fde39e Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2015 License: MIT Imports: 25 Imported by: 0

Documentation

Overview

Package cmd provides re-usable commands for Glide.

Index

Constants

View Source 
const (
	Blue   = "0;34"
	Red    = "0;31"
	Green  = "0;32"
	Yellow = "0;33"
	Cyan   = "0;36"
	Pink   = "1;35"
)

These contanstants map to color codes for shell scripts making them human readable.

Variables

View Source 
var IsDebugging = false
View Source 
var Quiet = false

Quiet, when set to true, can suppress Info and Debug messages.

Functions

func About 

func About(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

About information for the CLI

func AddDependencies 

func AddDependencies(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

AddDependencies adds a list of *Dependency objects to the given *Config.

This is used to merge in packages from other sources or config files.

func BeQuiet 

func BeQuiet(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

BeQuiet supresses Info and Debug messages.

func Color 

func Color(code, msg string) string

Color returns a string in a certain color. The first argument is a string containing the color code or a constant from the table above mapped to a code.

The following will print the string "Foo" in yellow: 

fmt.Print(Color(Yellow, "Foo"))

func CowardMode 

func CowardMode(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

CowardMode checks that the environment is setup before continuing on. If not setup and error is returned.

func Debug 

func Debug(msg string, args ...interface{})

Debug logs debug information

func DeleteUnusedPackages 

func DeleteUnusedPackages(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

DeleteUnusedPackages removes packages from vendor/ that are no longer used.

func DropToShell 

func DropToShell(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

DropToShell executes a glide plugin. A command that's implemented by another application is executed in a similar manner to the way git commands work. For example, 'glide foo' would try to execute the application glide-foo. Params:

  • command: the name of the command to attempt executing.

func ErrMsg 

func ErrMsg(msg string, args ...interface{})

ErrMsg sends a message to Stderr

func Error 

func Error(msg string, args ...interface{})

Error logs and error.

func ExecCmd 

func ExecCmd(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

ExecCmd executes a system command inside vendor

func Flatten 

func Flatten(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

Flatten recurses through all dependent packages and flattens to a top level.

Flattening involves determining a tree's dependencies and flattening them into a single large list.

Params:

  • packages ([]string): The packages to read. If this is empty, it reads all packages.
  • force (bool): force vcs updates.
  • conf (*Config): The configuration.

Returns:

func GPMGodeps 

func GPMGodeps(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

GPMGodeps parses a GPM-flavored Godeps file.

Params

  • dir (string): Directory root.

Returns an []*Dependency

func GPMGodepsGit 

func GPMGodepsGit(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

GPMGodepsGit reads a Godeps-Git file for gpm-git.

func GbManifest 

func GbManifest(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

GbManifest

Params:

  • dir (string): The directory where the manifest file is located.

Returns:

func GetAll 

func GetAll(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

GetAll gets zero or more repos.

This takes a package name, normalizes it, finds the repo, and installs it. It's the workhorse behind `glide get`.

Params:

  • packages ([]string): Package names to get.
  • verbose (bool): default false

Returns:

  • []*Dependency: A list of constructed dependencies.

func GetImports 

func GetImports(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

GetImports iterates over the imported packages and gets them.

func Gopath 

func Gopath() string

Gopath gets GOPATH from environment and return the most relevant path.

A GOPATH can contain a colon-separated list of paths. This retrieves the GOPATH and returns only the FIRST ("most relevant") path.

This should be used carefully. If, for example, you are looking for a package, you may be better off using Gopaths.

func Gopaths 

func Gopaths() []string

Gopaths retrieves the Gopath as a list when there is more than one path listed in the Gopath.

func GuessDeps 

func GuessDeps(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

GuessDeps tries to get the dependencies for the current directory.

Params

  • dirname (string): Directory to use as the base. Default: "."

func HasGPMGodeps 

func HasGPMGodeps(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

HasGPMGodeps indicates whether a Godeps file exists.

func HasGbManifest 

func HasGbManifest(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

func HasGodepGodeps 

func HasGodepGodeps(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

HasGodepGodeps is a command to detect if a package contains a Godeps.json file.

func Info 

func Info(msg string, args ...interface{})

Info logs information

func InitGlide 

func InitGlide(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

InitGlide initializes a new Glide project.

Among other things, it creates a default glide.yaml.

Params:

  • filename (string): The name of the glide YAML file. Default is glide.yaml.
  • project (string): The name of the project. Default is 'main'.

func LinkPackage 

func LinkPackage(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

LinkPackage creates a symlink to the project within the GOPATH.

func ListDeps 

func ListDeps(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

ListDeps lists all of the dependencies of the current project.

Params:

Returns:

func MergeToYaml 

func MergeToYaml(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

MergeToYaml converts a Config object and a yaml.File to a single yaml.File.

Params:

  • conf (*Config): The configuration to merge.
  • overwriteImports (bool, default true): If this is true, old config will overwritten. If false, we attempt to merge the old and new config, with preference to the old.

Returns:

  • The root yaml.Node of the modified config.

Uses:

  • cxt.Get("yaml.File") as the source for the YAML file.

func Mkdir 

func Mkdir(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

Mkdir creates the src directory within the GOPATH.

func Msg 

func Msg(msg string, args ...interface{})

Msg prints a message with optional arguments, that can be printed, of varying types.

func NoVendor 

func NoVendor(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

NoVendor takes a path and returns all subpaths that are not vendor directories.

It is not recursive.

If the given path is a file, it returns that path unaltered.

If the given path is a directory, it scans all of the immediate children, and returns all of the go files and directories that are not vendor.

func NormalizeName 

func NormalizeName(name string) (string, string)

NormalizeName takes a package name and normalizes it to the top level package.

For example, golang.org/x/crypto/ssh becomes golang.org/x/crypto. 'ssh' is returned as extra data.

func ParseGodepGodeps 

func ParseGodepGodeps(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

ParseGodepGodeps parses the Godep Godeps.json file.

Params: - dir (string): the project's directory

Returns an []*Dependency

func ParseYaml 

func ParseYaml(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

ParseYaml parses the glide.yaml format and returns a Configuration object.

Params:

  • filename (string): YAML filename as a string

Context:

  • yaml.File: This puts the parsed YAML file into the context.

Returns:

  • *Config: The configuration.

func ParseYamlString 

func ParseYamlString(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

ParseYamlString parses a YAML string. This is similar but different to ParseYaml that parses an external file.

Params:

  • yaml (string): YAML as a string.

Returns:

  • *Config: The configuration.

func PathString 

func PathString(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

Take a list of paths and print a single string with space-separated paths.

func PrintName 

func PrintName(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

PrintName prints the name of the project.

This comes from Config.Name.

func ReadyToGlide 

func ReadyToGlide(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

ReadyToGlide fails if the environment is not sufficient for using glide.

Most importantly, it fails if glide.yaml is not present in the current working directory.

func Rebuild 

func Rebuild(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

Rebuild runs 'go build' in a directory.

Params:

  • conf: the *Config.

func SetReference 

func SetReference(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

SetReference is a command to set the VCS reference (commit id, tag, etc) for a project.

func Tree 

func Tree(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

Tree prints a tree representing dependencies.

func UpdateImports 

func UpdateImports(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

UpdateImports iterates over the imported packages and updates them.

Params:

  • force (bool): force packages to update (default false)
  • conf (*Config): The configuration
  • packages([]string): The packages to update. Default is all.

func UpdateReferences 

func UpdateReferences(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

UpdateReferences updates the revision numbers on all of the imports.

If a `packages` list is supplied, only the given base packages will be updated.

Params:

  • conf (*Config): Configuration
  • packages ([]string): A list of packages to update. Default is all packages.

func VcsExists 

func VcsExists(dep *Dependency, dest string) bool

VcsExists checks if the directory has a local VCS checkout.

func VcsGet 

func VcsGet(dep *Dependency, dest string) error

VcsGet figures out how to fetch a dependency, and then gets it.

VcsGet installs into the dest.

func VcsLastCommit 

func VcsLastCommit(dep *Dependency, vend string) (string, error)

VcsLastCommit gets the last commit ID from the given dependency.

func VcsUpdate 

func VcsUpdate(dep *Dependency, vend string, force bool) error

VcsUpdate updates to a particular checkout based on the VCS setting.

func VcsVersion 

func VcsVersion(dep *Dependency, vend string) error

VcsVersion set the VCS version for a checkout.

func VendorPath 

func VendorPath(c cookoo.Context) (string, error)

Return the path to the vendor directory.

func VendoredCleanUp 

func VendoredCleanUp(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

VendoredCleanUp is a command that cleans up vendored codebases after an update. If enabled (via update) it removed the VCS info from updated vendored packages. This should be a suffix to UpdateImports and VendoredSetup should be a prefix to UpdateImports.

func VendoredSetup 

func VendoredSetup(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

VendoredSetup is a command that does the setup for vendored directories. If enabled (via update) it marks vendored directories that are being updated and removed the old code. This should be a prefix to UpdateImports and VendoredCleanUp should be a suffix to UpdateImports.

func VersionGuard 

func VersionGuard(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

VersionGuard ensures that the Go version is correct.

func Warn 

func Warn(msg string, args ...interface{})

Warn logs a warning

func WriteYaml 

func WriteYaml(c cookoo.Context, p *cookoo.Params) (interface{}, cookoo.Interrupt)

WriteYaml writes a yaml.Node to the console as a string.

Params:

  • yaml.Node (yaml.Node): A yaml.Node to render.
  • out (io.Writer): An output stream to write to. Default is os.Stdout.
  • filename (string): If set, the file will be opened and the content will be written to it.

Types

type BuildCtxt 

type BuildCtxt struct {
	build.Context
}

BuildCtxt is a convenience wrapper for not having to import go/build anywhere else

func GetBuildContext 

func GetBuildContext() (*BuildCtxt, error)

GetBuildContext returns a build context from go/build. When the $GOROOT variable is not set in the users environment it sets the context's root path to the path returned by 'go env GOROOT'.

type Config 

type Config struct {
	Parent     *Config
	Name       string
	Imports    Dependencies
	DevImports Dependencies
	// InCommand is the default shell command run to start a 'glide in'
	// session.
	InCommand string
	Flatten   bool
}

Config is the top-level configuration object.

func FromYaml 

func FromYaml(top yaml.Node) (*Config, error)

FromYaml creates a *Config from a YAML node.

func (*Config) GetRoot 

func (c *Config) GetRoot() *Config

GetRoot follows the Parent down to the top node

func (*Config) HasDependency 

func (c *Config) HasDependency(name string) bool

HasDependency returns true if the given name is listed as an import or dev import.

func (*Config) HasRecursiveDependency 

func (c *Config) HasRecursiveDependency(name string) bool

HasRecursiveDependency returns true if this config or one of it's parents has this dependency

func (*Config) ToYaml 

func (c *Config) ToYaml() yaml.Node

ToYaml returns a yaml.Map containing the data from Config.

type Dependencies 

type Dependencies []*Dependency

Dependencies is a collection of Dependency

func (Dependencies) DeDupe 

func (d Dependencies) DeDupe() (Dependencies, error)

DeDupe cleans up duplicates on a list of dependencies.

func (Dependencies) Get 

func (d Dependencies) Get(name string) *Dependency

Get a dependency by name

type Dependency 

type Dependency struct {
	Name, Reference, Repository string
	VcsType                     string
	Subpackages, Arch, Os       []string
	UpdateAsVendored            bool
	Flatten                     bool
	Flattened                   bool
}

Dependency describes a package that the present package depends upon.

func DependencyFromYaml 

func DependencyFromYaml(node yaml.Node) (*Dependency, error)

DependencyFromYaml creates a dependency from a yaml.Node.

func (*Dependency) GetRepo 

func (d *Dependency) GetRepo(dest string) (v.Repo, error)

GetRepo retrieves a Masterminds/vcs repo object configured for the root of the package being retrieved.

func (*Dependency) ToYaml 

func (d *Dependency) ToYaml() yaml.Node

ToYaml converts a *Dependency to a YAML Map node.

type GodepDependency 

type GodepDependency struct {
	ImportPath string
	Comment    string `json:",omitempty"` // Description of commit, if present.
	Rev        string // VCS-specific commit ID.
}

GodepDependency is a modified version of Godep's Dependency struct. It drops all of the unexported fields.

type Godeps 

type Godeps struct {
	ImportPath string
	GoVersion  string
	Packages   []string `json:",omitempty"` // Arguments to save, if any.
	Deps       []GodepDependency
	// contains filtered or unexported fields
}

The Godeps struct from Godep.

https://raw.githubusercontent.com/tools/godep/master/dep.go

We had to copy this because it's in the package main for Godep.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.