Skip to content

Commit 3de2930

Browse files
EmyrkEmyrk
authored
chore: Remove some of the external enum comments in typescript (coder#6530)
* chore: Remove some of the external enum comments in typescript handle clibase types manually
1 parent c2787e3 commit 3de2930

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
switch n.String() {
698+
case "github.com/coder/coder/cli/clibase.String":
699+
return TypescriptType{ValueType: "string"}, nil
700+
case "github.com/coder/coder/cli/clibase.Strings":
701+
return TypescriptType{ValueType: "string[]"}, nil
702+
case "github.com/coder/coder/cli/clibase.Int64":
703+
return TypescriptType{ValueType: "number"}, nil
704+
case "github.com/coder/coder/cli/clibase.Bool":
705+
return TypescriptType{ValueType: "boolean"}, nil
706+
case "github.com/coder/coder/cli/clibase.Duration":
707+
return TypescriptType{ValueType: "number"}, nil
698708
case "net/url.URL":
699709
return TypescriptType{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
export interface DERPConfig {
275-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
276275
readonly url: string
277-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
278276
readonly path: string
279277
}
280278

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

287285
// From codersdk/deployment.go
288286
export interface DERPServerConfig {
289-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
290287
readonly enable: boolean
291-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Int64")
292288
readonly region_id: number
293-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
294289
readonly region_code: string
295-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
296290
readonly region_name: string
297-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
298291
readonly stun_addresses: string[]
299292
readonly relay_url: string
300293
}
301294

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

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

324315
// From codersdk/deployment.go
325316
export interface DeploymentValues {
326-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
327317
readonly verbose?: boolean
328318
readonly access_url?: string
329319
readonly wildcard_access_url?: string
330-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
331320
readonly redirect_to_access_url?: boolean
332-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
333321
readonly http_address?: string
334-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
335322
readonly autobuild_poll_interval?: number
336323
readonly derp?: DERP
337324
readonly prometheus?: PrometheusConfig
338325
readonly pprof?: PprofConfig
339-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
340326
readonly proxy_trusted_headers?: string[]
341-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
342327
readonly proxy_trusted_origins?: string[]
343-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
344328
readonly cache_directory?: string
345-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
346329
readonly in_memory_database?: boolean
347-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
348330
readonly pg_connection_url?: string
349331
readonly oauth2?: OAuth2Config
350332
readonly oidc?: OIDCConfig
351333
readonly telemetry?: TelemetryConfig
352334
readonly tls?: TLSConfig
353335
readonly trace?: TraceConfig
354-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
355336
readonly secure_auth_cookie?: boolean
356-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Int64")
357337
readonly strict_transport_security?: number
358-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
359338
readonly strict_transport_security_options?: string[]
360-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
361339
readonly ssh_keygen_algorithm?: string
362-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
363340
readonly metrics_cache_refresh_interval?: number
364-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
365341
readonly agent_stat_refresh_interval?: number
366342
readonly agent_fallback_troubleshooting_url?: string
367-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
368343
readonly audit_logging?: boolean
369-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
370344
readonly browser_only?: boolean
371-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
372345
readonly scim_api_key?: string
373346
readonly provisioner?: ProvisionerConfig
374347
readonly rate_limit?: RateLimitConfig
375-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
376348
readonly experiments?: string[]
377-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
378349
readonly update_check?: boolean
379-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
380350
readonly max_token_lifetime?: number
381351
readonly swagger?: SwaggerConfig
382352
readonly logging?: LoggingConfig
383353
readonly dangerous?: DangerousConfig
384-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
385354
readonly disable_path_apps?: boolean
386-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
387355
readonly max_session_expiry?: number
388-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
389356
readonly disable_session_expiry_refresh?: boolean
390-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
391357
readonly disable_password_auth?: boolean
392358
readonly support?: 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
readonly git_auth?: any
396-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
397362
readonly config?: string
398-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
399363
readonly write_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
export interface LoggingConfig {
493-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
494457
readonly human: string
495-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
496458
readonly json: string
497-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
498459
readonly stackdriver: string
499460
}
500461

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

517478
// From codersdk/deployment.go
518479
export interface OAuth2GithubConfig {
519-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
520480
readonly client_id: string
521-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
522481
readonly client_secret: string
523-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
524482
readonly allowed_orgs: string[]
525-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
526483
readonly allowed_teams: string[]
527-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
528484
readonly allow_signups: boolean
529-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
530485
readonly allow_everyone: boolean
531-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
532486
readonly enterprise_base_url: string
533487
}
534488

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

541495
// From codersdk/deployment.go
542496
export interface OIDCConfig {
543-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
544497
readonly allow_signups: boolean
545-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
546498
readonly client_id: string
547-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
548499
readonly client_secret: string
549-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
550500
readonly email_domain: string[]
551-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
552501
readonly issuer_url: string
553-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
554502
readonly scopes: string[]
555-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
556503
readonly ignore_email_verified: boolean
557-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
558504
readonly username_field: string
559-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
560505
readonly sign_in_text: string
561506
readonly icon_url: string
562507
}
@@ -629,7 +574,6 @@ export interface PatchGroupRequest {
629574

630575
// From codersdk/deployment.go
631576
export interface PprofConfig {
632-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
633577
readonly enable: 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
export interface PrometheusConfig {
641-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
642585
readonly enable: 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
export interface ProvisionerConfig {
650-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Int64")
651593
readonly daemons: number
652-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
653594
readonly daemon_poll_interval: number
654-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
655595
readonly daemon_poll_jitter: number
656-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Duration")
657596
readonly force_cancel_interval: number
658597
}
659598

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

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

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

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

767703
// From codersdk/deployment.go
768704
export interface TLSConfig {
769-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
770705
readonly enable: 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
readonly address: any
774-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
775709
readonly redirect_http: boolean
776-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
777710
readonly cert_file: string[]
778-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
779711
readonly client_auth: string
780-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
781712
readonly client_ca_file: string
782-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Strings")
783713
readonly key_file: string[]
784-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
785714
readonly min_version: string
786-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
787715
readonly client_cert_file: string
788-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
789716
readonly client_key_file: string
790717
}
791718

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

928853
// From codersdk/deployment.go
929854
export interface TraceConfig {
930-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
931855
readonly enable: boolean
932-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.String")
933856
readonly honeycomb_api_key: string
934-
// This is likely an enum in an external package ("github.com/coder/coder/cli/clibase.Bool")
935857
readonly capture_logs: boolean
936858
}
937859

0 commit comments

Comments
 (0)