diff --git a/README.md b/README.md index e8b2d51..c3e83b8 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ [![Vet](https://github.com/reverbdotcom/sbx/actions/workflows/vet.yaml/badge.svg)](https://github.com/reverbdotcom/sbx/actions/workflows/vet.yaml) # sbx -Orchestra CLI tool +Orchestra CLI tool - `sbx up` -## Installation +#### Install / Upgrade ```bash -go install github.com/reverbdotcom/sbx@latest +export GOPRIVATE=github.com/reverbdotcom && go install github.com/reverbdotcom/sbx@latest ``` -## Development +#### Development `sbx.go` is the main entry point for the CLI tool. Every command should be a go package. Commands are @@ -19,3 +19,6 @@ configured in `commands/commands.go`. `make .run` will build and run the command. This runs live. + +#### Test +`make test` diff --git a/name/name_test.go b/name/name_test.go index c867945..5ba363e 100644 --- a/name/name_test.go +++ b/name/name_test.go @@ -5,9 +5,9 @@ import ( ) func TestRun(t *testing.T) { - dictionary = func() ([]string, error) { - return []string{"blake", "julian", "kevin"}, nil - } + dictionary = func() ([]string, error) { + return []string{"blake", "julian", "kevin"}, nil + } t.Run("it generates a sandbox name", func(t *testing.T) { branch = func() (string, error) { @@ -28,9 +28,9 @@ func TestRun(t *testing.T) { } func TestProperNames(t *testing.T) { - dictionary = func() ([]string, error) { - return []string{"blake", "julian", "kevin", "a", "super-long-name-that-does-not-fit"}, nil - } + dictionary = func() ([]string, error) { + return []string{"blake", "julian", "kevin", "a", "super-long-name-that-does-not-fit"}, nil + } t.Run("it should be longer than 2 and less than 13", func(t *testing.T) { words, err := properNames()