Merge pull request cli#4159 from cli/ext-create

samcoe · web-flow · commit 25b150ad6ed2 · 2021-08-23T10:44:54.000-07:00
Add extension create command
diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go
@@ -141,9 +141,43 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command {
 				return nil
 			},
 		},
+		&cobra.Command{
+			Use:   "create <name>",
+			Short: "Create a new extension",
+			Args:  cmdutil.ExactArgs(1, "must specify a name for the extension"),
+			RunE: func(cmd *cobra.Command, args []string) error {
+				extName := args[0]
+				if !strings.HasPrefix(extName, "gh-") {
+					extName = "gh-" + extName
+				}
+				if err := m.Create(extName); err != nil {
+					return err
+				}
+				if !io.IsStdoutTTY() {
+					return nil
+				}
+				link := "https://docs.github.com/github-cli/github-cli/creating-github-cli-extensions"
+				cs := io.ColorScheme()
+				out := heredoc.Docf(`
+					%[1]s Created directory %[2]s
+					%[1]s Initialized git repository
+					%[1]s Set up extension scaffolding
+
+					%[2]s is ready for development
+
+					Install locally with: cd %[2]s && gh extension install .
+
+					Publish to GitHub with: gh repo create %[2]s
+
+					For more information on writing extensions:
+					%[3]s
+				`, cs.SuccessIcon(), extName, link)
+				fmt.Fprint(io.Out, out)
+				return nil
+			},
+		},
 	)
 
-	extCmd.Hidden = true
 	return &extCmd
 }
 
diff --git a/pkg/cmd/extension/command_test.go b/pkg/cmd/extension/command_test.go
@@ -7,6 +7,7 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/MakeNowJust/heredoc"
 	"github.com/cli/cli/internal/config"
 	"github.com/cli/cli/pkg/cmdutil"
 	"github.com/cli/cli/pkg/extensions"
@@ -221,6 +222,51 @@ func TestNewCmdExtension(t *testing.T) {
 			},
 			wantStdout: "gh test\tcli/gh-test\t\ngh test2\tcli/gh-test2\tUpgrade available\n",
 		},
+		{
+			name: "create extension tty",
+			args: []string{"create", "test"},
+			managerStubs: func(em *extensions.ExtensionManagerMock) func(*testing.T) {
+				em.CreateFunc = func(name string) error {
+					return nil
+				}
+				return func(t *testing.T) {
+					calls := em.CreateCalls()
+					assert.Equal(t, 1, len(calls))
+					assert.Equal(t, "gh-test", calls[0].Name)
+				}
+			},
+			isTTY: true,
+			wantStdout: heredoc.Doc(`
+				✓ Created directory gh-test
+				✓ Initialized git repository
+				✓ Set up extension scaffolding
+
+				gh-test is ready for development
+
+				Install locally with: cd gh-test && gh extension install .
+
+				Publish to GitHub with: gh repo create gh-test
+
+				For more information on writing extensions:
+				https://docs.github.com/github-cli/github-cli/creating-github-cli-extensions
+			`),
+		},
+		{
+			name: "create extension notty",
+			args: []string{"create", "gh-test"},
+			managerStubs: func(em *extensions.ExtensionManagerMock) func(*testing.T) {
+				em.CreateFunc = func(name string) error {
+					return nil
+				}
+				return func(t *testing.T) {
+					calls := em.CreateCalls()
+					assert.Equal(t, 1, len(calls))
+					assert.Equal(t, "gh-test", calls[0].Name)
+				}
+			},
+			isTTY:      false,
+			wantStdout: "",
+		},
 	}
 
 	for _, tt := range tests {
diff --git a/pkg/cmd/extension/manager.go b/pkg/cmd/extension/manager.go
@@ -13,6 +13,7 @@ import (
 	"runtime"
 	"strings"
 
+	"github.com/MakeNowJust/heredoc"
 	"github.com/cli/cli/internal/config"
 	"github.com/cli/cli/pkg/extensions"
 	"github.com/cli/cli/pkg/findsh"
@@ -249,6 +250,76 @@ func (m *Manager) installDir() string {
 	return filepath.Join(m.dataDir(), "extensions")
 }
 
+func (m *Manager) Create(name string) error {
+	exe, err := m.lookPath("git")
+	if err != nil {
+		return err
+	}
+
+	err = os.Mkdir(name, 0755)
+	if err != nil {
+		return err
+	}
+
+	initCmd := m.newCommand(exe, "init", "--quiet", name)
+	err = initCmd.Run()
+	if err != nil {
+		return err
+	}
+
+	fileTmpl := heredoc.Docf(`
+		#!/bin/bash
+		set -e
+
+		echo "Hello %[1]s!"
+
+		# Snippets to help get started:
+
+		# Determine if an executable is in the PATH
+		# if ! type -p ruby >/dev/null; then
+		#   echo "Ruby not found on the system" >&2
+		#   exit 1
+		# fi
+
+		# Pass arguments through to another command
+		# gh issue list "$@" -R cli/cli
+
+		# Using the gh api command to retrieve and format information
+		# QUERY='
+		#   query($endCursor: String) {
+		#     viewer {
+		#       repositories(first: 100, after: $endCursor) {
+		#         nodes {
+		#           nameWithOwner
+		#           stargazerCount
+		#         }
+		#       }
+		#     }
+		#   }
+		# '
+		# TEMPLATE='
+		#   {{- range $repo := .data.viewer.repositories.nodes -}}
+		#     {{- printf "name: %[2]s - stargazers: %[3]s\n" $repo.nameWithOwner $repo.stargazerCount -}}
+		#   {{- end -}}
+		# '
+		# exec gh api graphql -f query="${QUERY}" --paginate --template="${TEMPLATE}"
+	`, name, "%s", "%v")
+	filePath := filepath.Join(name, name)
+	err = ioutil.WriteFile(filePath, []byte(fileTmpl), 0755)
+	if err != nil {
+		return err
+	}
+
+	wd, err := os.Getwd()
+	if err != nil {
+		return err
+	}
+	dir := filepath.Join(wd, name)
+	addCmd := m.newCommand(exe, "-C", dir, "--git-dir="+filepath.Join(dir, ".git"), "add", name, "--chmod=+x")
+	err = addCmd.Run()
+	return err
+}
+
 func runCmds(cmds []*exec.Cmd, stdout, stderr io.Writer) error {
 	for _, cmd := range cmds {
 		cmd.Stdout = stdout
diff --git a/pkg/cmd/extension/manager_test.go b/pkg/cmd/extension/manager_test.go
@@ -202,6 +202,26 @@ func TestManager_Install(t *testing.T) {
 	assert.Equal(t, "", stderr.String())
 }
 
+func TestManager_Create(t *testing.T) {
+	tempDir := t.TempDir()
+	oldWd, _ := os.Getwd()
+	assert.NoError(t, os.Chdir(tempDir))
+	t.Cleanup(func() { _ = os.Chdir(oldWd) })
+	m := newTestManager(tempDir)
+	err := m.Create("gh-test")
+	assert.NoError(t, err)
+	files, err := ioutil.ReadDir(filepath.Join(tempDir, "gh-test"))
+	assert.NoError(t, err)
+	assert.Equal(t, 1, len(files))
+	extFile := files[0]
+	assert.Equal(t, "gh-test", extFile.Name())
+	if runtime.GOOS == "windows" {
+		assert.Equal(t, os.FileMode(0666), extFile.Mode())
+	} else {
+		assert.Equal(t, os.FileMode(0755), extFile.Mode())
+	}
+}
+
 func stubExtension(path string) error {
 	if err := os.MkdirAll(filepath.Dir(path), 0755); err != nil {
 		return err
diff --git a/pkg/extensions/extension.go b/pkg/extensions/extension.go
@@ -21,4 +21,5 @@ type ExtensionManager interface {
 	Upgrade(name string, force bool, stdout, stderr io.Writer) error
 	Remove(name string) error
 	Dispatch(args []string, stdin io.Reader, stdout, stderr io.Writer) (bool, error)
+	Create(name string) error
 }
diff --git a/pkg/extensions/manager_mock.go b/pkg/extensions/manager_mock.go

Original file line number	Diff line number	Diff line change
`@@ -21,4 +21,5 @@ type ExtensionManager interface {`
`21`	`21`	`Upgrade(name string, force bool, stdout, stderr io.Writer) error`
`22`	`22`	`Remove(name string) error`
`23`	`23`	`Dispatch(args []string, stdin io.Reader, stdout, stderr io.Writer) (bool, error)`
	`24`	`+ Create(name string) error`
`24`	`25`	`}`