解决 Prisma 客户端导入错误：清除不必要的 `process` 导入（含 `generator` 配置）

excel
260 阅读4分钟

在使用 Prisma 时，开发者会通过 prisma generate 命令生成 Prisma 客户端代码。这些代码会根据项目的配置生成，并可能遇到关于 process 模块导入的错误，尤其是在某些构建工具或环境下。

本文将详细介绍如何配置 Prisma 客户端生成，并展示一种通过清理不必要的 process 导入来解决相关错误的方案。

配置 Prisma 客户端生成

在 Prisma 的 schema.prisma 文件中，generator 配置用于指定 Prisma 客户端的生成方式。它控制 Prisma 客户端的输出路径、模块格式等设置。以下是一个典型的 generator 配置：

prisma
复制编辑
generator client {
  provider     = "prisma-client"
  output       = "../generated/prisma"  // 客户端输出目录
  moduleFormat = "esm"                  // 使用 ESM 模块格式
}

配置解释：

  • provider：指定客户端生成的提供者，这里使用的是 prisma-client，即 Prisma 默认的客户端生成器。
  • output：生成的 Prisma 客户端代码将输出到 ../generated/prisma 目录。这个路径可以根据项目结构进行调整。
  • moduleFormat：指定生成的模块格式。esm 表示使用 ES 模块格式，而 cjs 则是 CommonJS 模块格式。

当你运行 prisma generate 命令时，Prisma 会根据这个配置生成客户端代码，并将其放置在指定的目录中。

遇到的常见问题

生成的 Prisma 客户端代码有时会自动包含对 node:process 模块的导入，这在某些构建工具或现代 JavaScript 环境下可能会导致错误。例如：

pgsql
复制编辑
Module not found: Error: Can't resolve 'node:process' in 'path/to/generated/prisma'

这种错误通常是因为在某些环境（如 TypeScript 或 ES 模块构建）下，process 模块无法正确解析，导致构建失败。

解决方案：清理 process 导入

为了解决这个问题，可以编写一个脚本，自动清理 Prisma 客户端代码中不必要的 process 导入。这样，每次生成 Prisma 客户端后，脚本会遍历生成的代码并删除所有与 process 模块相关的导入语句。

以下是一个 Node.js 脚本，能够自动清理 Prisma 客户端代码中的 process 导入：

js
复制编辑
import fs from 'fs'
import path from 'path'

// 设置 Prisma 客户端代码的生成目录
const prismaDir = path.resolve('./generated/prisma')

// 清理导入 process 模块的函数
function cleanProcessImport(filePath) {
  const content = fs.readFileSync(filePath, 'utf-8')
  // 移除所有对 node:process 模块的导入
  const newContent = content.replace(/import\s+*\s+as\s+process\s+from\s+['"]node:process['"];?/g, '')
  fs.writeFileSync(filePath, newContent)
}

// 遍历 Prisma 生成目录中的所有 TypeScript 文件
fs.readdirSync(prismaDir).forEach((file) => {
  if (file.endsWith('.ts')) {
    cleanProcessImport(path.join(prismaDir, file))
  }
})

脚本解析：

  • 读取生成目录：首先通过 path.resolve 获取 Prisma 生成的客户端代码的目录路径，默认为 ./generated/prisma。
  • 清理导入：cleanProcessImport 函数用于读取每个 TypeScript 文件的内容，使用正则表达式匹配并删除 node:process 导入语句。
  • 遍历文件：脚本遍历 Prisma 客户端生成目录中的所有 .ts 文件，并对每个文件执行清理操作。

执行流程

  1. 配置 Prisma：在 schema.prisma 文件中添加 generator 配置，确保客户端代码生成路径和模块格式设置正确。
  2. 运行 prisma generate：运行 prisma generate 命令，生成 Prisma 客户端代码。
  3. 运行清理脚本：生成 Prisma 客户端后，执行上述 Node.js 脚本，自动清理所有与 process 模块相关的导入。
  4. 继续开发：完成清理后，生成的 Prisma 客户端将不再包含不必要的导入，可以继续在项目中使用。

为什么这种方法有效？

  1. 自动化清理：这种方式自动化了清理工作，开发者不需要手动逐个修改生成的文件。这对于频繁生成 Prisma 客户端代码的项目尤其有用。
  2. 兼容性增强：通过去除不必要的导入，可以避免构建环境中对 process 模块的不支持或错误处理，解决构建时的报错。
  3. 灵活性和扩展性：如果将来出现新的问题（如其他模块导入导致的错误），可以进一步修改脚本，添加清理逻辑。

总结

在 Prisma 客户端生成过程中，可能会遇到由于 process 模块导入引发的错误。通过在 schema.prisma 文件中配置合适的 generator 配置，并编写一个自动清理的脚本，可以有效解决这一问题。这种方法不仅能够简化开发流程，还能提升项目的构建兼容性，使得 Prisma 客户端能够在各种环境下稳定工作。

使用方法

import { PrismaClient } from '../generated/prisma/index.js'
import { withAccelerate } from '@prisma/extension-accelerate'

const prismaClientSingleton = () => {
  return new PrismaClient().$extends(withAccelerate())
}

declare const globalThis: {
  prismaGlobal: ReturnType<typeof prismaClientSingleton>;
} & typeof global;

const prisma = globalThis.prismaGlobal ?? prismaClientSingleton()

export default prisma

if (process.env.NODE_ENV !== 'production') globalThis.prismaGlobal = prisma

参考连接

avatar
文章
阅读
粉丝