feat(tty): support no tty (#33)

* feat(tty): support no tty

* feat(e2e): add e2e tests

Author: shipengqi

.github/workflows/e2e.yaml

@@ -61,4 +61,4 @@ jobs:
           key: commitizen-${{ github.event.pull_request.number }}-${{ github.sha }}
       - name: Run E2E test
         run: |
-          GOPATH=~/go make e2e
+          GOPATH=~/go make e2e NO_TTY=1

Makefile

@@ -24,6 +24,8 @@ Options:
                    This option is available when using: make release
   V                Set to 1 enable verbose build. Default is 0.
   DEBUG            Whether to generate debug symbols. Default is 0.
+  NO_TTY           Make sure that the TTY (terminal) is never used for
+                   any output. Default is 0.
 endef
 export USAGE_OPTIONS
 

cmd/cz/cz.go

@@ -27,12 +27,12 @@ func New() *cobra.Command {
 			}
 
 			conf := config.New()
-			tmpl, err := conf.Run()
+			tmpl, err := conf.Run(o.NoTTY)
 			if err != nil {
 				return err
 			}
 
-			msg, err := tmpl.Run()
+			msg, err := tmpl.Run(o.NoTTY)
 			if err != nil {
 				return err
 			}

hack/include/test.mk

@@ -14,6 +14,7 @@
 
 GINKGO := $(shell go env GOPATH)/bin/ginkgo
 CLI ?= $(OUTPUT_DIR)/commitizen
+NO_TTY ?= 0
 
 .PHONY: test.cover
 test.cover:
@@ -24,4 +25,4 @@ test.cover:
 .PHONY: test.e2e
 test.e2e: tools.verify.ginkgo
 	@echo "===========> Run e2e test, CLI: $(CLI)"
-	@$(GINKGO) -v $(REPO_ROOT)/test/e2e -- -cli=$(CLI)
+	@$(GINKGO) -v $(REPO_ROOT)/test/e2e -- -cli=$(CLI) -no-tty=$(NO_TTY)

internal/config/config.go

@@ -7,7 +7,6 @@ import (
 	"os"
 	"path/filepath"
 
-	tea "github.com/charmbracelet/bubbletea"
 	"github.com/shipengqi/golib/convutil"
 	"github.com/shipengqi/golib/fsutil"
 	"github.com/shipengqi/golib/sysutil"
@@ -67,14 +66,14 @@ func (c *Config) initialize() error {
 	return nil
 }
 
-func (c *Config) Run() (*render.Template, error) {
+func (c *Config) Run(noTTY bool) (*render.Template, error) {
 	err := c.initialize()
 	if err != nil {
 		return nil, err
 	}
 	if len(c.others) > 0 {
 		model := c.createTemplatesSelect("Select a template to use for this commit:")
-		if _, err := tea.NewProgram(model).Run(); err != nil {
+		if _, err := ui.Run(model, noTTY); err != nil {
 			return nil, err
 		}
 		if model.Canceled() {

internal/options/options.go

@@ -8,6 +8,7 @@ import (
 
 type Options struct {
 	DryRun     bool
+	NoTTY      bool
 	GitOptions *git.Options
 }
 
@@ -22,4 +23,7 @@ func (o *Options) AddFlags(f *pflag.FlagSet) {
 	o.GitOptions.AddFlags(f)
 
 	f.BoolVar(&o.DryRun, "dry-run", o.DryRun, "you can use the --dry-run flag to preview the message that would be committed, without really submitting it.")
+	f.BoolVar(&o.NoTTY, "no-tty", o.NoTTY, "make sure that the TTY (terminal) is never used for any output.")
+
+	_ = f.MarkHidden("no-tty")
 }

internal/render/template.go

@@ -6,8 +6,6 @@ import (
 	"strings"
 	"text/template"
 
-	tea "github.com/charmbracelet/bubbletea"
-
 	"github.com/shipengqi/commitizen/internal/ui"
 )
 
@@ -60,7 +58,7 @@ func NewTemplate() (*Template, error) {
 	return t, nil
 }
 
-func (t *Template) Run() ([]byte, error) {
+func (t *Template) Run(noTTY bool) ([]byte, error) {
 	err := t.init()
 	if err != nil {
 		return nil, err
@@ -72,7 +70,7 @@ func (t *Template) Run() ([]byte, error) {
 
 	values := map[string]interface{}{}
 	for _, v := range t.models {
-		if _, err = tea.NewProgram(v.model).Run(); err != nil {
+		if _, err = ui.Run(v.model, noTTY); err != nil {
 			return nil, err
 		}
 		if v.model.Canceled() {

internal/ui/ui.go

@@ -0,0 +1,13 @@
+package ui
+
+import tea "github.com/charmbracelet/bubbletea"
+
+func Run(model tea.Model, noTTY bool) (tea.Model, error) {
+	var p *tea.Program
+	if noTTY {
+		p = tea.NewProgram(model, tea.WithInput(nil))
+	} else {
+		p = tea.NewProgram(model)
+	}
+	return p.Run()
+}

test/e2e/cli_options.go

@@ -3,5 +3,6 @@ package e2e
 var CliOpts CliOptions
 
 type CliOptions struct {
-	Cli string
+	Cli   string
+	NoTTY int
 }

test/e2e/cz_test.go

@@ -1,22 +1,20 @@
 package e2e_test
 
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	"github.com/onsi/gomega/gbytes"
+)
+
 func CZTest() {
-	// Context("Check Commitizen", func() {
-	// 	It("should not need to select a template", func() {
-	// 		se, err = RunCLITest()
-	// 		NoError(err)
-	// 		ShouldContains(se, "Select the type of change that you're committing:")
-	// 		ShouldNotContains(se, "Select a template to use for this commit:")
-	// 	})
-	// })
-	//
-	// Context("Check Commitizen Cancel", func() {
-	// 	It("should output canceled", func() {
-	// 		se, err = RunCLITest()
-	// 		NoError(err)
-	// 		se.Terminate()
-	// 		ShouldContains(se, "canceled")
-	// 		ExitCode(se, 0)
-	// 	})
-	// })
+	Context("Check Commitizen", func() {
+		It("should not need to select a template", func() {
+			se, err = RunCLITest()
+			NoError(err)
+			Eventually(se.Out).Should(gbytes.Say("Select the type of"))
+			Eventually(se.Out).Should(gbytes.Say("A new feature"))
+			Eventually(se.Out).ShouldNot(gbytes.Say("Select a template to use for this commit:"))
+			se.Terminate()
+		})
+	})
 }