前后端共享Zod推导类型的实现方案咨询

针对你遇到的Zod无法在shared目录导入的问题，不用单独发布npm包，有以下几种更优的实现方式：

1. 根目录全局安装Zod并配置TS路径 #

如果你的项目是单仓库多子项目结构（根目录包含client、server、shared），直接在根目录安装Zod作为项目依赖，然后通过TypeScript配置让各子项目能访问shared目录的代码：

• 根目录执行安装命令：

  npm install zod
  

• 在shared目录编写Zod Schema并导出类型：

  // shared/src/schemas/user.ts
  import { z } from "zod";
  
  export const NewUserSchema = z.object({
    email: z.string().email(),
    name: z.string().optional(),
    address: z.string().optional(),
  });
  
  // 导出自动生成的TypeScript类型
  export type NewUser = z.infer<typeof NewUserSchema>;
  

• 在client和server的tsconfig.json中配置include或paths，确保能导入shared的代码：

  // client/tsconfig.json 或 server/tsconfig.json
  {
    "compilerOptions": {
      "paths": {
        "@shared/*": ["../shared/src/*"]
      }
    },
    "include": ["src/**/*", "../shared/**/*"]
  }
  

之后就能在client和server中直接导入@shared/schemas/user，同时使用Schema做验证和类型推导。

2. 为shared目录配置peer依赖 #

在shared目录中创建独立的package.json，将Zod声明为peer依赖，这样shared本身不安装Zod，但要求引用它的client和server必须已安装Zod，既解决导入问题又避免重复安装：

• shared/package.json配置：

  {
    "name": "@your-project/shared",
    "version": "1.0.0",
    "peerDependencies": {
      "zod": "^3.22.0"
    },
    "types": "./src/index.ts"
  }
  

• 保持client和server已安装Zod，之后就能在shared中正常导入Zod编写Schema，client和server直接引用shared的代码即可。

3. 使用TypeScript项目引用（Project References） #

适合大型全栈项目，通过TS的项目引用功能明确子项目间的依赖关系，优化编译和类型检查效率：

• 为shared目录创建tsconfig.json，开启composite模式：

  // shared/tsconfig.json
  {
    "compilerOptions": {
      "composite": true,
      "declaration": true,
      "outDir": "./dist",
      "rootDir": "./src"
    },
    "include": ["src/**/*"]
  }
  

• 在client和server的tsconfig.json中添加对shared的引用：

  // client/tsconfig.json
  {
    "compilerOptions": {
      "outDir": "./dist",
      "rootDir": "./src"
    },
    "references": [{ "path": "../shared" }],
    "include": ["src/**/*"]
  }
  

• 根目录安装Zod（或在shared中安装为dev依赖，仅用于编译时类型推导），编写Schema后，通过tsc --build命令可以按依赖顺序编译所有项目。

方案对比 #

• 根目录安装：实现最简单，适合小型项目，无额外配置成本。
• Peer依赖：适合需要规范依赖版本的项目，确保client和server使用相同版本的Zod。
• 项目引用：适合大型项目，提升编译速度，类型检查更精准，便于维护复杂的子项目依赖。

内容的提问来源于stack exchange，提问作者Abaga