[!TIP] @zod-codepen/vite-plugin provides seamless Vite integration for Zod schema serialization. Automatically transform and optimize your schemas at build time. Visit our documentation site for complete setup guide and examples.

Installation

npm install -D @zod-codepen/vite-plugin

Quick Start

// vite.config.ts
import { defineConfig } from 'vite';
import zodCodepen from '@zod-codepen/vite-plugin';

export default defineConfig({
  plugins: [
    zodCodepen({
      // Options
    })
  ]
});

Features

• 🚀 Build-time optimization - Transform schemas during build
• 🔧 Hot Module Replacement - Instant updates during development
• 📦 Tree-shaking friendly - Optimized bundle size
• 🎯 TypeScript support - Full type safety
• ⚡ Zero runtime overhead - All transformations at build time

Configuration

interface ZodCodepenOptions {
  // Include patterns for transformation
  include?: string | string[];

  // Exclude patterns
  exclude?: string | string[];

  // Output format
  format?: 'esm' | 'cjs';

  // Enable source maps
  sourcemap?: boolean;
}

Example Usage

// schemas.ts
import { z } from 'zod';

export const UserSchema = z.object({
  name: z.string(),
  email: z.string().email(),
  age: z.number().int().positive()
});

// With the plugin, this schema can be automatically serialized
// and optimized during build time

Documentation

For detailed configuration options and advanced usage:

• Getting Started
• Basic Usage
• API Reference
• Interactive Playground

Requirements

• Node.js ≥ 20
• Vite ≥ 5.0.0
• Zod ^3.0.0 or ^4.0.0

License

MPL-2.0 © CornWorld