https://github.com/yuzheng14/valype
Valype = Validate + Type. Automatically generates runtime validators from TypeScript type definitions.
https://github.com/yuzheng14/valype
farm rollup runtime-validation schema-validation static-types tsdown type-inference typecheck typechecker typescript unplugin validate validation validator vite webpack zod
Last synced: 11 months ago
JSON representation
Valype = Validate + Type. Automatically generates runtime validators from TypeScript type definitions.
- Host: GitHub
- URL: https://github.com/yuzheng14/valype
- Owner: yuzheng14
- License: mit
- Created: 2024-01-25T16:42:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-25T05:10:55.000Z (11 months ago)
- Last Synced: 2025-06-25T06:24:39.728Z (11 months ago)
- Topics: farm, rollup, runtime-validation, schema-validation, static-types, tsdown, type-inference, typecheck, typechecker, typescript, unplugin, validate, validation, validator, vite, webpack, zod
- Language: TypeScript
- Homepage: https://valype.dev
- Size: 303 KB
- Stars: 22
- Watchers: 1
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Valype π
**TypeScript Runtime Validator** - Generate validation from type definitions
> [!WARNING]
>
> Valype is currently under active development. APIs may change in future releases. Please follow [Semver](https://semver.org/) to avoid **breaking changes**.
- π― Type-safe validation with TypeScript type inference
- π Seamless unplugin integration (Vite/Rollup/esbuild/Astro/Farm/Nuxt/Rspack/Webpack)
- π‘οΈ Unified type validation
- π» TypeScript plugin for IDE support
- π§ IDE/editor extension support (WIP)
Valype = Validate + Type. Automatically generates runtime validators from TypeScript type definitions.
## π Getting Started
1. Install plugin:
```bash
# for npm users
npm add zod@latest
npm add -D unplugin-valype
# for yarn users
yarn add zod@latest
yarn add -D unplugin-valype
# for pnp users
pnpm add zod@latest
pnpm add -D unplugin-valype
# for bun users
bun add zod@latest
bun add -D unplugin-valype
```
> zod's version should be `3.25.0` at least, because valype generates zod v4 schema
2. Configure plugin for your build tool following [unplugin-valype docs](./packages/plugin/README.md)
3. For TypeScript language support, install the plugin:
```bash
npm install -D @valype/typescript-plugin
```
Then add to your tsconfig.json:
```json
{
"compilerOptions": {
"plugins": [
{
"name": "@valype/typescript-plugin"
}
]
}
}
```
> For VSCode users, ensure you're using the workspace version of TypeScript
4. Define your types (use `.valype.ts` extension):
```typescript
// user.valype.ts
export interface User {
name: string
age: number
}
```
4. Use the generated validator:
```typescript
import { validateUser } from './user.valype'
const issues = validateUser(data) // Returns ZodIssue[] or undefined
if (issues) {
// Handle validation errors
}
```
## π Usage
`unplugin-valype` generates validators for types exported from `*.valype.ts` files. The validator type signature is:
```typescript
export declare function validateSome(data: unknown): ZodIssue[] | undefined
```
- Returns `undefined` when validation passes
- Returns `ZodIssue[]` with error details when validation fails
> [!NOTE]
>
> You typically don't need to use `valype` package directly, just use the generated validators.
## π¦ Packages
| Package | Version | Description |
| ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| [valype](https://www.npmjs.com/package/valype) | [](https://www.npmjs.com/package/valype) | Core schema generation logic |
| [unplugin-valype](https://www.npmjs.com/package/unplugin-valype) | [](https://www.npmjs.com/package/unplugin-valype) | Build tool plugin |
## π‘ Motivation
While TypeScript ensures compile-time type safety, runtime data validation remains essential. Traditional solutions like Zod require duplicate type definitions and lose valuable tsdoc information. Valype solves this by:
- **Single Source of Truth** - Define types once, get both static and runtime validation
- **Full Type Information** - Preserves all tsdoc documentation and editor hints
- **Seamless Integration** - Works natively with TypeScript tooling
```typescript
const userSchema = z.object({
name: z.string(),
age: z.number(),
})
type User = z.infer
// And `User['name'] does not have tsdoc info
```
Using valype:
```typescript
export interface User {
/**
* name of user
*/
name: string
age: number
}
// Validator is generated automatically!
const result = validateUser(data)
// Also `User['name'] has tsdoc info
```
Valype lets you **define types once** and get runtime validation automatically!
## π₯° Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## πͺͺ License
[MIT](./LICENSE)
## π Inspired By
Valype draws inspiration from these excellent projects:
- [ts-to-zod](https://github.com/fabien0102/ts-to-zod)
- [Zod](https://github.com/colinhacks/zod)
- [@sinclair/typebox](https://github.com/sinclairzx81/typebox)
## π Star History
[](https://www.star-history.com/#yuzheng14/valype&Date)