zod

zod

Zod schema validation best practices for type safety, parsing, and error handling. This skill should be used when defining z.object schemas, using z.string validations, safeParse, or z.infer. This skill does NOT cover React Hook Form integration patterns (use react-hook-form skill) or OpenAPI client generation (use orval skill).

1estrelas
0forks
Atualizado 1/22/2026
SKILL.md
readonlyread-only
name
zod
description

Zod schema validation best practices for type safety, parsing, and error handling. This skill should be used when defining z.object schemas, using z.string validations, safeParse, or z.infer. This skill does NOT cover React Hook Form integration patterns (use react-hook-form skill) or OpenAPI client generation (use orval skill).

Zod Best Practices

Comprehensive schema validation guide for Zod in TypeScript applications. Contains 43 rules across 8 categories, prioritized by impact to guide automated refactoring and code generation.

When to Apply

Reference these guidelines when:

  • Writing new Zod schemas
  • Choosing between parse() and safeParse()
  • Implementing type inference with z.infer
  • Handling validation errors for user feedback
  • Composing complex object schemas
  • Using refinements and transforms
  • Optimizing bundle size and validation performance
  • Reviewing Zod code for best practices

Rule Categories by Priority

Priority Category Impact Prefix
1 Schema Definition CRITICAL schema-
2 Parsing & Validation CRITICAL parse-
3 Type Inference HIGH type-
4 Error Handling HIGH error-
5 Object Schemas MEDIUM-HIGH object-
6 Schema Composition MEDIUM compose-
7 Refinements & Transforms MEDIUM refine-
8 Performance & Bundle LOW-MEDIUM perf-

Quick Reference

1. Schema Definition (CRITICAL)

  • schema-use-primitives-correctly - Use correct primitive schemas for each type
  • schema-use-unknown-not-any - Use z.unknown() instead of z.any() for type safety
  • schema-avoid-optional-abuse - Avoid overusing optional fields
  • schema-string-validations - Apply string validations at schema definition
  • schema-use-enums - Use enums for fixed string values
  • schema-coercion-for-form-data - Use coercion for form and query data

2. Parsing & Validation (CRITICAL)

  • parse-use-safeparse - Use safeParse() for user input
  • parse-async-for-async-refinements - Use parseAsync for async refinements
  • parse-handle-all-issues - Handle all validation issues not just first
  • parse-validate-early - Validate at system boundaries
  • parse-avoid-double-validation - Avoid validating same data twice
  • parse-never-trust-json - Never trust JSON.parse output

3. Type Inference (HIGH)

  • type-use-z-infer - Use z.infer instead of manual types
  • type-input-vs-output - Distinguish z.input from z.infer for transforms
  • type-export-schemas-and-types - Export both schemas and inferred types
  • type-branded-types - Use branded types for domain safety
  • type-enable-strict-mode - Enable TypeScript strict mode

4. Error Handling (HIGH)

  • error-custom-messages - Provide custom error messages
  • error-use-flatten - Use flatten() for form error display
  • error-path-for-nested - Use issue.path for nested error location
  • error-i18n - Implement internationalized error messages
  • error-avoid-throwing-in-refine - Return false instead of throwing in refine

5. Object Schemas (MEDIUM-HIGH)

  • object-strict-vs-strip - Choose strict() vs strip() for unknown keys
  • object-partial-for-updates - Use partial() for update schemas
  • object-pick-omit - Use pick() and omit() for schema variants
  • object-extend-for-composition - Use extend() for adding fields
  • object-optional-vs-nullable - Distinguish optional() from nullable()
  • object-discriminated-unions - Use discriminated unions for type narrowing

6. Schema Composition (MEDIUM)

  • compose-shared-schemas - Extract shared schemas into reusable modules
  • compose-intersection - Use intersection() for type combinations
  • compose-lazy-recursive - Use z.lazy() for recursive schemas
  • compose-preprocess - Use preprocess() for data normalization
  • compose-pipe - Use pipe() for multi-stage validation

7. Refinements & Transforms (MEDIUM)

  • refine-vs-superrefine - Choose refine() vs superRefine() correctly
  • refine-transform-coerce - Distinguish transform() from refine() and coerce()
  • refine-add-path - Add path to refinement errors
  • refine-defaults - Use default() for optional fields with defaults
  • refine-catch - Use catch() for fault-tolerant parsing

8. Performance & Bundle (LOW-MEDIUM)

  • perf-cache-schemas - Cache schema instances
  • perf-zod-mini - Use Zod Mini for bundle-sensitive applications
  • perf-avoid-dynamic-creation - Avoid dynamic schema creation in hot paths
  • perf-lazy-loading - Lazy load large schemas
  • perf-arrays - Optimize large array validation

How to Use

Read individual reference files for detailed explanations and code examples:

Full Compiled Document

For the complete guide with all rules expanded: AGENTS.md

Related Skills

  • For React Hook Form integration, see react-hook-form skill
  • For API client generation, see orval skill

Sources

You Might Also Like

Related Skills

coding-agent

coding-agent

179Kdev-codegen

Run Codex CLI, Claude Code, OpenCode, or Pi Coding Agent via background process for programmatic control.

openclaw avataropenclaw
Obter
add-uint-support

add-uint-support

97Kdev-codegen

Add unsigned integer (uint) type support to PyTorch operators by updating AT_DISPATCH macros. Use when adding support for uint16, uint32, uint64 types to operators, kernels, or when user mentions enabling unsigned types, barebones unsigned types, or uint support.

pytorch avatarpytorch
Obter
at-dispatch-v2

at-dispatch-v2

97Kdev-codegen

Convert PyTorch AT_DISPATCH macros to AT_DISPATCH_V2 format in ATen C++ code. Use when porting AT_DISPATCH_ALL_TYPES_AND*, AT_DISPATCH_FLOATING_TYPES*, or other dispatch macros to the new v2 API. For ATen kernel files, CUDA kernels, and native operator implementations.

pytorch avatarpytorch
Obter
skill-writer

skill-writer

97Kdev-codegen

Guide users through creating Agent Skills for Claude Code. Use when the user wants to create, write, author, or design a new Skill, or needs help with SKILL.md files, frontmatter, or skill structure.

pytorch avatarpytorch
Obter

Implements JavaScript classes in C++ using JavaScriptCore. Use when creating new JS classes with C++ bindings, prototypes, or constructors.

oven-sh avataroven-sh
Obter

Creates JavaScript classes using Bun's Zig bindings generator (.classes.ts). Use when implementing new JS APIs in Zig with JSC integration.

oven-sh avataroven-sh
Obter