Go: impossible to tell which fields are required in a struct

[eladb]

🐛 Bug Report

Affected Languages

• Golang
• TypeScript or Javascript
• Python
• Java
• .NET (C#, F#, ...)

General Information

• JSII Version: 1.20.0
• Platform:

What is the problem?

When generating Go structs from jsii data types, there is currently no indication (let alone compile-type check) to tell users which fields in the struct are required and which are optional:

export interface MyDataType {
  readonly thisIsRequired: string;

  /** @default 10 */
  readonly thisIsOptional?: number;
}

Go output:

// This is my data type.
// Struct proxy
type MyDataType struct {
	// This is a required textual field.
	RequiredField string `json:"requiredField"`
	// This is an optional numeric field.
	OptionalField float64 `json:"optionalField"`
}

What are our options in Go to address this? At the minimum, we should obviously generate some documentation that indicates which fields are required and what are the default values. Is there a way to get type-checking help?

Addendum:

This issue tracks adding doc comments indicating which fields are required vs optional to ensure that this is available during autocompletion. IE, when a user starts typing a property name, the documentation for that property will be displayed in their IDE telling them whether the field is optional or required.

There is an additional ticket to panic at runtime when required fields are nil #2672

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.