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

Commit3de2930

Browse files
authored
chore: Remove some of the external enum comments in typescript (#6530)
* chore: Remove some of the external enum comments in typescripthandle clibase types manually
1 parentc2787e3 commit3de2930

File tree

2 files changed

+10
-78
lines changed

2 files changed

+10
-78
lines changed

‎scripts/apitypings/main.go

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -695,6 +695,16 @@ func (g *Generator) typescriptType(ty types.Type) (TypescriptType, error) {
695695

696696
// These are external named types that we handle uniquely.
697697
switchn.String() {
698+
case"github.com/coder/coder/cli/clibase.String":
699+
returnTypescriptType{ValueType:"string"},nil
700+
case"github.com/coder/coder/cli/clibase.Strings":
701+
returnTypescriptType{ValueType:"string[]"},nil
702+
case"github.com/coder/coder/cli/clibase.Int64":
703+
returnTypescriptType{ValueType:"number"},nil
704+
case"github.com/coder/coder/cli/clibase.Bool":
705+
returnTypescriptType{ValueType:"boolean"},nil
706+
case"github.com/coder/coder/cli/clibase.Duration":
707+
returnTypescriptType{ValueType:"number"},nil
698708
case"net/url.URL":
699709
returnTypescriptType{ValueType:"string"},nil
700710
case"time.Time":

‎site/src/api/typesGenerated.ts

Lines changed: 0 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -272,9 +272,7 @@ export interface DERP {
272272

273273
// From codersdk/deployment.go
274274
exportinterfaceDERPConfig{
275-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
276275
readonlyurl:string
277-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
278276
readonlypath:string
279277
}
280278

@@ -286,24 +284,17 @@ export interface DERPRegion {
286284

287285
// From codersdk/deployment.go
288286
exportinterfaceDERPServerConfig{
289-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
290287
readonlyenable:boolean
291-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Int64")
292288
readonlyregion_id:number
293-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
294289
readonlyregion_code:string
295-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
296290
readonlyregion_name:string
297-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
298291
readonlystun_addresses:string[]
299292
readonlyrelay_url:string
300293
}
301294

302295
// From codersdk/deployment.go
303296
exportinterfaceDangerousConfig{
304-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
305297
readonlyallow_path_app_sharing:boolean
306-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
307298
readonlyallow_path_app_site_owner_access:boolean
308299
}
309300

@@ -323,79 +314,52 @@ export interface DeploymentStats {
323314

324315
// From codersdk/deployment.go
325316
exportinterfaceDeploymentValues{
326-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
327317
readonlyverbose?:boolean
328318
readonlyaccess_url?:string
329319
readonlywildcard_access_url?:string
330-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
331320
readonlyredirect_to_access_url?:boolean
332-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
333321
readonlyhttp_address?:string
334-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
335322
readonlyautobuild_poll_interval?:number
336323
readonlyderp?:DERP
337324
readonlyprometheus?:PrometheusConfig
338325
readonlypprof?:PprofConfig
339-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
340326
readonlyproxy_trusted_headers?:string[]
341-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
342327
readonlyproxy_trusted_origins?:string[]
343-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
344328
readonlycache_directory?:string
345-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
346329
readonlyin_memory_database?:boolean
347-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
348330
readonlypg_connection_url?:string
349331
readonlyoauth2?:OAuth2Config
350332
readonlyoidc?:OIDCConfig
351333
readonlytelemetry?:TelemetryConfig
352334
readonlytls?:TLSConfig
353335
readonlytrace?:TraceConfig
354-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
355336
readonlysecure_auth_cookie?:boolean
356-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Int64")
357337
readonlystrict_transport_security?:number
358-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
359338
readonlystrict_transport_security_options?:string[]
360-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
361339
readonlyssh_keygen_algorithm?:string
362-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
363340
readonlymetrics_cache_refresh_interval?:number
364-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
365341
readonlyagent_stat_refresh_interval?:number
366342
readonlyagent_fallback_troubleshooting_url?:string
367-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
368343
readonlyaudit_logging?:boolean
369-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
370344
readonlybrowser_only?:boolean
371-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
372345
readonlyscim_api_key?:string
373346
readonlyprovisioner?:ProvisionerConfig
374347
readonlyrate_limit?:RateLimitConfig
375-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
376348
readonlyexperiments?:string[]
377-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
378349
readonlyupdate_check?:boolean
379-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
380350
readonlymax_token_lifetime?:number
381351
readonlyswagger?:SwaggerConfig
382352
readonlylogging?:LoggingConfig
383353
readonlydangerous?:DangerousConfig
384-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
385354
readonlydisable_path_apps?:boolean
386-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
387355
readonlymax_session_expiry?:number
388-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
389356
readonlydisable_session_expiry_refresh?:boolean
390-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
391357
readonlydisable_password_auth?:boolean
392358
readonlysupport?:SupportConfig
393359
// Named type "github.com/coder/coder/cli/clibase.Struct[[]github.com/coder/coder/codersdk.GitAuthConfig]" unknown, using "any"
394360
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO explain why this is needed
395361
readonlygit_auth?:any
396-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
397362
readonlyconfig?:string
398-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
399363
readonlywrite_config?:boolean
400364
// Named type "github.com/coder/coder/cli/clibase.HostPort" unknown, using "any"
401365
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO explain why this is needed
@@ -490,11 +454,8 @@ export interface LinkConfig {
490454

491455
// From codersdk/deployment.go
492456
exportinterfaceLoggingConfig{
493-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
494457
readonlyhuman:string
495-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
496458
readonlyjson:string
497-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
498459
readonlystackdriver:string
499460
}
500461

@@ -516,19 +477,12 @@ export interface OAuth2Config {
516477

517478
// From codersdk/deployment.go
518479
exportinterfaceOAuth2GithubConfig{
519-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
520480
readonlyclient_id:string
521-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
522481
readonlyclient_secret:string
523-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
524482
readonlyallowed_orgs:string[]
525-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
526483
readonlyallowed_teams:string[]
527-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
528484
readonlyallow_signups:boolean
529-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
530485
readonlyallow_everyone:boolean
531-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
532486
readonlyenterprise_base_url:string
533487
}
534488

@@ -540,23 +494,14 @@ export interface OIDCAuthMethod extends AuthMethod {
540494

541495
// From codersdk/deployment.go
542496
exportinterfaceOIDCConfig{
543-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
544497
readonlyallow_signups:boolean
545-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
546498
readonlyclient_id:string
547-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
548499
readonlyclient_secret:string
549-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
550500
readonlyemail_domain:string[]
551-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
552501
readonlyissuer_url:string
553-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
554502
readonlyscopes:string[]
555-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
556503
readonlyignore_email_verified:boolean
557-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
558504
readonlyusername_field:string
559-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
560505
readonlysign_in_text:string
561506
readonlyicon_url:string
562507
}
@@ -629,7 +574,6 @@ export interface PatchGroupRequest {
629574

630575
// From codersdk/deployment.go
631576
exportinterfacePprofConfig{
632-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
633577
readonlyenable:boolean
634578
// Named type "github.com/coder/coder/cli/clibase.HostPort" unknown, using "any"
635579
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO explain why this is needed
@@ -638,7 +582,6 @@ export interface PprofConfig {
638582

639583
// From codersdk/deployment.go
640584
exportinterfacePrometheusConfig{
641-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
642585
readonlyenable:boolean
643586
// Named type "github.com/coder/coder/cli/clibase.HostPort" unknown, using "any"
644587
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO explain why this is needed
@@ -647,13 +590,9 @@ export interface PrometheusConfig {
647590

648591
// From codersdk/deployment.go
649592
exportinterfaceProvisionerConfig{
650-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Int64")
651593
readonlydaemons:number
652-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
653594
readonlydaemon_poll_interval:number
654-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
655595
readonlydaemon_poll_jitter:number
656-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
657596
readonlyforce_cancel_interval:number
658597
}
659598

@@ -699,9 +638,7 @@ export interface PutExtendWorkspaceRequest {
699638

700639
// From codersdk/deployment.go
701640
exportinterfaceRateLimitConfig{
702-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
703641
readonlydisable_all:boolean
704-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Int64")
705642
readonlyapi:number
706643
}
707644

@@ -760,40 +697,28 @@ export interface SupportConfig {
760697

761698
// From codersdk/deployment.go
762699
exportinterfaceSwaggerConfig{
763-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
764700
readonlyenable:boolean
765701
}
766702

767703
// From codersdk/deployment.go
768704
exportinterfaceTLSConfig{
769-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
770705
readonlyenable:boolean
771706
// Named type "github.com/coder/coder/cli/clibase.HostPort" unknown, using "any"
772707
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO explain why this is needed
773708
readonlyaddress:any
774-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
775709
readonlyredirect_http:boolean
776-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
777710
readonlycert_file:string[]
778-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
779711
readonlyclient_auth:string
780-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
781712
readonlyclient_ca_file:string
782-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
783713
readonlykey_file:string[]
784-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
785714
readonlymin_version:string
786-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
787715
readonlyclient_cert_file:string
788-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
789716
readonlyclient_key_file:string
790717
}
791718

792719
// From codersdk/deployment.go
793720
exportinterfaceTelemetryConfig{
794-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
795721
readonlyenable:boolean
796-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
797722
readonlytrace:boolean
798723
readonlyurl:string
799724
}
@@ -927,11 +852,8 @@ export interface TokensFilter {
927852

928853
// From codersdk/deployment.go
929854
exportinterfaceTraceConfig{
930-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
931855
readonlyenable:boolean
932-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
933856
readonlyhoneycomb_api_key:string
934-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
935857
readonlycapture_logs:boolean
936858
}
937859

0 commit comments

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