travis, codecov, and docs

Author: bmatcuk

.travis.yml

@@ -0,0 +1,13 @@
+language: go
+
+go:
+  - "1.10"
+
+before_install:
+  - go get -t -v ./...
+
+script:
+  - go test -race -coverprofile=coverage.txt -covermode=atomic
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

README.md

@@ -1,2 +1,7 @@
+![Release](https://img.shields.io/github/release/bmatcuk/go-vagrant.svg?branch=master)
+[![Build Status](https://travis-ci.org/bmatcuk/go-vagrant.svg?branch=master)](https://travis-ci.org/bmatcuk/go-vagrant)
+[![codecov.io](https://img.shields.io/codecov/c/github/bmatcuk/go-vagrant.svg?branch=master)](https://codecov.io/github/bmatcuk/go-vagrant?branch=master)
+[![GoDoc](https://godoc.org/github.com/bmatcuk/go-vagrant?status.svg)](https://godoc.org/github.com/bmatcuk/go-vagrant)
+
 # go-vagrant
-A golang wrapper around Vagrant
+A golang wrapper around the Vagrant command-line utility.

base_command.go

@@ -8,6 +8,8 @@ import (
 	"sync"
 )
 
+// Base functionality and fields for all commands constructed from the
+// VagrantClient.
 type BaseCommand struct {
 	OutputParser
 

command_destroy.go

@@ -1,5 +1,6 @@
 package main
 
+// A DestroyCommand specifies the options and output of vagrant destroy.
 type DestroyCommand struct {
 	BaseCommand
 	DestroyResponse

command_halt.go

@@ -1,5 +1,6 @@
 package main
 
+// A HaltCommand specifies the options and output of vagrant halt.
 type HaltCommand struct {
 	BaseCommand
 	HaltResponse

command_port.go

@@ -1,12 +1,14 @@
 package main
 
+// PortCommand specifies the options and output of vagrant port.
 type PortCommand struct {
 	BaseCommand
 	PortResponse
 }
 
 // Run vagrant port. After setting options as appropriate, you must call Run()
-// or Start() followed by Wait() to execute. Errors will be recorded in Error.
+// or Start() followed by Wait() to execute. Output will be in ForwardedPorts
+// with any error in Error.
 func (client *VagrantClient) Port() *PortCommand {
 	return &PortCommand{
 		BaseCommand:  newBaseCommand(client),

command_provision.go

@@ -4,6 +4,7 @@ import (
 	"strings"
 )
 
+// ProvisionCommand specifies the options and output of vagrant provision
 type ProvisionCommand struct {
 	BaseCommand
 	ProvisionResponse

command_reload.go

@@ -4,6 +4,7 @@ import (
 	"strings"
 )
 
+// ReloadCommand specifies the options and output of vagrant reload
 type ReloadCommand struct {
 	BaseCommand
 	ReloadResponse

command_sshconfig.go

@@ -1,5 +1,6 @@
 package main
 
+// SSHConfigCommand specifies options and output from vagrant ssh-config
 type SSHConfigCommand struct {
 	BaseCommand
 	SSHConfigResponse
@@ -10,8 +11,8 @@ type SSHConfigCommand struct {
 }
 
 // Run vagrant ssh-config. After setting options as appropriate, you must call
-// Run() or Start() followed by Wait() to execute. Errors will be recorded in
-// Error.
+// Run() or Start() followed by Wait() to execute. Output will be in Configs
+// and any error will be in Error.
 func (client *VagrantClient) SSHConfig() *SSHConfigCommand {
 	return &SSHConfigCommand{
 		BaseCommand:       newBaseCommand(client),

command_status.go

@@ -1,13 +1,14 @@
 package main
 
+// StatusCommand specifies options and output from vagrant status
 type StatusCommand struct {
 	BaseCommand
 	StatusResponse
 }
 
 // Run vagrant status. After setting options as appropriate, you must call
-// Run() or Start() followed by Wait() to execute. Errors will be recorded in
-// Error.
+// Run() or Start() followed by Wait() to execute. Output will be in Status
+// and any error will be in Error.
 func (client *VagrantClient) Status() *StatusCommand {
 	return &StatusCommand{
 		BaseCommand:    newBaseCommand(client),

command_suspend.go

@@ -1,5 +1,6 @@
 package main
 
+// SuspendCommand specifies options and output from vagrant suspend
 type SuspendCommand struct {
 	BaseCommand
 	SuspendResponse

command_up.go

@@ -4,6 +4,7 @@ import (
 	"strings"
 )
 
+// UpCommand specifies options and output from vagrant up.
 type UpCommand struct {
 	BaseCommand
 	UpResponse

command_version.go

@@ -1,13 +1,14 @@
 package main
 
+// VersionCommand specifies options and output from vagrant version
 type VersionCommand struct {
 	BaseCommand
 	VersionResponse
 }
 
 // Run vagrant version. After setting options as appropriate, you must call
-// Run() or Start() followed by Wait() to execute. Errors will be recorded in
-// Error.
+// Run() or Start() followed by Wait() to execute. Output will be in
+// InstalledVersion and LatestVersion and any error will be in Error.
 func (client *VagrantClient) Version() *VersionCommand {
 	return &VersionCommand{
 		BaseCommand:     newBaseCommand(client),

doc.go

@@ -0,0 +1,2 @@
+// go-vagrant is a golang wrapper around the vagrant command-line utility.
+package main

vagrant_client.go

@@ -6,6 +6,8 @@ import (
 	"path/filepath"
 )
 
+// Library users should construct a new VagrantClient using NewVagrantClient().
+// From the client, vagrant commands can be constructed such as: client.Up().
 type VagrantClient struct {
 	// Directory where the Vagrantfile can be found.
 	//