918cafc222
This commit converts all of the places using ColorScheme.Gray and ColorScheme.Grayf to Muted and Mutedf. There is a little extra tidying up with local variable names or converting code to use Mutedf format.
132 lines
3.5 KiB
Go
132 lines
3.5 KiB
Go
package view
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"strings"
|
|
|
|
"github.com/MakeNowJust/heredoc"
|
|
"github.com/cli/cli/v2/api"
|
|
"github.com/cli/cli/v2/internal/browser"
|
|
"github.com/cli/cli/v2/internal/gh"
|
|
"github.com/cli/cli/v2/internal/text"
|
|
"github.com/cli/cli/v2/pkg/cmdutil"
|
|
"github.com/cli/cli/v2/pkg/iostreams"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
type ViewOptions struct {
|
|
IO *iostreams.IOStreams
|
|
HTTPClient func() (*http.Client, error)
|
|
Config func() (gh.Config, error)
|
|
License string
|
|
Web bool
|
|
Browser browser.Browser
|
|
}
|
|
|
|
func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Command {
|
|
opts := &ViewOptions{
|
|
IO: f.IOStreams,
|
|
HTTPClient: f.HttpClient,
|
|
Config: f.Config,
|
|
Browser: f.Browser,
|
|
}
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "view {<license-key> | <spdx-id>}",
|
|
Short: "View a specific repository license",
|
|
Long: heredoc.Docf(`
|
|
View a specific repository license by license key or SPDX ID.
|
|
|
|
Run %[1]sgh repo license list%[1]s to see available commonly used licenses. For even more licenses, visit <https://choosealicense.com/appendix>.
|
|
`, "`"),
|
|
Example: heredoc.Doc(`
|
|
# View the MIT license from SPDX ID
|
|
$ gh repo license view MIT
|
|
|
|
# View the MIT license from license key
|
|
$ gh repo license view mit
|
|
|
|
# View the GNU AGPL-3.0 license from SPDX ID
|
|
$ gh repo license view AGPL-3.0
|
|
|
|
# View the GNU AGPL-3.0 license from license key
|
|
$ gh repo license view agpl-3.0
|
|
|
|
# Create a LICENSE.md with the MIT license
|
|
$ gh repo license view MIT > LICENSE.md
|
|
`),
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
opts.License = args[0]
|
|
if runF != nil {
|
|
return runF(opts)
|
|
}
|
|
return viewRun(opts)
|
|
},
|
|
}
|
|
|
|
cmd.Flags().BoolVarP(&opts.Web, "web", "w", false, "Open https://choosealicense.com/ in the browser")
|
|
|
|
return cmd
|
|
}
|
|
|
|
func viewRun(opts *ViewOptions) error {
|
|
if opts.License == "" {
|
|
return errors.New("no license provided")
|
|
}
|
|
|
|
client, err := opts.HTTPClient()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
cfg, err := opts.Config()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := opts.IO.StartPager(); err != nil {
|
|
fmt.Fprintf(opts.IO.ErrOut, "starting pager failed: %v\n", err)
|
|
}
|
|
defer opts.IO.StopPager()
|
|
|
|
hostname, _ := cfg.Authentication().DefaultHost()
|
|
license, err := api.RepoLicense(client, hostname, opts.License)
|
|
if err != nil {
|
|
var httpErr api.HTTPError
|
|
if errors.As(err, &httpErr) {
|
|
if httpErr.StatusCode == 404 {
|
|
return fmt.Errorf("'%s' is not a valid license name or SPDX ID.\n\nRun `gh repo license list` to see available commonly used licenses. For even more licenses, visit %s", opts.License, text.DisplayURL("https://choosealicense.com/appendix"))
|
|
}
|
|
}
|
|
return err
|
|
}
|
|
|
|
if opts.Web {
|
|
url := fmt.Sprintf("https://choosealicense.com/licenses/%s", license.Key)
|
|
if opts.IO.IsStdoutTTY() {
|
|
fmt.Fprintf(opts.IO.Out, "Opening %s in your browser.\n", text.DisplayURL(url))
|
|
}
|
|
return opts.Browser.Browse(url)
|
|
}
|
|
|
|
return renderLicense(license, opts)
|
|
}
|
|
|
|
func renderLicense(license *api.License, opts *ViewOptions) error {
|
|
cs := opts.IO.ColorScheme()
|
|
var out strings.Builder
|
|
if opts.IO.IsStdoutTTY() {
|
|
out.WriteString(fmt.Sprintf("\n%s\n", cs.Muted(license.Description)))
|
|
out.WriteString(fmt.Sprintf("\n%s\n", cs.Mutedf("To implement: %s", license.Implementation)))
|
|
out.WriteString(fmt.Sprintf("\n%s\n\n", cs.Mutedf("For more information, see: %s", license.HTMLURL)))
|
|
}
|
|
out.WriteString(license.Body)
|
|
_, err := opts.IO.Out.Write([]byte(out.String()))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|