zod
Quy ước dùng Zod trong repo(架构文件夹、越南语消息、集成 với 反应钩子形式 và 服务器操作)。
📖 中文导读:Quy ước dùng Zod trong repo(架构文件夹、越南语消息、集成 với 反应钩子形式 và 服务器操作)。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: zod description: Quy ước dùng Zod trong repo (schemas folder, Vietnamese messages, integration với react-hook-form và server actions).
Nguồn trong repo
- Schemas:
apps/web/src/schemas/*.ts- Ví dụ:
apps/web/src/schemas/blog.ts
- Ví dụ:
- Resolver:
@hookform/resolvers/zod(đã dùng trong admin forms).
Quy ước
- Định nghĩa schema ở
apps/web/src/schemas/<domain>.ts. - Xuất type bằng
z.infer<typeof schema>để không bị drift. - Message validation phải tiếng Việt (giữ thuật ngữ kỹ thuật English khi cần).
Pattern hay dùng (CẬP NHẬT ZOD V4)
- Optional + nullable (match DB):
z.string().max(160).optional().nullable()
- UUID:
z.string().uuid()
- Enum status:
z.enum(['draft', 'published', 'archived'], { error: 'Trạng thái không hợp lệ' })
- Zod v4: Dùng
error:thay vìmessage:cho custom errors:// Zod 4 pattern (KHUYẾN NGHỊ) z.string().min(5, { error: "Quá ngắn, tối thiểu 5 ký tự" }) // Zod 3 pattern (vẫn hoạt động nhưng không khuyến nghị) z.string().min(5, { message: "Quá ngắn" })
Với react-hook-form
resolver: zodResolver(schema)- Prefer
useForm<FormData, unknown, FormData>để types khớp.
Với server actions / route handlers
- Validate input bằng
schema.safeParse(data). - Không throw raw ZodError ra UI; map sang message tiếng Việt hoặc cấu trúc lỗi form.
Tránh
- Tránh
z.any()(repo strict TS). Nếu cần, dùngz.unknown()và refine. - Tránh duplicate rule giữa client & server; schema nên dùng chung.