basic terminal setup

Author: skarim

cmd/placeholder.go

@@ -0,0 +1,35 @@
+package cmd
+
+import (
+	"github.com/github/gh-stack/internal/config"
+	"github.com/spf13/cobra"
+)
+
+type placeholderDef struct {
+	Name  string
+	Short string
+}
+
+var placeholderCommands = []placeholderDef{
+	{"remove", "Remove a branch from a stack"},
+	{"modify", "Modify a branch in a stack"},
+	{"reorder", "Reorder branches in a stack"},
+	{"move", "Move a branch between stacks"},
+	{"fold", "Fold a branch into the branch below it"},
+	{"squash", "Squash commits in a branch"},
+	{"rename", "Rename a branch in a stack"},
+	{"split", "Split a branch into two branches"},
+}
+
+func PlaceholderCmd(def placeholderDef, cfg *config.Config) *cobra.Command {
+	return &cobra.Command{
+		Use:    def.Name,
+		Short:  def.Short,
+		Hidden: true,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			cfg.Warningf("`gh stack %s` is not yet supported.", def.Name)
+			cfg.Infof("Run `gh stack feedback` to share your thoughts on this feature.")
+			return nil
+		},
+	}
+}

cmd/root.go

@@ -0,0 +1,36 @@
+package cmd
+
+import (
+	"os"
+
+	"github.com/github/gh-stack/internal/config"
+	"github.com/spf13/cobra"
+)
+
+func RootCmd() *cobra.Command {
+	cfg := config.New()
+
+	root := &cobra.Command{
+		Use:           "stack <command>",
+		Short:         "Manage stacked branches and pull requests",
+		Long:          "Create, navigate, and manage stacks of branches and pull requests.",
+		SilenceUsage:  true,
+		SilenceErrors: true,
+	}
+
+	root.SetOut(cfg.Out)
+	root.SetErr(cfg.Err)
+
+	for _, ph := range placeholderCommands {
+		root.AddCommand(PlaceholderCmd(ph, cfg))
+	}
+
+	return root
+}
+
+func Execute() {
+	cmd := RootCmd()
+	if err := cmd.Execute(); err != nil {
+		os.Exit(1)
+	}
+}

go.mod

@@ -1,4 +1,4 @@
-module github.com/githubnext/gh-stack
+module github.com/github/gh-stack
 
 go 1.25.7
 
@@ -9,11 +9,16 @@ require (
 	github.com/cli/safeexec v1.0.0 // indirect
 	github.com/cli/shurcooL-graphql v0.0.4 // indirect
 	github.com/henvic/httpretty v0.0.6 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/kr/pretty v0.3.1 // indirect
 	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
 	github.com/muesli/termenv v0.16.0 // indirect
 	github.com/rivo/uniseg v0.4.7 // indirect
+	github.com/spf13/cobra v1.10.2 // indirect
+	github.com/spf13/pflag v1.0.9 // indirect
 	github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e // indirect
 	golang.org/x/sys v0.31.0 // indirect
 	golang.org/x/term v0.30.0 // indirect

go.sum

@@ -6,21 +6,29 @@ github.com/cli/safeexec v1.0.0 h1:0VngyaIyqACHdcMNWfo6+KdUYnqEr2Sg+bSP1pdF+dI=
 github.com/cli/safeexec v1.0.0/go.mod h1:Z/D4tTN8Vs5gXYHDCbaM1S/anmEDnJb1iW0+EJ5zx3Q=
 github.com/cli/shurcooL-graphql v0.0.4 h1:6MogPnQJLjKkaXPyGqPRXOI2qCsQdqNfUY1QSJu2GuY=
 github.com/cli/shurcooL-graphql v0.0.4/go.mod h1:3waN4u02FiZivIV+p1y4d0Jo1jc6BViMA73C+sZo2fk=
+github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw=
 github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI=
 github.com/henvic/httpretty v0.0.6 h1:JdzGzKZBajBfnvlMALXXMVQWxWMF/ofTy8C3/OSUTxs=
 github.com/henvic/httpretty v0.0.6/go.mod h1:X38wLjWXHkXT7r2+uK8LjCMne9rsuNaBLJ+5cU2/Pmo=
+github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
+github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
 github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
 github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
 github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d h1:5PJl274Y63IEHC+7izoQE9x6ikvDFZS2mDVS3drnohI=
+github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE=
 github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
 github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
 github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
@@ -30,11 +38,18 @@ github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
 github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
 github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
 github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU=
+github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4=
+github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY=
+github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e h1:BuzhfgfWQbX0dWzYzT1zsORLnHRv3bcRcsaUk0VmXA8=
 github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e/go.mod h1:/Tnicc6m/lsJE0irFMA0LfIwTBo4QP7A8IfyIv4zZKI=
+go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
 golang.org/x/sys v0.0.0-20210831042530-f4d43177bf5e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
 golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=

internal/config/config.go

@@ -0,0 +1,83 @@
+package config
+
+import (
+	"fmt"
+	"io"
+	"os"
+
+	"github.com/cli/go-gh/v2/pkg/term"
+	"github.com/mgutz/ansi"
+)
+
+// Config holds shared state for all commands
+type Config struct {
+	Terminal term.Term
+	Out      io.Writer
+	Err      io.Writer
+	In       io.Reader
+
+	ColorSuccess func(string) string
+	ColorError   func(string) string
+	ColorWarning func(string) string
+	ColorBold    func(string) string
+	ColorCyan    func(string) string
+	ColorGray    func(string) string
+}
+
+// New creates a new Config with terminal-aware output and color support
+func New() *Config {
+	terminal := term.FromEnv()
+	cfg := &Config{
+		Terminal: terminal,
+		Out:      terminal.Out(),
+		Err:      terminal.ErrOut(),
+		In:       os.Stdin,
+	}
+
+	if terminal.IsColorEnabled() {
+		cfg.ColorSuccess = ansi.ColorFunc("green")
+		cfg.ColorError = ansi.ColorFunc("red")
+		cfg.ColorWarning = ansi.ColorFunc("yellow")
+		cfg.ColorBold = ansi.ColorFunc("default+b")
+		cfg.ColorCyan = ansi.ColorFunc("cyan")
+		cfg.ColorGray = ansi.ColorFunc("white+d")
+	} else {
+		noop := func(s string) string { return s }
+		cfg.ColorSuccess = noop
+		cfg.ColorError = noop
+		cfg.ColorWarning = noop
+		cfg.ColorBold = noop
+		cfg.ColorCyan = noop
+		cfg.ColorGray = noop
+	}
+
+	return cfg
+}
+
+func (c *Config) Successf(format string, args ...any) {
+	fmt.Fprintf(c.Err, "%s %s\n", c.ColorSuccess("\u2713"), fmt.Sprintf(format, args...))
+}
+
+func (c *Config) Errorf(format string, args ...any) {
+	fmt.Fprintf(c.Err, "%s %s\n", c.ColorError("\u2717"), fmt.Sprintf(format, args...))
+}
+
+func (c *Config) Warningf(format string, args ...any) {
+	fmt.Fprintf(c.Err, "%s %s\n", c.ColorWarning("\u26a0"), fmt.Sprintf(format, args...))
+}
+
+func (c *Config) Infof(format string, args ...any) {
+	fmt.Fprintf(c.Err, "%s %s\n", c.ColorCyan("\u2139"), fmt.Sprintf(format, args...))
+}
+
+func (c *Config) Printf(format string, args ...any) {
+	fmt.Fprintf(c.Err, format+"\n", args...)
+}
+
+func (c *Config) Outf(format string, args ...any) {
+	fmt.Fprintf(c.Out, format, args...)
+}
+
+func (c *Config) IsInteractive() bool {
+	return c.Terminal.IsTerminalOutput()
+}

main.go

@@ -1,26 +1,9 @@
 package main
 
 import (
-	"fmt"
-
-	"github.com/cli/go-gh/v2/pkg/api"
+	"github.com/github/gh-stack/cmd"
 )
 
 func main() {
-	fmt.Println("hi world, this is the gh-stack extension!")
-	client, err := api.DefaultRESTClient()
-	if err != nil {
-		fmt.Println(err)
-		return
-	}
-	response := struct {Login string}{}
-	err = client.Get("user", &response)
-	if err != nil {
-		fmt.Println(err)
-		return
-	}
-	fmt.Printf("running as %s\n", response.Login)
+	cmd.Execute()
 }
-
-// For more examples of using go-gh, see:
-// https://github.com/cli/go-gh/blob/trunk/example_gh_test.go