Merge pull request #30 from schollz/finish

add option to clear on finish

examples/main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"fmt"
 	"os"
 	"time"
 
@@ -17,6 +18,7 @@ func main() {
 		bar.Add(1)
 		time.Sleep(2 * time.Millisecond)
 	}
+	fmt.Println("finished1")
 
 	// bar with options
 	bar = progressbar.NewOptions(1000,
@@ -28,6 +30,7 @@ func main() {
 		bar.Add(1)
 		time.Sleep(2 * time.Millisecond)
 	}
+	fmt.Println("finished2")
 
 	bar = progressbar.NewOptions(100,
 		progressbar.OptionSetWriter(ansi.NewAnsiStdout()),
@@ -47,4 +50,6 @@ func main() {
 		time.Sleep(10 * time.Millisecond)
 	}
 
+	fmt.Println("finished3")
+
 }

go.mod

@@ -1,3 +1,8 @@
 module github.com/schollz/progressbar/v2
 
-require github.com/mitchellh/colorstring v0.0.0-20150917214807-8631ce90f286
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db
+	github.com/stretchr/objx v0.1.1 // indirect
+	github.com/stretchr/testify v1.3.0
+)

progressbar.go

@@ -43,6 +43,8 @@ type state struct {
 
 	maxLineWidth int
 	currentBytes float64
+
+	finished bool
 }
 
 type config struct {
@@ -61,6 +63,9 @@ type config struct {
 
 	// minimum time to wait in between updates
 	throttleDuration time.Duration
+
+	// clear bar once finished
+	clearOnFinish bool
 }
 
 // Theme defines the elements of the bar
@@ -152,6 +157,13 @@ func OptionThrottle(duration time.Duration) Option {
 	}
 }
 
+// OptionClearOnFinish will clear the bar once its finished
+func OptionClearOnFinish() Option {
+	return func(p *ProgressBar) {
+		p.config.clearOnFinish = true
+	}
+}
+
 var defaultTheme = Theme{Saucer: "█", SaucerPadding: " ", BarStart: "|", BarEnd: "|"}
 
 // NewOptions constructs a new instance of ProgressBar, with any options you specify
@@ -288,6 +300,15 @@ func (p *ProgressBar) render() error {
 		return err
 	}
 
+	// check if the progress bar is finished
+	if p.state.finished || p.state.currentNum >= p.config.max {
+		p.state.finished = true
+		if p.config.clearOnFinish {
+			// if the progressbar is finished, return
+			return nil
+		}
+	}
+
 	// then, re-render the current progress bar
 	w, err := renderProgressBar(p.config, p.state)
 	if err != nil {

progressbar_test.go

@@ -5,6 +5,7 @@ import (
 	"bytes"
 	"crypto/md5"
 	"encoding/hex"
+	"fmt"
 	"io"
 	"io/ioutil"
 	"net/http"
@@ -42,11 +43,20 @@ func ExampleThrottle() {
 	// 10% |█         |  [0s:1s]
 }
 func ExampleFinish() {
+	bar := NewOptions(100, OptionSetWidth(10), OptionSetRenderBlankState(false), OptionClearOnFinish())
+	bar.Reset()
+	bar.Finish()
+	fmt.Println("Finished")
+	// Output:
+	// Finished
+}
+func ExampleFinish2() {
 	bar := NewOptions(100, OptionSetWidth(10), OptionSetRenderBlankState(false))
 	bar.Reset()
 	bar.Finish()
+	fmt.Println("Finished")
 	// Output:
-	// 100% |██████████|  [0s:0s]
+	// 100% |██████████|  [0s:0s]Finished
 }
 
 func ExampleSetBytes() {