Skip to content

Commit bbcf2dd

Browse files
committed
spell product names (Codespaces, Live Share) correctly
1 parent 3967d0c commit bbcf2dd

File tree

11 files changed

+47
-47
lines changed

11 files changed

+47
-47
lines changed

api/api.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ func (a *API) StartCodespace(ctx context.Context, token string, codespace *Codes
278278
if len(b) > 100 {
279279
b = append(b[:97], "..."...)
280280
}
281-
return fmt.Errorf("failed to start codespace: %s", b)
281+
return fmt.Errorf("failed to start Codespace: %s", b)
282282
}
283283

284284
return nil

cmd/ghcs/code.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ func code(codespaceName string, useInsiders bool) error {
5252
if err == codespaces.ErrNoCodespaces {
5353
return err
5454
}
55-
return fmt.Errorf("error choosing codespace: %v", err)
55+
return fmt.Errorf("error choosing Codespace: %v", err)
5656
}
5757
codespaceName = codespace.Name
5858
}

cmd/ghcs/create.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,12 @@ func create(opts *createOptions) error {
6969

7070
locationResult := <-locationCh
7171
if locationResult.Err != nil {
72-
return fmt.Errorf("error getting codespace region location: %v", locationResult.Err)
72+
return fmt.Errorf("error getting Codespace region location: %v", locationResult.Err)
7373
}
7474

7575
userResult := <-userCh
7676
if userResult.Err != nil {
77-
return fmt.Errorf("error getting codespace user: %v", userResult.Err)
77+
return fmt.Errorf("error getting Codespace user: %v", userResult.Err)
7878
}
7979

8080
machine, err := getMachineName(ctx, opts.machine, userResult.User, repository, locationResult.Location, apiClient)
@@ -85,11 +85,11 @@ func create(opts *createOptions) error {
8585
return errors.New("There are no available machine types for this repository")
8686
}
8787

88-
log.Println("Creating your codespace...")
88+
log.Println("Creating your Codespace...")
8989

9090
codespace, err := apiClient.CreateCodespace(ctx, userResult.User, repository, machine, branch, locationResult.Location)
9191
if err != nil {
92-
return fmt.Errorf("error creating codespace: %v", err)
92+
return fmt.Errorf("error creating Codespace: %v", err)
9393
}
9494

9595
if opts.showStatus {
@@ -154,7 +154,7 @@ func showStatus(ctx context.Context, log *output.Logger, apiClient *api.API, use
154154
}
155155

156156
if err := codespaces.PollPostCreateStates(ctx, log, apiClient, user, codespace, poller); err != nil {
157-
return fmt.Errorf("failed to poll state changes from codespace: %v", err)
157+
return fmt.Errorf("failed to poll state changes from Codespace: %v", err)
158158
}
159159

160160
return nil
@@ -228,7 +228,7 @@ func getBranchName(branch string) (string, error) {
228228
func getMachineName(ctx context.Context, machine string, user *api.User, repo *api.Repository, location string, apiClient *api.API) (string, error) {
229229
skus, err := apiClient.GetCodespacesSKUs(ctx, user, repo, location)
230230
if err != nil {
231-
return "", fmt.Errorf("error getting codespace SKUs: %v", err)
231+
return "", fmt.Errorf("error getting Codespace SKUs: %v", err)
232232
}
233233

234234
// if user supplied a machine type, it must be valid

cmd/ghcs/delete.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@ func delete_(codespaceName string) error {
6565

6666
codespace, token, err := codespaces.GetOrChooseCodespace(ctx, apiClient, user, codespaceName)
6767
if err != nil {
68-
return fmt.Errorf("get or choose codespace: %v", err)
68+
return fmt.Errorf("get or choose Codespace: %v", err)
6969
}
7070

7171
if err := apiClient.DeleteCodespace(ctx, user, token, codespace.Name); err != nil {
72-
return fmt.Errorf("error deleting codespace: %v", err)
72+
return fmt.Errorf("error deleting Codespace: %v", err)
7373
}
7474

7575
log.Println("Codespace deleted.")
@@ -89,17 +89,17 @@ func deleteAll() error {
8989

9090
codespaces, err := apiClient.ListCodespaces(ctx, user)
9191
if err != nil {
92-
return fmt.Errorf("error getting codespaces: %v", err)
92+
return fmt.Errorf("error getting Codespaces: %v", err)
9393
}
9494

9595
for _, c := range codespaces {
9696
token, err := apiClient.GetCodespaceToken(ctx, user.Login, c.Name)
9797
if err != nil {
98-
return fmt.Errorf("error getting codespace token: %v", err)
98+
return fmt.Errorf("error getting Codespace token: %v", err)
9999
}
100100

101101
if err := apiClient.DeleteCodespace(ctx, user, token, c.Name); err != nil {
102-
return fmt.Errorf("error deleting codespace: %v", err)
102+
return fmt.Errorf("error deleting Codespace: %v", err)
103103
}
104104

105105
log.Printf("Codespace deleted: %s\n", c.Name)
@@ -120,7 +120,7 @@ func deleteByRepo(repo string) error {
120120

121121
codespaces, err := apiClient.ListCodespaces(ctx, user)
122122
if err != nil {
123-
return fmt.Errorf("error getting codespaces: %v", err)
123+
return fmt.Errorf("error getting Codespaces: %v", err)
124124
}
125125

126126
var deleted bool
@@ -132,18 +132,18 @@ func deleteByRepo(repo string) error {
132132

133133
token, err := apiClient.GetCodespaceToken(ctx, user.Login, c.Name)
134134
if err != nil {
135-
return fmt.Errorf("error getting codespace token: %v", err)
135+
return fmt.Errorf("error getting Codespace token: %v", err)
136136
}
137137

138138
if err := apiClient.DeleteCodespace(ctx, user, token, c.Name); err != nil {
139-
return fmt.Errorf("error deleting codespace: %v", err)
139+
return fmt.Errorf("error deleting Codespace: %v", err)
140140
}
141141

142142
log.Printf("Codespace deleted: %s\n", c.Name)
143143
}
144144

145145
if !deleted {
146-
return fmt.Errorf("No codespace was found for repository: %s", repo)
146+
return fmt.Errorf("No Codespace was found for repository: %s", repo)
147147
}
148148

149149
return list(&listOptions{})

cmd/ghcs/list.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func list(opts *listOptions) error {
4646

4747
codespaces, err := apiClient.ListCodespaces(ctx, user)
4848
if err != nil {
49-
return fmt.Errorf("error getting codespaces: %v", err)
49+
return fmt.Errorf("error getting Codespaces: %v", err)
5050
}
5151

5252
table := output.NewTable(os.Stdout, opts.asJSON)

cmd/ghcs/logs.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ func logs(tail bool, codespaceName string) error {
4949

5050
codespace, token, err := codespaces.GetOrChooseCodespace(ctx, apiClient, user, codespaceName)
5151
if err != nil {
52-
return fmt.Errorf("get or choose codespace: %v", err)
52+
return fmt.Errorf("get or choose Codespace: %v", err)
5353
}
5454

5555
lsclient, err := codespaces.ConnectToLiveshare(ctx, log, apiClient, user.Login, token, codespace)
5656
if err != nil {
57-
return fmt.Errorf("connecting to liveshare: %v", err)
57+
return fmt.Errorf("connecting to Live Share: %v", err)
5858
}
5959

6060
tunnelPort, connClosed, err := codespaces.MakeSSHTunnel(ctx, lsclient, 0)

cmd/ghcs/ports.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,14 @@ func ports(opts *portsOptions) error {
7171
if err == codespaces.ErrNoCodespaces {
7272
return err
7373
}
74-
return fmt.Errorf("error choosing codespace: %v", err)
74+
return fmt.Errorf("error choosing Codespace: %v", err)
7575
}
7676

7777
devContainerCh := getDevContainer(ctx, apiClient, codespace)
7878

7979
liveShareClient, err := codespaces.ConnectToLiveshare(ctx, log, apiClient, user.Login, token, codespace)
8080
if err != nil {
81-
return fmt.Errorf("error connecting to liveshare: %v", err)
81+
return fmt.Errorf("error connecting to Live Share: %v", err)
8282
}
8383

8484
log.Println("Loading ports...")
@@ -211,17 +211,17 @@ func updatePortVisibility(log *output.Logger, codespaceName, sourcePort string,
211211

212212
token, err := apiClient.GetCodespaceToken(ctx, user.Login, codespaceName)
213213
if err != nil {
214-
return fmt.Errorf("error getting codespace token: %v", err)
214+
return fmt.Errorf("error getting Codespace token: %v", err)
215215
}
216216

217217
codespace, err := apiClient.GetCodespace(ctx, token, user.Login, codespaceName)
218218
if err != nil {
219-
return fmt.Errorf("error getting codespace: %v", err)
219+
return fmt.Errorf("error getting Codespace: %v", err)
220220
}
221221

222222
lsclient, err := codespaces.ConnectToLiveshare(ctx, log, apiClient, user.Login, token, codespace)
223223
if err != nil {
224-
return fmt.Errorf("error connecting to liveshare: %v", err)
224+
return fmt.Errorf("error connecting to Live Share: %v", err)
225225
}
226226

227227
server, err := liveshare.NewServer(lsclient)
@@ -277,17 +277,17 @@ func forwardPorts(log *output.Logger, codespaceName string, ports []string) erro
277277

278278
token, err := apiClient.GetCodespaceToken(ctx, user.Login, codespaceName)
279279
if err != nil {
280-
return fmt.Errorf("error getting codespace token: %v", err)
280+
return fmt.Errorf("error getting Codespace token: %v", err)
281281
}
282282

283283
codespace, err := apiClient.GetCodespace(ctx, token, user.Login, codespaceName)
284284
if err != nil {
285-
return fmt.Errorf("error getting codespace: %v", err)
285+
return fmt.Errorf("error getting Codespace: %v", err)
286286
}
287287

288288
lsclient, err := codespaces.ConnectToLiveshare(ctx, log, apiClient, user.Login, token, codespace)
289289
if err != nil {
290-
return fmt.Errorf("error connecting to liveshare: %v", err)
290+
return fmt.Errorf("error connecting to Live Share: %v", err)
291291
}
292292

293293
server, err := liveshare.NewServer(lsclient)

cmd/ghcs/ssh.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,17 @@ func ssh(sshProfile, codespaceName string, sshServerPort int) error {
5151

5252
codespace, token, err := codespaces.GetOrChooseCodespace(ctx, apiClient, user, codespaceName)
5353
if err != nil {
54-
return fmt.Errorf("get or choose codespace: %v", err)
54+
return fmt.Errorf("get or choose Codespace: %v", err)
5555
}
5656

5757
lsclient, err := codespaces.ConnectToLiveshare(ctx, log, apiClient, user.Login, token, codespace)
5858
if err != nil {
59-
return fmt.Errorf("error connecting to liveshare: %v", err)
59+
return fmt.Errorf("error connecting to Live Share: %v", err)
6060
}
6161

6262
terminal, err := liveshare.NewTerminal(lsclient)
6363
if err != nil {
64-
return fmt.Errorf("error creating liveshare terminal: %v", err)
64+
return fmt.Errorf("error creating Live Share terminal: %v", err)
6565
}
6666

6767
log.Print("Preparing SSH...")

internal/codespaces/codespaces.go

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ import (
1313
)
1414

1515
var (
16-
ErrNoCodespaces = errors.New("You have no codespaces.")
16+
ErrNoCodespaces = errors.New("You have no Codespaces.")
1717
)
1818

1919
func ChooseCodespace(ctx context.Context, apiClient *api.API, user *api.User) (*api.Codespace, error) {
2020
codespaces, err := apiClient.ListCodespaces(ctx, user)
2121
if err != nil {
22-
return nil, fmt.Errorf("error getting codespaces: %v", err)
22+
return nil, fmt.Errorf("error getting Codespaces: %v", err)
2323
}
2424

2525
if len(codespaces) == 0 {
@@ -77,9 +77,9 @@ func ConnectToLiveshare(ctx context.Context, log logger, apiClient *api.API, use
7777
var startedCodespace bool
7878
if codespace.Environment.State != api.CodespaceEnvironmentStateAvailable {
7979
startedCodespace = true
80-
log.Print("Starting your codespace...")
80+
log.Print("Starting your Codespace...")
8181
if err := apiClient.StartCodespace(ctx, token, codespace); err != nil {
82-
return nil, fmt.Errorf("error starting codespace: %v", err)
82+
return nil, fmt.Errorf("error starting Codespace: %v", err)
8383
}
8484
}
8585

@@ -93,20 +93,20 @@ func ConnectToLiveshare(ctx context.Context, log logger, apiClient *api.API, use
9393
}
9494

9595
if retries == 30 {
96-
return nil, errors.New("timed out while waiting for the codespace to start")
96+
return nil, errors.New("timed out while waiting for the Codespace to start")
9797
}
9898

9999
codespace, err = apiClient.GetCodespace(ctx, token, userLogin, codespace.Name)
100100
if err != nil {
101-
return nil, fmt.Errorf("error getting codespace: %v", err)
101+
return nil, fmt.Errorf("error getting Codespace: %v", err)
102102
}
103103
}
104104

105105
if startedCodespace {
106106
fmt.Print("\n")
107107
}
108108

109-
log.Println("Connecting to your codespace...")
109+
log.Println("Connecting to your Codespace...")
110110

111111
lsclient, err := liveshare.NewClient(
112112
liveshare.WithConnection(liveshare.Connection{
@@ -117,11 +117,11 @@ func ConnectToLiveshare(ctx context.Context, log logger, apiClient *api.API, use
117117
}),
118118
)
119119
if err != nil {
120-
return nil, fmt.Errorf("error creating live share: %v", err)
120+
return nil, fmt.Errorf("error creating Live Share: %v", err)
121121
}
122122

123123
if err := lsclient.Join(ctx); err != nil {
124-
return nil, fmt.Errorf("error joining liveshare client: %v", err)
124+
return nil, fmt.Errorf("error joining Live Share client: %v", err)
125125
}
126126

127127
return lsclient, nil
@@ -134,23 +134,23 @@ func GetOrChooseCodespace(ctx context.Context, apiClient *api.API, user *api.Use
134134
if err == ErrNoCodespaces {
135135
return nil, "", err
136136
}
137-
return nil, "", fmt.Errorf("choosing codespace: %v", err)
137+
return nil, "", fmt.Errorf("choosing Codespace: %v", err)
138138
}
139139
codespaceName = codespace.Name
140140

141141
token, err = apiClient.GetCodespaceToken(ctx, user.Login, codespaceName)
142142
if err != nil {
143-
return nil, "", fmt.Errorf("getting codespace token: %v", err)
143+
return nil, "", fmt.Errorf("getting Codespace token: %v", err)
144144
}
145145
} else {
146146
token, err = apiClient.GetCodespaceToken(ctx, user.Login, codespaceName)
147147
if err != nil {
148-
return nil, "", fmt.Errorf("getting codespace token for given codespace: %v", err)
148+
return nil, "", fmt.Errorf("getting Codespace token for given codespace: %v", err)
149149
}
150150

151151
codespace, err = apiClient.GetCodespace(ctx, token, user.Login, codespaceName)
152152
if err != nil {
153-
return nil, "", fmt.Errorf("getting full codespace details: %v", err)
153+
return nil, "", fmt.Errorf("getting full Codespace details: %v", err)
154154
}
155155
}
156156

internal/codespaces/ssh.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ func MakeSSHTunnel(ctx context.Context, lsclient *liveshare.Client, serverPort i
1919

2020
server, err := liveshare.NewServer(lsclient)
2121
if err != nil {
22-
return 0, nil, fmt.Errorf("new liveshare server: %v", err)
22+
return 0, nil, fmt.Errorf("new Live Share server: %v", err)
2323
}
2424

2525
rand.Seed(time.Now().Unix())

0 commit comments

Comments
 (0)