feat: add --plain-progress

Signed-off-by: Joseph Kato <joseph@jdkato.io>

Author: jdkato

cmd/vale/command.go

@@ -165,10 +165,13 @@ func sync(_ []string, flags *core.CLIFlags) error {
 
 	// A progress bar is for someone watching it. Redirected into a CI log it
 	// leaves a trail of redrawn frames and, at the end, no record of what was
-	// actually installed -- so where nobody is watching, each package reports
-	// itself on its own line instead. See #1138.
+	// actually installed -- so `--plain-progress` swaps it for a line per
+	// package. See #1138.
+	//
+	// Asked for rather than inferred: a run that has been piped somewhere for
+	// years should keep printing what it always printed.
 	var bar *pterm.ProgressbarPrinter
-	if isTTY(os.Stdout) {
+	if !flags.PlainProgress {
 		bar, err = pterm.DefaultProgressbar.WithTotal(len(pkgs)).Start()
 		if err != nil {
 			return err

cmd/vale/flag.go

@@ -30,6 +30,8 @@ func init() {
 		`The minimum level to display (--minAlertLevel=error).`)
 
 	pflag.BoolVar(&Flags.NoColor, "no-color", false, "Don't colorize CLI output.")
+	pflag.BoolVar(&Flags.PlainProgress, "plain-progress", false,
+		"Log each step instead of drawing a progress bar.")
 	pflag.BoolVar(&Flags.Wrap, "no-wrap", false, "Don't wrap CLI output.")
 	pflag.BoolVar(&Flags.NoExit, "no-exit", false, "Don't return a nonzero exit code on errors.")
 	pflag.BoolVar(&Flags.Simple, "ignore-syntax", false, "Lint all files line-by-line.")

internal/core/config.go

@@ -164,27 +164,28 @@ func DefaultStylesPath() (string, error) {
 //
 // For example, `vale --minAlertLevel=error`.
 type CLIFlags struct {
-	AlertLevel   string
-	Built        string
-	Glob         string
-	InExt        string
-	InPath       string
-	Output       string
-	Path         string
-	Sources      string
-	Filter       string
-	Local        bool
-	NoExit       bool
-	NoColor      bool
-	Normalize    bool
-	Relative     bool
-	Remote       bool
-	Simple       bool
-	Sorted       bool
-	Wrap         bool
-	Version      bool
-	Help         bool
-	IgnoreGlobal bool
+	AlertLevel    string
+	Built         string
+	Glob          string
+	InExt         string
+	InPath        string
+	Output        string
+	Path          string
+	Sources       string
+	Filter        string
+	Local         bool
+	NoExit        bool
+	NoColor       bool
+	PlainProgress bool
+	Normalize     bool
+	Relative      bool
+	Remote        bool
+	Simple        bool
+	Sorted        bool
+	Wrap          bool
+	Version       bool
+	Help          bool
+	IgnoreGlobal  bool
 }
 
 // Config holds the configuration values from both the CLI and `.vale.ini`.

testdata/e2e/pkg.yaml

@@ -4,11 +4,11 @@ dir: fixtures/pkg
 
 cases:
   - name: plain-progress
-    about: "a progress bar redraws itself into a CI log and leaves no record of
-      what was installed; where stdout is not a terminal, each package reports
-      itself on its own line instead. See #1138."
+    about: "a progress bar redraws itself into a CI log and leaves no record
+      of what was installed; `--plain-progress` swaps it for a line per package.
+      See #1138."
     dir: style
-    args: sync
+    args: sync --plain-progress
     exit: 0
     contains: |
       Synced write-good