Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit3865f36

Browse files
committed
Fix typescript linter
1 parent2379c21 commit3865f36

File tree

2 files changed

+43
-64
lines changed

2 files changed

+43
-64
lines changed

‎scripts/apitypings/main.go

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -268,8 +268,9 @@ func (g *Generator) buildStruct(obj types.Object, st *types.Struct) (string, err
268268
}
269269
}
270270

271-
iftsType.Comment!="" {
272-
_,_=s.WriteString(fmt.Sprintf("%s// %s\n",indent,tsType.Comment))
271+
iftsType.AboveTypeLine!="" {
272+
_,_=s.WriteString(tsType.AboveTypeLine)
273+
_,_=s.WriteRune('\n')
273274
}
274275
optional:=""
275276
iftsType.Optional {
@@ -283,7 +284,9 @@ func (g *Generator) buildStruct(obj types.Object, st *types.Struct) (string, err
283284

284285
typeTypescriptTypestruct {
285286
ValueTypestring
286-
Commentstring
287+
// AboveTypeLine lets you put whatever text you want above the typescript
288+
// type line.
289+
AboveTypeLinestring
287290
// Optional indicates the value is an optional field in typescript.
288291
Optionalbool
289292
}
@@ -304,7 +307,7 @@ func (g *Generator) typescriptType(ty types.Type) (TypescriptType, error) {
304307
returnTypescriptType{ValueType:"boolean"},nil
305308
casebs.Kind()==types.Byte:
306309
// TODO: @emyrk What is a byte for typescript? A string? A uint8?
307-
returnTypescriptType{ValueType:"number",Comment:"This is a byte in golang"},nil
310+
returnTypescriptType{ValueType:"number",AboveTypeLine:indentedComment("This is a byte in golang")},nil
308311
default:
309312
returnTypescriptType{ValueType:bs.Name()},nil
310313
}
@@ -316,7 +319,13 @@ func (g *Generator) typescriptType(ty types.Type) (TypescriptType, error) {
316319
// Field string `json:"field"`
317320
// }
318321
// }
319-
returnTypescriptType{ValueType:"any",Comment:"Embedded struct, please fix by naming it"},nil
322+
returnTypescriptType{
323+
ValueType:"any",
324+
AboveTypeLine:fmt.Sprintf("%s\n%s",
325+
indentedComment("Embedded struct, please fix by naming it"),
326+
indentedComment("eslint-disable-next-line @typescript-eslint/no-explicit-any"),
327+
),
328+
},nil
320329
case*types.Map:
321330
// map[string][string] -> Record<string, string>
322331
m:=ty
@@ -352,7 +361,7 @@ func (g *Generator) typescriptType(ty types.Type) (TypescriptType, error) {
352361
iferr!=nil {
353362
returnTypescriptType{},xerrors.Errorf("array: %w",err)
354363
}
355-
returnTypescriptType{ValueType:underlying.ValueType+"[]",Comment:underlying.Comment},nil
364+
returnTypescriptType{ValueType:underlying.ValueType+"[]",AboveTypeLine:underlying.AboveTypeLine},nil
356365
}
357366
case*types.Named:
358367
n:=ty
@@ -377,19 +386,24 @@ func (g *Generator) typescriptType(ty types.Type) (TypescriptType, error) {
377386
returnTypescriptType{ValueType:"string",Optional:true},nil
378387
case"github.com/google/uuid.NullUUID":
379388
returnTypescriptType{ValueType:"string",Optional:true},nil
389+
case"github.com/google/uuid.UUID":
390+
returnTypescriptType{ValueType:"string"},nil
380391
}
381392

382393
// If it's a struct, just use the name of the struct type
383394
if_,ok:=n.Underlying().(*types.Struct);ok {
384-
returnTypescriptType{ValueType:"any",Comment:fmt.Sprintf("Named type %q unknown, using\"any\"",n.String())},nil
395+
returnTypescriptType{ValueType:"any",AboveTypeLine:fmt.Sprintf("%s\n%s",
396+
indentedComment(fmt.Sprintf("Named type %q unknown, using\"any\"",n.String())),
397+
indentedComment("eslint-disable-next-line @typescript-eslint/no-explicit-any"),
398+
)},nil
385399
}
386400

387401
// Defer to the underlying type.
388402
ts,err:=g.typescriptType(ty.Underlying())
389403
iferr!=nil {
390404
returnTypescriptType{},xerrors.Errorf("named underlying: %w",err)
391405
}
392-
ts.Comment="This is likely an enum in an external package"
406+
ts.AboveTypeLine=indentedComment(fmt.Sprintf("This is likely an enum in an external package (%q)",n.String()))
393407
returnts,nil
394408
case*types.Pointer:
395409
// Dereference pointers.
@@ -406,3 +420,7 @@ func (g *Generator) typescriptType(ty types.Type) (TypescriptType, error) {
406420
// time.Time, uuid, etc.
407421
returnTypescriptType{},xerrors.Errorf("unknown type: %s",ty.String())
408422
}
423+
424+
funcindentedComment(commentstring)string {
425+
returnfmt.Sprintf("%s// %s",indent,comment)
426+
}

‎site/src/api/typesGenerated.ts

Lines changed: 17 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,7 @@ export interface CreateFirstUserRequest {
4040

4141
// From codersdk/users.go:56:6
4242
exportinterfaceCreateFirstUserResponse{
43-
// This is likely an enum in an external package
4443
readonlyuser_id:string
45-
// This is likely an enum in an external package
4644
readonlyorganization_id:string
4745
}
4846

@@ -55,28 +53,26 @@ export interface CreateOrganizationRequest {
5553
exportinterfaceCreateParameterRequest{
5654
readonlyname:string
5755
readonlysource_value:string
58-
// This is likely an enum in an external package
56+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterSourceScheme")
5957
readonlysource_scheme:string
60-
// This is likely an enum in an external package
58+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterDestinationScheme")
6159
readonlydestination_scheme:string
6260
}
6361

6462
// From codersdk/organizations.go:38:6
6563
exportinterfaceCreateTemplateRequest{
6664
readonlyname:string
67-
// This is likely an enum in an external package
6865
readonlytemplate_version_id:string
6966
readonlyparameter_values:CreateParameterRequest[]
7067
}
7168

7269
// From codersdk/organizations.go:25:6
7370
exportinterfaceCreateTemplateVersionRequest{
74-
// This is likely an enum in an external package
7571
readonlytemplate_id:string
76-
// This is likely an enum in an external package
72+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ProvisionerStorageMethod")
7773
readonlystorage_method:string
7874
readonlystorage_source:string
79-
// This is likely an enum in an external package
75+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ProvisionerType")
8076
readonlyprovisioner:string
8177
readonlyparameter_values:CreateParameterRequest[]
8278
}
@@ -86,22 +82,19 @@ export interface CreateUserRequest {
8682
readonlyemail:string
8783
readonlyusername:string
8884
readonlypassword:string
89-
// This is likely an enum in an external package
9085
readonlyorganization_id:string
9186
}
9287

9388
// From codersdk/workspaces.go:33:6
9489
exportinterfaceCreateWorkspaceBuildRequest{
95-
// This is likely an enum in an external package
9690
readonlytemplate_version_id:string
97-
// This is likely an enum in an external package
91+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.WorkspaceTransition")
9892
readonlytransition:string
9993
readonlydry_run:boolean
10094
}
10195

10296
// From codersdk/organizations.go:52:6
10397
exportinterfaceCreateWorkspaceRequest{
104-
// This is likely an enum in an external package
10598
readonlytemplate_id:string
10699
readonlyname:string
107100
readonlyparameter_values:CreateParameterRequest[]
@@ -114,7 +107,6 @@ export interface GenerateAPIKeyResponse {
114107

115108
// From codersdk/gitsshkey.go:14:6
116109
exportinterfaceGitSSHKey{
117-
// This is likely an enum in an external package
118110
readonlyuser_id:string
119111
readonlycreated_at:string
120112
readonlyupdated_at:string
@@ -139,7 +131,6 @@ export interface LoginWithPasswordResponse {
139131

140132
// From codersdk/organizations.go:17:6
141133
exportinterfaceOrganization{
142-
// This is likely an enum in an external package
143134
readonlyid:string
144135
readonlyname:string
145136
readonlycreated_at:string
@@ -148,79 +139,68 @@ export interface Organization {
148139

149140
// From codersdk/parameters.go:26:6
150141
exportinterfaceParameter{
151-
// This is likely an enum in an external package
152142
readonlyid:string
153143
readonlycreated_at:string
154144
readonlyupdated_at:string
155145
readonlyscope:ParameterScope
156-
// This is likely an enum in an external package
157146
readonlyscope_id:string
158147
readonlyname:string
159-
// This is likely an enum in an external package
148+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterSourceScheme")
160149
readonlysource_scheme:string
161-
// This is likely an enum in an external package
150+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterDestinationScheme")
162151
readonlydestination_scheme:string
163152
}
164153

165154
// From codersdk/provisionerdaemons.go:23:6
166155
exportinterfaceProvisionerDaemon{
167-
// This is likely an enum in an external package
168156
readonlyid:string
169157
readonlycreated_at:string
170158
readonlyupdated_at?:string
171159
readonlyorganization_id?:string
172160
readonlyname:string
173-
// This is likely an enum in an external package
161+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ProvisionerType")
174162
readonlyprovisioners:string[]
175163
}
176164

177165
// From codersdk/provisionerdaemons.go:46:6
178166
exportinterfaceProvisionerJob{
179-
// This is likely an enum in an external package
180167
readonlyid:string
181168
readonlycreated_at:string
182169
readonlystarted_at?:string
183170
readonlycompleted_at?:string
184171
readonlyerror:string
185172
readonlystatus:ProvisionerJobStatus
186-
// This is likely an enum in an external package
187173
readonlyworker_id?:string
188174
}
189175

190176
// From codersdk/provisionerdaemons.go:56:6
191177
exportinterfaceProvisionerJobLog{
192-
// This is likely an enum in an external package
193178
readonlyid:string
194179
readonlycreated_at:string
195-
// This is likely an enum in an external package
180+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.LogSource")
196181
readonlylog_source:string
197-
// This is likely an enum in an external package
182+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.LogLevel")
198183
readonlylog_level:string
199184
readonlystage:string
200185
readonlyoutput:string
201186
}
202187

203188
// From codersdk/templates.go:17:6
204189
exportinterfaceTemplate{
205-
// This is likely an enum in an external package
206190
readonlyid:string
207191
readonlycreated_at:string
208192
readonlyupdated_at:string
209-
// This is likely an enum in an external package
210193
readonlyorganization_id:string
211194
readonlyname:string
212-
// This is likely an enum in an external package
195+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ProvisionerType")
213196
readonlyprovisioner:string
214-
// This is likely an enum in an external package
215197
readonlyactive_version_id:string
216198
readonlyworkspace_owner_count:number
217199
}
218200

219201
// From codersdk/templateversions.go:17:6
220202
exportinterfaceTemplateVersion{
221-
// This is likely an enum in an external package
222203
readonlyid:string
223-
// This is likely an enum in an external package
224204
readonlytemplate_id?:string
225205
readonlycreated_at:string
226206
readonlyupdated_at:string
@@ -231,40 +211,37 @@ export interface TemplateVersion {
231211
// From codersdk/templateversions.go:30:6
232212
exportinterfaceTemplateVersionParameter{
233213
// Named type "github.com/coder/coder/coderd/database.ParameterValue" unknown, using "any"
214+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
234215
readonlyParameterValue:any
235-
// This is likely an enum in an external package
236216
readonlyschema_id:string
237217
readonlydefault_source_value:boolean
238218
}
239219

240220
// From codersdk/templateversions.go:27:6
241221
exportinterfaceTemplateVersionParameterSchema{
242-
// This is likely an enum in an external package
243222
readonlyid:string
244223
readonlycreated_at:string
245-
// This is likely an enum in an external package
246224
readonlyjob_id:string
247225
readonlyname:string
248226
readonlydescription:string
249-
// This is likely an enum in an external package
227+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterSourceScheme")
250228
readonlydefault_source_scheme:string
251229
readonlydefault_source_value:string
252230
readonlyallow_override_source:boolean
253-
// This is likely an enum in an external package
231+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterDestinationScheme")
254232
readonlydefault_destination_scheme:string
255233
readonlyallow_override_destination:boolean
256234
readonlydefault_refresh:string
257235
readonlyredisplay_value:boolean
258236
readonlyvalidation_error:string
259237
readonlyvalidation_condition:string
260-
// This is likely an enum in an external package
238+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterTypeSystem")
261239
readonlyvalidation_type_system:string
262240
readonlyvalidation_value_type:string
263241
}
264242

265243
// From codersdk/templates.go:28:6
266244
exportinterfaceUpdateActiveTemplateVersion{
267-
// This is likely an enum in an external package
268245
readonlyid:string
269246
}
270247

@@ -291,19 +268,16 @@ export interface UploadResponse {
291268

292269
// From codersdk/users.go:39:6
293270
exportinterfaceUser{
294-
// This is likely an enum in an external package
295271
readonlyid:string
296272
readonlyemail:string
297273
readonlycreated_at:string
298274
readonlyusername:string
299275
readonlystatus:UserStatus
300-
// This is likely an enum in an external package
301276
readonlyorganization_ids:string[]
302277
}
303278

304279
// From codersdk/users.go:17:6
305280
exportinterfaceUsersRequest{
306-
// This is likely an enum in an external package
307281
readonlyafter_user:string
308282
readonlysearch:string
309283
readonlylimit:number
@@ -312,13 +286,10 @@ export interface UsersRequest {
312286

313287
// From codersdk/workspaces.go:18:6
314288
exportinterfaceWorkspace{
315-
// This is likely an enum in an external package
316289
readonlyid:string
317290
readonlycreated_at:string
318291
readonlyupdated_at:string
319-
// This is likely an enum in an external package
320292
readonlyowner_id:string
321-
// This is likely an enum in an external package
322293
readonlytemplate_id:string
323294
readonlytemplate_name:string
324295
readonlylatest_build:WorkspaceBuild
@@ -330,7 +301,6 @@ export interface Workspace {
330301

331302
// From codersdk/workspaceresources.go:33:6
332303
exportinterfaceWorkspaceAgent{
333-
// This is likely an enum in an external package
334304
readonlyid:string
335305
readonlycreated_at:string
336306
readonlyupdated_at:string
@@ -339,7 +309,6 @@ export interface WorkspaceAgent {
339309
readonlydisconnected_at?:string
340310
readonlystatus:WorkspaceAgentStatus
341311
readonlyname:string
342-
// This is likely an enum in an external package
343312
readonlyresource_id:string
344313
readonlyinstance_id:string
345314
readonlyarchitecture:string
@@ -377,34 +346,26 @@ export interface WorkspaceAgentResourceMetadata {
377346

378347
// From codersdk/workspacebuilds.go:17:6
379348
exportinterfaceWorkspaceBuild{
380-
// This is likely an enum in an external package
381349
readonlyid:string
382350
readonlycreated_at:string
383351
readonlyupdated_at:string
384-
// This is likely an enum in an external package
385352
readonlyworkspace_id:string
386-
// This is likely an enum in an external package
387353
readonlytemplate_version_id:string
388-
// This is likely an enum in an external package
389354
readonlybefore_id:string
390-
// This is likely an enum in an external package
391355
readonlyafter_id:string
392356
readonlyname:string
393-
// This is likely an enum in an external package
357+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.WorkspaceTransition")
394358
readonlytransition:string
395-
// This is likely an enum in an external package
396359
readonlyinitiator_id:string
397360
readonlyjob:ProvisionerJob
398361
}
399362

400363
// From codersdk/workspaceresources.go:23:6
401364
exportinterfaceWorkspaceResource{
402-
// This is likely an enum in an external package
403365
readonlyid:string
404366
readonlycreated_at:string
405-
// This is likely an enum in an external package
406367
readonlyjob_id:string
407-
// This is likely an enum in an external package
368+
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.WorkspaceTransition")
408369
readonlyworkspace_transition:string
409370
readonlytype:string
410371
readonlyname:string

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp