Some thoughts

[dvv]

Feature description

I would like to discuss whether the following features are feasible to have in the mainstream:

jsdoc tag to apply .coerce to the schema

Input

  /**
   * @coerce true
   */
  type MaybeInt = number

Output

  const maybeIntSchema = z.coerce.number()

NB: may be generalized as the following

jsdoc tag override schema definition

Input

  /**
   * @schema z.coerce.number().int().refine(x => x % 2)
   */
  type MaybeOddInt = number

Output

  const maybeOddIntSchema = z.coerce.number().int().refine(x => x % 2)

support z.enum() for simple text enums

Input

  type LoggerLevel = "debug" | "info" | "warning" | "error" | "critical"

Output

  const loggerLevelSchema = z.enum(["debug", "info", "warning", "error", "critical"] as const)

jsdoc tag for discriminatedUnion

Input

  export enum LoggerKind { console, file }
  interface ILogger {
    kind: LoggerKind
  }
  interface LoggerConsole extends ILogger {
    kind: LoggerKind.console
  }
  interface LoggerFile extends ILogger {
    kind: LoggerKind.file
    filename: string
  }
  /**
   * @tag kind
   */
  // NB: treat the following as discriminatedUnion
  export type Logger = LoggerConsole | LoggerFile

NB: may be better to directly mark ILogger field as discriminator?

Output

  const iLoggerSchema = z.object({
    kind: loggerKindSchema,
  });

  const loggerConsoleSchema = iLoggerSchema.extend({
    kind: z.literal(LoggerKind.console),
  });

  const loggerFileSchema = iLoggerSchema.extend({
    kind: z.literal(LoggerKind.file),
    filename: z.string(),
  });

  export const loggerSchema = z.discriminatedUnion("kind", [loggerConsole, loggerFile])

support Deno style imports (".ts")

Output

  // Generated by ts-to-zod
  import { z } from "zod.ts";
  import { LoggerLevel } from "./../proto/src.ts";

support output file header template

Say, via a --header file.ts command line option

Output

  // This is a custom header
  import { z } from "../deps.ts";
  // Generated by ts-to-zod
  ... here goes the compilation result

TIA

[t-animal]

support z.enum() for simple text enums

For these scenarios I personally prefer doing it like this:

export const LoggerLevels = [ "debug", "info", "warning", "error", "critical"] as const;
export type LoggerLevel = typeof LoggerLevels[number];

because this bridges the gap between runtime and static type system nicely. Unfortunately it's also not supported by ts-to-zod.

[fabien0102]

A lot of amazing ideas over here! I'm laking a bit of time right now to work on this project, but I'm keeping an eye on this 😃