Pre-defined Zod Schema to enable Theme Interoperability

[emeraldjava]

Body

Summary

In order to allow for easier switching of astro themes I want my content markdown files to follow a pre-defined zod schema so required and optional fields are know in advance. The astro platform would provide a set of base template zod schema configurations from which the user can select. Theme developers can code towards the same zod schema.

Background & Motivation

Allow easier switching between astro themes. At the moment it seems each astro theme declares it's own zod format. With these templates in place, it would mean we can create migration tools from format X to a specific astro zod format. Coming from hugo - theme switching was simpler.

Goals

A concise, bulleted-list outlining the intended goals of this RFC.

• A set of ?

Example A

const blogCollection = defineCollection({
  type: 'content',
  schema: z.object({
    title: z.string(),
    tags: z.array(z.string()),
    date: z.date(),
  }),
});

via https://github.com/nikolovlazar/egghead-personal-blog-astro/blob/lesson-8/src/content/config.ts

Example B

export const collections = {
  blog: defineCollection({
    schema: z.object({
      draft: z.boolean().default(false),
      date: z.date().transform((str) => new Date(str)),
      title: z.string(),
      slug: z.string().optional(),
      category: z.enum(['food', 'wisdom']),
      tags: z.array(z.string().optional()),
      share: z
        .object({
          image: z.string().optional(),
          title: z.string(),
          description: z.string(),
        })
        .strict(),
    }),
  }),
};

via https://github.com/learnwithjason/astro-content-collections/blob/main/src/content/config.ts

References

• https://docs.astro.build/en/guides/content-collections/#defining-a-collection-schema
• Upgrading astro-paper version for a site satnaing/astro-paper#393 (reply in thread)