zod-to-ts 项目使用指南

zod-to-ts 项目使用指南

zod-to-tsgenerate TypeScript types from your Zod schema项目地址:https://gitcode.com/gh_mirrors/zo/zod-to-ts

1. 项目的目录结构及介绍

zod-to-ts/
├── src/
│   ├── index.ts
│   ├── utils.ts
│   └── ...
├── test/
│   ├── index.test.ts
│   └── ...
├── .eslintrc.json
├── .gitignore
├── LICENSE
├── README.md
├── dprint.json
├── package.json
├── pnpm-lock.yaml
├── tsconfig.json
└── ...

目录结构说明

• src/: 包含项目的主要源代码文件。
  • index.ts: 项目的入口文件。
  • utils.ts: 包含一些辅助函数。
• test/: 包含项目的测试文件。
  • index.test.ts: 针对入口文件的测试。
• .eslintrc.json: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• dprint.json: 代码格式化配置文件。
• package.json: 项目依赖和脚本配置文件。
• pnpm-lock.yaml: 依赖锁定文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

入口文件：src/index.ts

该文件是项目的入口点，负责导出主要功能和模块。以下是简化的代码示例：

import { z } from 'zod';
import { zodToTs } from 'zod-to-ts';

// 定义 Zod 模式
const UserSchema = z.object({
  username: z.string(),
  age: z.number(),
  inventory: z.array(z.object({
    name: z.string(),
    itemId: z.number(),
  })),
});

// 转换为 TypeScript 类型
const [node] = zodToTs(UserSchema, 'User');

// 打印 TypeScript 类型
console.log(node);

3. 项目的配置文件介绍

package.json

该文件包含了项目的依赖、脚本和其他元数据。以下是简化的示例：

{
  "name": "zod-to-ts",
  "version": "1.0.0",
  "description": "Generate TypeScript types from your Zod schema",
  "main": "src/index.ts",
  "scripts": {
    "start": "ts-node src/index.ts",
    "test": "jest"
  },
  "dependencies": {
    "zod": "^3.0.0",
    "typescript": "^4.0.0"
  },
  "devDependencies": {
    "ts-node": "^10.0.0",
    "jest": "^27.0.0"
  }
}

tsconfig.json

该文件包含了 TypeScript 编译器的配置。以下是简化的示例：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*"]
}

.eslintrc.json

该文件包含了 ESLint 的配置。以下是简化的示例：

{
  "parser": "@typescript-eslint/parser",
  "plugins": ["@typescript-eslint"],
  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
  "rules": {
    "no-console": "off"
  }
}

通过以上配置文件，可以确保项目的代码质量和一致性。

zod-to-tsgenerate TypeScript types from your Zod schema项目地址:https://gitcode.com/gh_mirrors/zo/zod-to-ts