Skip to content

Commit ffebd23

Browse files
mislavmislav
authored
Merge pull request cli#3761 from cli/command-extensions
Experimental command extensions support
2 parents 83fcece + 4bdddd7 commit ffebd23

4 files changed

Lines changed: 216 additions & 3 deletions

File tree

‎cmd/gh/main.go‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"github.com/cli/cli/internal/run"
2222
"github.com/cli/cli/internal/update"
2323
"github.com/cli/cli/pkg/cmd/alias/expand"
24+
"github.com/cli/cli/pkg/cmd/extensions"
2425
"github.com/cli/cli/pkg/cmd/factory"
2526
"github.com/cli/cli/pkg/cmd/root"
2627
"github.com/cli/cli/pkg/cmdutil"
@@ -140,15 +141,27 @@ func mainRun() exitCode {
140141

141142
err = preparedCmd.Run()
142143
if err != nil {
143-
if ee, ok := err.(*exec.ExitError); ok {
144-
return exitCode(ee.ExitCode())
144+
var execError *exec.ExitError
145+
if errors.As(err, &execError) {
146+
return exitCode(execError.ExitCode())
145147
}
146-
147148
fmt.Fprintf(stderr, "failed to run external command: %s", err)
148149
return exitError
149150
}
150151

151152
return exitOK
153+
} else if c, _, err := rootCmd.Traverse(expandedArgs); err == nil && c == rootCmd && len(expandedArgs) > 0 {
154+
extensionManager := extensions.NewManager()
155+
if found, err := extensionManager.Dispatch(expandedArgs, os.Stdin, os.Stdout, os.Stderr); err != nil {
156+
var execError *exec.ExitError
157+
if errors.As(err, &execError) {
158+
return exitCode(execError.ExitCode())
159+
}
160+
fmt.Fprintf(stderr, "failed to run extension: %s", err)
161+
return exitError
162+
} else if found {
163+
return exitOK
164+
}
152165
}
153166
}
154167

‎pkg/cmd/extensions/command.go‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
package extensions
2+
3+
import (
4+
"errors"
5+
"fmt"
6+
"os"
7+
"path/filepath"
8+
"strings"
9+
10+
"github.com/cli/cli/internal/ghrepo"
11+
"github.com/cli/cli/pkg/cmdutil"
12+
"github.com/cli/cli/pkg/iostreams"
13+
"github.com/spf13/cobra"
14+
)
15+
16+
func NewCmdExtensions(io *iostreams.IOStreams) *cobra.Command {
17+
m := NewManager()
18+
19+
extCmd := cobra.Command{
20+
Use: "extensions",
21+
Short: "Manage gh extensions",
22+
}
23+
24+
extCmd.AddCommand(
25+
&cobra.Command{
26+
Use: "list",
27+
Short: "List installed extension commands",
28+
Args: cobra.NoArgs,
29+
RunE: func(cmd *cobra.Command, args []string) error {
30+
cmds := m.List()
31+
if len(cmds) == 0 {
32+
return errors.New("no extensions installed")
33+
}
34+
for _, c := range cmds {
35+
name := filepath.Base(c)
36+
parts := strings.SplitN(name, "-", 2)
37+
fmt.Fprintf(io.Out, "%s %s\n", parts[0], parts[1])
38+
}
39+
return nil
40+
},
41+
},
42+
&cobra.Command{
43+
Use: "install <repo>",
44+
Short: "Install a gh extension from a repository",
45+
Args: cmdutil.MinimumArgs(1, "must specify a repository to install from"),
46+
RunE: func(cmd *cobra.Command, args []string) error {
47+
if args[0] == "." {
48+
wd, err := os.Getwd()
49+
if err != nil {
50+
return err
51+
}
52+
return m.InstallLocal(wd)
53+
}
54+
repo, err := ghrepo.FromFullName(args[0])
55+
if err != nil {
56+
return err
57+
}
58+
if !strings.HasPrefix(repo.RepoName(), "gh-") {
59+
return errors.New("the repository name must start with `gh-`")
60+
}
61+
protocol := "https" // TODO: respect user's preferred protocol
62+
return m.Install(ghrepo.FormatRemoteURL(repo, protocol), io.Out, io.ErrOut)
63+
},
64+
},
65+
&cobra.Command{
66+
Use: "upgrade",
67+
Short: "Upgrade installed extensions",
68+
Args: cobra.NoArgs,
69+
RunE: func(cmd *cobra.Command, args []string) error {
70+
return m.Upgrade(io.Out, io.ErrOut)
71+
},
72+
},
73+
)
74+
75+
extCmd.Hidden = true
76+
return &extCmd
77+
}

‎pkg/cmd/extensions/manager.go‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
package extensions
2+
3+
import (
4+
"errors"
5+
"fmt"
6+
"io"
7+
"io/ioutil"
8+
"os"
9+
"os/exec"
10+
"path"
11+
"path/filepath"
12+
"strings"
13+
14+
"github.com/cli/cli/internal/config"
15+
"github.com/cli/safeexec"
16+
)
17+
18+
type Manager struct {
19+
dataDir func() string
20+
lookPath func(string) (string, error)
21+
}
22+
23+
func NewManager() *Manager {
24+
return &Manager{
25+
dataDir: config.ConfigDir,
26+
lookPath: safeexec.LookPath,
27+
}
28+
}
29+
30+
func (m *Manager) Dispatch(args []string, stdin io.Reader, stdout, stderr io.Writer) (bool, error) {
31+
if len(args) == 0 {
32+
return false, errors.New("too few arguments in list")
33+
}
34+
35+
var exe string
36+
extName := "gh-" + args[0]
37+
forwardArgs := args[1:]
38+
39+
for _, e := range m.List() {
40+
if filepath.Base(e) == extName {
41+
exe = e
42+
break
43+
}
44+
}
45+
if exe == "" {
46+
return false, nil
47+
}
48+
49+
// TODO: parse the shebang on Windows and invoke the correct interpreter instead of invoking directly
50+
externalCmd := exec.Command(exe, forwardArgs...)
51+
externalCmd.Stdin = stdin
52+
externalCmd.Stdout = stdout
53+
externalCmd.Stderr = stderr
54+
return true, externalCmd.Run()
55+
}
56+
57+
func (m *Manager) List() []string {
58+
dir := m.installDir()
59+
entries, err := ioutil.ReadDir(dir)
60+
if err != nil {
61+
return nil
62+
}
63+
64+
var results []string
65+
for _, f := range entries {
66+
if !strings.HasPrefix(f.Name(), "gh-") || !(f.IsDir() || f.Mode()&os.ModeSymlink != 0) {
67+
continue
68+
}
69+
results = append(results, filepath.Join(dir, f.Name(), f.Name()))
70+
}
71+
return results
72+
}
73+
74+
func (m *Manager) InstallLocal(dir string) error {
75+
name := filepath.Base(dir)
76+
targetDir := filepath.Join(m.installDir(), name)
77+
return os.Symlink(dir, targetDir)
78+
}
79+
80+
func (m *Manager) Install(cloneURL string, stdout, stderr io.Writer) error {
81+
exe, err := m.lookPath("git")
82+
if err != nil {
83+
return err
84+
}
85+
86+
name := strings.TrimSuffix(path.Base(cloneURL), ".git")
87+
targetDir := filepath.Join(m.installDir(), name)
88+
89+
externalCmd := exec.Command(exe, "clone", cloneURL, targetDir)
90+
externalCmd.Stdout = stdout
91+
externalCmd.Stderr = stderr
92+
return externalCmd.Run()
93+
}
94+
95+
func (m *Manager) Upgrade(stdout, stderr io.Writer) error {
96+
exe, err := m.lookPath("git")
97+
if err != nil {
98+
return err
99+
}
100+
101+
exts := m.List()
102+
if len(exts) == 0 {
103+
return errors.New("no extensions installed")
104+
}
105+
106+
for _, f := range exts {
107+
fmt.Fprintf(stdout, "[%s]: ", filepath.Base(f))
108+
dir := filepath.Dir(f)
109+
externalCmd := exec.Command(exe, "-C", dir, "--git-dir="+filepath.Join(dir, ".git"), "pull", "--ff-only")
110+
externalCmd.Stdout = stdout
111+
externalCmd.Stderr = stderr
112+
if e := externalCmd.Run(); e != nil {
113+
err = e
114+
}
115+
}
116+
return err
117+
}
118+
119+
func (m *Manager) installDir() string {
120+
return filepath.Join(m.dataDir(), "extensions")
121+
}

‎pkg/cmd/root/root.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313
authCmd "github.com/cli/cli/pkg/cmd/auth"
1414
completionCmd "github.com/cli/cli/pkg/cmd/completion"
1515
configCmd "github.com/cli/cli/pkg/cmd/config"
16+
extensionsCmd "github.com/cli/cli/pkg/cmd/extensions"
1617
"github.com/cli/cli/pkg/cmd/factory"
1718
gistCmd "github.com/cli/cli/pkg/cmd/gist"
1819
issueCmd "github.com/cli/cli/pkg/cmd/issue"
@@ -80,6 +81,7 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) *cobra.Command {
8081
cmd.AddCommand(creditsCmd.NewCmdCredits(f, nil))
8182
cmd.AddCommand(gistCmd.NewCmdGist(f))
8283
cmd.AddCommand(completionCmd.NewCmdCompletion(f.IOStreams))
84+
cmd.AddCommand(extensionsCmd.NewCmdExtensions(f.IOStreams))
8385
cmd.AddCommand(secretCmd.NewCmdSecret(f))
8486
cmd.AddCommand(sshKeyCmd.NewCmdSSHKey(f))
8587

0 commit comments

Comments
 (0)