feat(cmd loading): add loading indicator for long-running commands

cmd/add.go

@@ -50,6 +50,9 @@ func (o *AddOptions) Complete(f Factory) (err error) {
 
 // Run adds another peer's dataset to this user's repo
 func (o *AddOptions) Run(args []string) error {
+	spinner.Start()
+	defer spinner.Stop()
+
 	for _, arg := range args {
 		ref, err := parseCmdLineDatasetRef(arg)
 		if err != nil {

cmd/body.go

@@ -80,6 +80,9 @@ func (o *BodyOptions) Complete(f Factory, args []string) (err error) {
 
 // Run executes the body command
 func (o *BodyOptions) Run() error {
+	spinner.Start()
+	defer spinner.Stop()
+
 	if o.UsingRPC {
 		return usingRPCError("body")
 	}

cmd/cmd_test.go

@@ -16,6 +16,11 @@ import (
 	"github.com/spf13/cobra"
 )
 
+func init() {
+	// disable spinner output during testing
+	spinner.Writer = ioutil.Discard
+}
+
 func confirmQriNotRunning() error {
 	l, err := net.Listen("tcp", fmt.Sprintf(":%d", config.DefaultAPIPort))
 	if err != nil {

cmd/new.go

@@ -15,16 +15,13 @@ import (
 	"github.com/spf13/cobra"
 )
 
-
 // TODO: Tests.
 
-
 const providingSecretWarningMessage = `
 Warning: You are providing secrets to a dataset transformation.
 Never provide secrets to a transformation you do not trust.
 continue?`
 
-
 // NewNewCommand creates a new command
 func NewNewCommand(f Factory, ioStreams IOStreams) *cobra.Command {
 	o := &NewOptions{IOStreams: ioStreams}
@@ -75,13 +72,13 @@ create a dataset with a dataset data file:
 type NewOptions struct {
 	IOStreams
 
-	File           string
-	BodyPath       string
-	Title          string
-	Message        string
-	Private        bool
-	Publish        bool
-	Secrets        []string
+	File     string
+	BodyPath string
+	Title    string
+	Message  string
+	Private  bool
+	Publish  bool
+	Secrets  []string
 
 	DatasetRequests *lib.DatasetRequests
 }
@@ -95,8 +92,9 @@ func (o *NewOptions) Complete(f Factory) (err error) {
 }
 
 // Run creates a new dataset
-func (o *NewOptions) Run(args []string) error {
-	var err error
+func (o *NewOptions) Run(args []string) (err error) {
+	spinner.Start()
+	defer spinner.Stop()
 
 	if o.File == "" && o.BodyPath == "" {
 		return fmt.Errorf("creating new dataset needs either --file or --body")

cmd/registry.go

@@ -104,6 +104,9 @@ func (o *RegistryOptions) Complete(f Factory, args []string) (err error) {
 // Publish executes the publish command
 func (o *RegistryOptions) Publish() error {
 	var res bool
+	spinner.Start()
+	defer spinner.Stop()
+
 	for _, arg := range o.Refs {
 		ref, err := repo.ParseDatasetRef(arg)
 		if err != nil {
@@ -127,6 +130,9 @@ func (o *RegistryOptions) Publish() error {
 // Unpublish executes the unpublish command
 func (o *RegistryOptions) Unpublish() error {
 	var res bool
+	spinner.Start()
+	defer spinner.Stop()
+
 	for _, arg := range o.Refs {
 		ref, err := repo.ParseDatasetRef(arg)
 		if err != nil {

cmd/render.go

@@ -76,6 +76,9 @@ func (o *RenderOptions) Complete(f Factory, args []string) (err error) {
 func (o *RenderOptions) Run() (err error) {
 	var template []byte
 
+	spinner.Start()
+	defer spinner.Stop()
+
 	ref, err := repo.ParseDatasetRef(o.Ref)
 	if err != nil && err != repo.ErrEmptyRef {
 		return err

cmd/save.go

@@ -114,6 +114,9 @@ func (o *SaveOptions) Validate() error {
 
 // Run executes the save command
 func (o *SaveOptions) Run() (err error) {
+	spinner.Start()
+	defer spinner.Stop()
+
 	ref, err := parseCmdLineDatasetRef(o.Ref)
 	if err != nil && o.FilePath == "" {
 		return lib.NewError(lib.ErrBadArgs, "error parsing dataset reference '"+o.Ref+"'")
@@ -183,6 +186,7 @@ continue?`, true) {
 		return err
 	}
 
+	spinner.Stop()
 	printSuccess(o.Out, "dataset saved: %s", res)
 	if res.Dataset.Structure.ErrCount > 0 {
 		printWarning(o.Out, fmt.Sprintf("this dataset has %d validation errors", res.Dataset.Structure.ErrCount))

cmd/search.go

@@ -72,6 +72,8 @@ func (o *SearchOptions) Validate() error {
 
 // Run executes the search command
 func (o *SearchOptions) Run() (err error) {
+	spinner.Start()
+	defer spinner.Stop()
 
 	// TODO: add reindex option back in
 
@@ -87,6 +89,7 @@ func (o *SearchOptions) Run() (err error) {
 		return err
 	}
 
+	spinner.Stop()
 	switch o.Format {
 	case "":
 		fmt.Fprintf(o.Out, "showing %d results for '%s'\n", len(results), o.Query)

cmd/validate.go

@@ -109,6 +109,8 @@ func (o *ValidateOptions) Run() (err error) {
 		dataFile, schemaFile *os.File
 		ref                  repo.DatasetRef
 	)
+	spinner.Start()
+	defer spinner.Stop()
 
 	ref, err = repo.ParseDatasetRef(o.Ref)
 	if err != nil && err != repo.ErrEmptyRef {
@@ -147,6 +149,9 @@ func (o *ValidateOptions) Run() (err error) {
 	if err = o.DatasetRequests.Validate(p, &res); err != nil {
 		return err
 	}
+
+	spinner.Stop()
+
 	if len(res) == 0 {
 		printSuccess(o.Out, "✔ All good!")
 		return