How would you like Schema to struct generation to look like?

[Oudwins]

One of the next features I would like to work on is a CLI to generate structs based on your ZogSchemas. This is a good first step for other generators based on the ZogSchemas such as but not limited to:

• typescript types
• Zod schemas
• openapi specs
• ...

With that in mind I would like to pool you all on a few things:

• Any other output you would like? (a part from the ones mentioned above)
• Once you run the CLI should the generation be opt in or opt out? i.e should running the CLI automatically generate all corresponding structs unless your ZogSchema has some magic comment above it or only generate those that have that magic comment?
• Ideas on the generated names for the structs. I think the best solution is to use standard naming convention for default generated names but allow the user to specify a struct name with a magic comment. For example, if no magic comment is set userSchema would generate a type User struct

[luckycatx]

Any other output you would like? (a part from the ones mentioned above)

No idea yet

Once you run the CLI should the generation be opt in or opt out? i.e should running the CLI automatically generate all corresponding structs unless your ZogSchema has some magic comment above it or only generate those that have that magic comment?

Generate those that have the magic comment would be better. It would be easier and cleaner for embedding with existing codegen (e.g. rpc, db code generation)

Ideas on the generated names for the structs. I think the best solution is to use standard naming convention for default generated names but allow the user to specify a struct name with a magic comment. For example, if no magic comment is set userSchema would generate a type User struct

I have no opinion on schema -> struct, but for struct -> schema I would prefer the generated string reference typed field names the same as the original field names (instead of lowercase the first letter)

[IngwiePhoenix]

Any other output you would like?

Some form of JSON. I was thinking how I could make validation from client to server consume less requests (and reduce waiting) so I thought in a HTMX/DataStar (or AlpineJS) it might be faster to have a little JSON object that can be embedded in a response, and a little library that can infer the schema from that and use it. That said - this is basically "shower thoughts" level of idea... It makes more sense to use Zod, to be honest, but it would be interesting.

Once you run the CLI should the generation be opt in or opt out? i.e should running the CLI automatically generate all corresponding structs unless your ZogSchema has some magic comment above it or only generate those that have that magic comment?

Go already has compiler directives like //go:embed, //go:generate and friends. Having a //zog:ts,openapi,zod isn't too bad. However, if the preference changes, it would have to be (re-)specified everywhere. Perhaps opt-in via CLI flag? zog-gen --for=ts,openapi,zod ./...?

Ideas on the generated names for the structs. (...)

Your idea is good! Could also opt for a no-op function (schema.Name("...")) but I think transforming userScheme to User is a very sane default. I mean I would probably write contractStatusScheme or eventTypeScheme too, which would directly translate to ContractStatus and EventType respectively. Honestly sounds good to me. =)