nut

README

nut

Nut is a tool to manage versioned Go source code packages, called "nuts".

• gonuts.io – central repository (source code)
• Documents
• Stable API
• Mailing List
• Issues
• Contributing
• License

Install it with go get:

go get -u github.com/AlekSi/nut/...
touch ~/.nut.json
nut help

Documentation

Overview

Package nut provides API for managing versioned Go source code packages, called "nuts".

Index

• Constants
• Variables
• func CheckPackage(pack *build.Package) (errors []string)
• type Nut
  • func (nut *Nut) Check() (errors []string)
  • func (nut *Nut) FileName() string
  • func (nut *Nut) FilePath(prefix string) string
  • func (nut *Nut) ImportPath(prefix string) string
  • func (nut *Nut) ReadFrom(dir string) (err error)
• type NutFile
  • func (nf *NutFile) ReadFile(fileName string) (err error)
  • func (nf *NutFile) ReadFrom(r io.Reader) (n int64, err error)
• type Person
• type Spec
  • func (spec *Spec) Check() (errors []string)
  • func (spec *Spec) ReadFile(fileName string) (err error)
  • func (spec *Spec) ReadFrom(r io.Reader) (n int64, err error)
  • func (spec *Spec) WriteTo(w io.Writer) (n int64, err error)
• type Version
  • func NewVersion(version string) (v *Version, err error)
  • func (left *Version) Less(right *Version) bool
  • func (v *Version) MarshalJSON() ([]byte, error)
  • func (v Version) String() string
  • func (v *Version) UnmarshalJSON(b []byte) error

Constants

const (
	ExampleFullName = "Crazy Nutter"
	ExampleEmail    = "crazy.nutter@gonuts.io"
	SpecFileName    = "nut.json"
)

Variables

var VendorRegexp = regexp.MustCompile(`^[0-9a-z][0-9a-z_-]*$`)

var VersionRegexp = regexp.MustCompile(`^(\d+).(\d+).(\d+)$`)

Current format for nut version.

Functions

func CheckPackage

func CheckPackage(pack *build.Package) (errors []string)

Check package for errors and return them.

Types

type Nut

type Nut struct {
	Spec
	build.Package
}

Describes nut – a Go package with associated meta-information. It embeds Spec and build.Package to provide easy access to properties: Nut.Name instead of Nut.Package.Name, Nut.Version instead of Nut.Spec.Version.

func (*Nut) Check

func (nut *Nut) Check() (errors []string)

Check nut for errors and return them. Calls Spec.Check() and CheckPackage().

func (*Nut) FileName

func (nut *Nut) FileName() string

Returns canonical filename in format <name>-<version>.nut

func (*Nut) FilePath

func (nut *Nut) FilePath(prefix string) string

Returns canonical filepath in format <prefix>/<vendor>/<name>-<version>.nut (with "\" instead of "/" on Windows).

func (*Nut) ImportPath

func (nut *Nut) ImportPath(prefix string) string

Returns canonical import path in format <prefix>/<vendor>/<name>

func (*Nut) ReadFrom

func (nut *Nut) ReadFrom(dir string) (err error)

Read nut from directory: package from <dir> and spec from <dir>/<SpecFileName>.

type NutFile

type NutFile struct {
	Nut
	Reader *zip.Reader
}

Describes .nut file (a ZIP archive).

func (*NutFile) ReadFile

func (nf *NutFile) ReadFile(fileName string) (err error)

Reads nut from specified file.

func (*NutFile) ReadFrom

func (nf *NutFile) ReadFrom(r io.Reader) (n int64, err error)

ReadFrom reads nut from r until EOF. The return value n is the number of bytes read. Any error except io.EOF encountered during the read is also returned. Implements io.ReaderFrom.

type Person

type Person struct {
	FullName string
	Email    string `json:",omitempty"`
}

Describes nut author.

type Spec

type Spec struct {
	Version    Version
	Vendor     string
	Authors    []Person
	ExtraFiles []string
	Homepage   string
}

Describes part of nut meta-information, stored in file nut.json.

func (*Spec) Check

func (spec *Spec) Check() (errors []string)

Checks spec for errors and return them.

func (*Spec) ReadFile

func (spec *Spec) ReadFile(fileName string) (err error)

Reads spec from specified file.

func (*Spec) ReadFrom

func (spec *Spec) ReadFrom(r io.Reader) (n int64, err error)

ReadFrom reads spec from r until EOF. The return value n is the number of bytes read. Any error except io.EOF encountered during the read is also returned. Implements io.ReaderFrom.

func (*Spec) WriteTo

func (spec *Spec) WriteTo(w io.Writer) (n int64, err error)

WriteTo writes spec to w. The return value n is the number of bytes written. Any error encountered during the write is also returned. Implements io.WriterTo.

type Version

type Version struct {
	Major int
	Minor int
	Patch int
}

Describes nut version. See http://gonuts.io/-/doc/versioning for explanation of version specification.

func NewVersion

func NewVersion(version string) (v *Version, err error)

Parse and set version.

func (*Version) Less

func (left *Version) Less(right *Version) bool

Returns true if left < right, false otherwise.

func (*Version) MarshalJSON

func (v *Version) MarshalJSON() ([]byte, error)

Marshal to JSON.

func (Version) String

func (v Version) String() string

Return version as string in current format.

func (*Version) UnmarshalJSON

func (v *Version) UnmarshalJSON(b []byte) error

Unmarshal from JSON.