From bbcf2dd321527e08df5c483b1646b8b7fab53d78 Mon Sep 17 00:00:00 2001 From: Alan Donovan Date: Tue, 31 Aug 2021 11:15:26 -0400 Subject: [PATCH] spell product names (Codespaces, Live Share) correctly --- api/api.go | 2 +- cmd/ghcs/code.go | 2 +- cmd/ghcs/create.go | 12 ++++++------ cmd/ghcs/delete.go | 18 +++++++++--------- cmd/ghcs/list.go | 2 +- cmd/ghcs/logs.go | 4 ++-- cmd/ghcs/ports.go | 16 ++++++++-------- cmd/ghcs/ssh.go | 6 +++--- internal/codespaces/codespaces.go | 26 +++++++++++++------------- internal/codespaces/ssh.go | 2 +- internal/codespaces/states.go | 4 ++-- 11 files changed, 47 insertions(+), 47 deletions(-) diff --git a/api/api.go b/api/api.go index a8f6ea724..b9d4213a0 100644 --- a/api/api.go +++ b/api/api.go @@ -278,7 +278,7 @@ func (a *API) StartCodespace(ctx context.Context, token string, codespace *Codes if len(b) > 100 { b = append(b[:97], "..."...) } - return fmt.Errorf("failed to start codespace: %s", b) + return fmt.Errorf("failed to start Codespace: %s", b) } return nil diff --git a/cmd/ghcs/code.go b/cmd/ghcs/code.go index 19d76fadb..b3b43f050 100644 --- a/cmd/ghcs/code.go +++ b/cmd/ghcs/code.go @@ -52,7 +52,7 @@ func code(codespaceName string, useInsiders bool) error { if err == codespaces.ErrNoCodespaces { return err } - return fmt.Errorf("error choosing codespace: %v", err) + return fmt.Errorf("error choosing Codespace: %v", err) } codespaceName = codespace.Name } diff --git a/cmd/ghcs/create.go b/cmd/ghcs/create.go index 7d5d59923..71e31f298 100644 --- a/cmd/ghcs/create.go +++ b/cmd/ghcs/create.go @@ -69,12 +69,12 @@ func create(opts *createOptions) error { locationResult := <-locationCh if locationResult.Err != nil { - return fmt.Errorf("error getting codespace region location: %v", locationResult.Err) + return fmt.Errorf("error getting Codespace region location: %v", locationResult.Err) } userResult := <-userCh if userResult.Err != nil { - return fmt.Errorf("error getting codespace user: %v", userResult.Err) + return fmt.Errorf("error getting Codespace user: %v", userResult.Err) } machine, err := getMachineName(ctx, opts.machine, userResult.User, repository, locationResult.Location, apiClient) @@ -85,11 +85,11 @@ func create(opts *createOptions) error { return errors.New("There are no available machine types for this repository") } - log.Println("Creating your codespace...") + log.Println("Creating your Codespace...") codespace, err := apiClient.CreateCodespace(ctx, userResult.User, repository, machine, branch, locationResult.Location) if err != nil { - return fmt.Errorf("error creating codespace: %v", err) + return fmt.Errorf("error creating Codespace: %v", err) } if opts.showStatus { @@ -154,7 +154,7 @@ func showStatus(ctx context.Context, log *output.Logger, apiClient *api.API, use } if err := codespaces.PollPostCreateStates(ctx, log, apiClient, user, codespace, poller); err != nil { - return fmt.Errorf("failed to poll state changes from codespace: %v", err) + return fmt.Errorf("failed to poll state changes from Codespace: %v", err) } return nil @@ -228,7 +228,7 @@ func getBranchName(branch string) (string, error) { func getMachineName(ctx context.Context, machine string, user *api.User, repo *api.Repository, location string, apiClient *api.API) (string, error) { skus, err := apiClient.GetCodespacesSKUs(ctx, user, repo, location) if err != nil { - return "", fmt.Errorf("error getting codespace SKUs: %v", err) + return "", fmt.Errorf("error getting Codespace SKUs: %v", err) } // if user supplied a machine type, it must be valid diff --git a/cmd/ghcs/delete.go b/cmd/ghcs/delete.go index d37029753..c42f57f6f 100644 --- a/cmd/ghcs/delete.go +++ b/cmd/ghcs/delete.go @@ -65,11 +65,11 @@ func delete_(codespaceName string) error { codespace, token, err := codespaces.GetOrChooseCodespace(ctx, apiClient, user, codespaceName) if err != nil { - return fmt.Errorf("get or choose codespace: %v", err) + return fmt.Errorf("get or choose Codespace: %v", err) } if err := apiClient.DeleteCodespace(ctx, user, token, codespace.Name); err != nil { - return fmt.Errorf("error deleting codespace: %v", err) + return fmt.Errorf("error deleting Codespace: %v", err) } log.Println("Codespace deleted.") @@ -89,17 +89,17 @@ func deleteAll() error { codespaces, err := apiClient.ListCodespaces(ctx, user) if err != nil { - return fmt.Errorf("error getting codespaces: %v", err) + return fmt.Errorf("error getting Codespaces: %v", err) } for _, c := range codespaces { token, err := apiClient.GetCodespaceToken(ctx, user.Login, c.Name) if err != nil { - return fmt.Errorf("error getting codespace token: %v", err) + return fmt.Errorf("error getting Codespace token: %v", err) } if err := apiClient.DeleteCodespace(ctx, user, token, c.Name); err != nil { - return fmt.Errorf("error deleting codespace: %v", err) + return fmt.Errorf("error deleting Codespace: %v", err) } log.Printf("Codespace deleted: %s\n", c.Name) @@ -120,7 +120,7 @@ func deleteByRepo(repo string) error { codespaces, err := apiClient.ListCodespaces(ctx, user) if err != nil { - return fmt.Errorf("error getting codespaces: %v", err) + return fmt.Errorf("error getting Codespaces: %v", err) } var deleted bool @@ -132,18 +132,18 @@ func deleteByRepo(repo string) error { token, err := apiClient.GetCodespaceToken(ctx, user.Login, c.Name) if err != nil { - return fmt.Errorf("error getting codespace token: %v", err) + return fmt.Errorf("error getting Codespace token: %v", err) } if err := apiClient.DeleteCodespace(ctx, user, token, c.Name); err != nil { - return fmt.Errorf("error deleting codespace: %v", err) + return fmt.Errorf("error deleting Codespace: %v", err) } log.Printf("Codespace deleted: %s\n", c.Name) } if !deleted { - return fmt.Errorf("No codespace was found for repository: %s", repo) + return fmt.Errorf("No Codespace was found for repository: %s", repo) } return list(&listOptions{}) diff --git a/cmd/ghcs/list.go b/cmd/ghcs/list.go index a19439296..0c055e98e 100644 --- a/cmd/ghcs/list.go +++ b/cmd/ghcs/list.go @@ -46,7 +46,7 @@ func list(opts *listOptions) error { codespaces, err := apiClient.ListCodespaces(ctx, user) if err != nil { - return fmt.Errorf("error getting codespaces: %v", err) + return fmt.Errorf("error getting Codespaces: %v", err) } table := output.NewTable(os.Stdout, opts.asJSON) diff --git a/cmd/ghcs/logs.go b/cmd/ghcs/logs.go index 662e20b79..4c840e77c 100644 --- a/cmd/ghcs/logs.go +++ b/cmd/ghcs/logs.go @@ -49,12 +49,12 @@ func logs(tail bool, codespaceName string) error { codespace, token, err := codespaces.GetOrChooseCodespace(ctx, apiClient, user, codespaceName) if err != nil { - return fmt.Errorf("get or choose codespace: %v", err) + return fmt.Errorf("get or choose Codespace: %v", err) } lsclient, err := codespaces.ConnectToLiveshare(ctx, log, apiClient, user.Login, token, codespace) if err != nil { - return fmt.Errorf("connecting to liveshare: %v", err) + return fmt.Errorf("connecting to Live Share: %v", err) } tunnelPort, connClosed, err := codespaces.MakeSSHTunnel(ctx, lsclient, 0) diff --git a/cmd/ghcs/ports.go b/cmd/ghcs/ports.go index 3e89eb984..f83757ff8 100644 --- a/cmd/ghcs/ports.go +++ b/cmd/ghcs/ports.go @@ -71,14 +71,14 @@ func ports(opts *portsOptions) error { if err == codespaces.ErrNoCodespaces { return err } - return fmt.Errorf("error choosing codespace: %v", err) + return fmt.Errorf("error choosing Codespace: %v", err) } devContainerCh := getDevContainer(ctx, apiClient, codespace) liveShareClient, err := codespaces.ConnectToLiveshare(ctx, log, apiClient, user.Login, token, codespace) if err != nil { - return fmt.Errorf("error connecting to liveshare: %v", err) + return fmt.Errorf("error connecting to Live Share: %v", err) } log.Println("Loading ports...") @@ -211,17 +211,17 @@ func updatePortVisibility(log *output.Logger, codespaceName, sourcePort string, token, err := apiClient.GetCodespaceToken(ctx, user.Login, codespaceName) if err != nil { - return fmt.Errorf("error getting codespace token: %v", err) + return fmt.Errorf("error getting Codespace token: %v", err) } codespace, err := apiClient.GetCodespace(ctx, token, user.Login, codespaceName) if err != nil { - return fmt.Errorf("error getting codespace: %v", err) + return fmt.Errorf("error getting Codespace: %v", err) } lsclient, err := codespaces.ConnectToLiveshare(ctx, log, apiClient, user.Login, token, codespace) if err != nil { - return fmt.Errorf("error connecting to liveshare: %v", err) + return fmt.Errorf("error connecting to Live Share: %v", err) } server, err := liveshare.NewServer(lsclient) @@ -277,17 +277,17 @@ func forwardPorts(log *output.Logger, codespaceName string, ports []string) erro token, err := apiClient.GetCodespaceToken(ctx, user.Login, codespaceName) if err != nil { - return fmt.Errorf("error getting codespace token: %v", err) + return fmt.Errorf("error getting Codespace token: %v", err) } codespace, err := apiClient.GetCodespace(ctx, token, user.Login, codespaceName) if err != nil { - return fmt.Errorf("error getting codespace: %v", err) + return fmt.Errorf("error getting Codespace: %v", err) } lsclient, err := codespaces.ConnectToLiveshare(ctx, log, apiClient, user.Login, token, codespace) if err != nil { - return fmt.Errorf("error connecting to liveshare: %v", err) + return fmt.Errorf("error connecting to Live Share: %v", err) } server, err := liveshare.NewServer(lsclient) diff --git a/cmd/ghcs/ssh.go b/cmd/ghcs/ssh.go index 84964829a..7fecf0d1f 100644 --- a/cmd/ghcs/ssh.go +++ b/cmd/ghcs/ssh.go @@ -51,17 +51,17 @@ func ssh(sshProfile, codespaceName string, sshServerPort int) error { codespace, token, err := codespaces.GetOrChooseCodespace(ctx, apiClient, user, codespaceName) if err != nil { - return fmt.Errorf("get or choose codespace: %v", err) + return fmt.Errorf("get or choose Codespace: %v", err) } lsclient, err := codespaces.ConnectToLiveshare(ctx, log, apiClient, user.Login, token, codespace) if err != nil { - return fmt.Errorf("error connecting to liveshare: %v", err) + return fmt.Errorf("error connecting to Live Share: %v", err) } terminal, err := liveshare.NewTerminal(lsclient) if err != nil { - return fmt.Errorf("error creating liveshare terminal: %v", err) + return fmt.Errorf("error creating Live Share terminal: %v", err) } log.Print("Preparing SSH...") diff --git a/internal/codespaces/codespaces.go b/internal/codespaces/codespaces.go index 3214a6dea..90f676d28 100644 --- a/internal/codespaces/codespaces.go +++ b/internal/codespaces/codespaces.go @@ -13,13 +13,13 @@ import ( ) var ( - ErrNoCodespaces = errors.New("You have no codespaces.") + ErrNoCodespaces = errors.New("You have no Codespaces.") ) func ChooseCodespace(ctx context.Context, apiClient *api.API, user *api.User) (*api.Codespace, error) { codespaces, err := apiClient.ListCodespaces(ctx, user) if err != nil { - return nil, fmt.Errorf("error getting codespaces: %v", err) + return nil, fmt.Errorf("error getting Codespaces: %v", err) } if len(codespaces) == 0 { @@ -77,9 +77,9 @@ func ConnectToLiveshare(ctx context.Context, log logger, apiClient *api.API, use var startedCodespace bool if codespace.Environment.State != api.CodespaceEnvironmentStateAvailable { startedCodespace = true - log.Print("Starting your codespace...") + log.Print("Starting your Codespace...") if err := apiClient.StartCodespace(ctx, token, codespace); err != nil { - return nil, fmt.Errorf("error starting codespace: %v", err) + return nil, fmt.Errorf("error starting Codespace: %v", err) } } @@ -93,12 +93,12 @@ func ConnectToLiveshare(ctx context.Context, log logger, apiClient *api.API, use } if retries == 30 { - return nil, errors.New("timed out while waiting for the codespace to start") + return nil, errors.New("timed out while waiting for the Codespace to start") } codespace, err = apiClient.GetCodespace(ctx, token, userLogin, codespace.Name) if err != nil { - return nil, fmt.Errorf("error getting codespace: %v", err) + return nil, fmt.Errorf("error getting Codespace: %v", err) } } @@ -106,7 +106,7 @@ func ConnectToLiveshare(ctx context.Context, log logger, apiClient *api.API, use fmt.Print("\n") } - log.Println("Connecting to your codespace...") + log.Println("Connecting to your Codespace...") lsclient, err := liveshare.NewClient( liveshare.WithConnection(liveshare.Connection{ @@ -117,11 +117,11 @@ func ConnectToLiveshare(ctx context.Context, log logger, apiClient *api.API, use }), ) if err != nil { - return nil, fmt.Errorf("error creating live share: %v", err) + return nil, fmt.Errorf("error creating Live Share: %v", err) } if err := lsclient.Join(ctx); err != nil { - return nil, fmt.Errorf("error joining liveshare client: %v", err) + return nil, fmt.Errorf("error joining Live Share client: %v", err) } return lsclient, nil @@ -134,23 +134,23 @@ func GetOrChooseCodespace(ctx context.Context, apiClient *api.API, user *api.Use if err == ErrNoCodespaces { return nil, "", err } - return nil, "", fmt.Errorf("choosing codespace: %v", err) + return nil, "", fmt.Errorf("choosing Codespace: %v", err) } codespaceName = codespace.Name token, err = apiClient.GetCodespaceToken(ctx, user.Login, codespaceName) if err != nil { - return nil, "", fmt.Errorf("getting codespace token: %v", err) + return nil, "", fmt.Errorf("getting Codespace token: %v", err) } } else { token, err = apiClient.GetCodespaceToken(ctx, user.Login, codespaceName) if err != nil { - return nil, "", fmt.Errorf("getting codespace token for given codespace: %v", err) + return nil, "", fmt.Errorf("getting Codespace token for given codespace: %v", err) } codespace, err = apiClient.GetCodespace(ctx, token, user.Login, codespaceName) if err != nil { - return nil, "", fmt.Errorf("getting full codespace details: %v", err) + return nil, "", fmt.Errorf("getting full Codespace details: %v", err) } } diff --git a/internal/codespaces/ssh.go b/internal/codespaces/ssh.go index 672ba3b7b..ba55efae5 100644 --- a/internal/codespaces/ssh.go +++ b/internal/codespaces/ssh.go @@ -19,7 +19,7 @@ func MakeSSHTunnel(ctx context.Context, lsclient *liveshare.Client, serverPort i server, err := liveshare.NewServer(lsclient) if err != nil { - return 0, nil, fmt.Errorf("new liveshare server: %v", err) + return 0, nil, fmt.Errorf("new Live Share server: %v", err) } rand.Seed(time.Now().Unix()) diff --git a/internal/codespaces/states.go b/internal/codespaces/states.go index 5c3dcef45..b6d6937a8 100644 --- a/internal/codespaces/states.go +++ b/internal/codespaces/states.go @@ -37,12 +37,12 @@ type PostCreateState struct { func PollPostCreateStates(ctx context.Context, log logger, apiClient *api.API, user *api.User, codespace *api.Codespace, poller func([]PostCreateState)) error { token, err := apiClient.GetCodespaceToken(ctx, user.Login, codespace.Name) if err != nil { - return fmt.Errorf("getting codespace token: %v", err) + return fmt.Errorf("getting Codespace token: %v", err) } lsclient, err := ConnectToLiveshare(ctx, log, apiClient, user.Login, token, codespace) if err != nil { - return fmt.Errorf("connect to liveshare: %v", err) + return fmt.Errorf("connect to Live Share: %v", err) } tunnelPort, connClosed, err := MakeSSHTunnel(ctx, lsclient, 0)