mcpField
Z
zod

zod

github.com/pproencaDevelopment2187.1k installsUpdated 11w ago
Repository

About zod

zod is a best-practices guide for developers using Zod in TypeScript. Its prioritized rules cover schema design, parsing, type inference, errors, and performance.

Key features

  1. 01Organizes 43 rules by priority
  2. 02Covers schema definition and parsing
  3. 03Guides type inference and error handling
  4. 04Advises on object composition and transforms
  5. 05Includes performance and bundle guidance

Use cases

  1. 01Write or review Zod schemas
  2. 02Choose between parse() and safeParse()
  3. 03Handle validation errors for user feedback
  4. 04Optimize validation performance and bundle size

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/pproenca/dot-skills --skill zod

After installing, type/zodin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

AGENTS.md
metadata.json
README.md
assets/templates/
_template.md
references/
_sections.md
compose-intersection.md
compose-lazy-recursive.md
compose-pipe.md
compose-preprocess.md
compose-shared-schemas.md
error-avoid-throwing-in-refine.md
error-custom-messages.md
error-i18n.md
error-path-for-nested.md
error-use-flatten.md
object-discriminated-unions.md
object-extend-for-composition.md
object-optional-vs-nullable.md
object-partial-for-updates.md
object-pick-omit.md
object-strict-vs-strip.md
parse-async-for-async-refinements.md
parse-avoid-double-validation.md
parse-handle-all-issues.md
parse-never-trust-json.md
parse-use-safeparse.md
parse-validate-early.md
perf-arrays.md
perf-avoid-dynamic-creation.md
perf-cache-schemas.md

Details

From the project README

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

PriorityCategoryImpactPrefix
1Schema DefinitionCRITICALschema-
2Parsing & ValidationCRITICALparse-
3Type InferenceHIGHtype-
4Error HandlingHIGHerror-
5Object SchemasMEDIUM-HIGHobject-
6Schema CompositionMEDIUMcompose-
7Refinements & TransformsMEDIUMrefine-
8Performance & BundleLOW-MEDIUMperf-

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

Comments

Markdown supported