使用Nuxt Layer共享pnpm工作区包时出现错误

问题背景 #

在pnpm monorepo环境中，我搭建了一个基础Nuxt Layer和一个继承该层的Nuxt应用app1。基础层依赖两个包：第三方包supervillains和pnpm工作区内的本地包good。目前app1可以正常使用supervillains，但调用good时会出现模块找不到的错误（错误提示：Cannot find module 'good' or its corresponding type declarations）。

解决方案 #

1. 确认pnpm工作区配置 #

检查项目根目录的pnpm-workspace.yaml，确保包含所有工作区包的路径，示例配置：

packages:
  - "packages/*"
  - "apps/*"

（根据实际仓库结构调整路径，比如本地包good在packages/good，Layer在packages/layer，app1在apps/app1）

2. 修正Layer的依赖声明 #

在Layer的package.json中，将本地包good的依赖改为workspace协议：

"dependencies": {
  "supervillains": "^5.0.0",
  "good": "workspace:*"
}

这会让pnpm识别该依赖为工作区内的本地包，而非从npm仓库拉取。

3. 配置Nuxt以处理本地包 #

在继承Layer的app1的nuxt.config.ts中，将本地包添加到构建转译列表：

export default defineNuxtConfig({
  extends: ['../packages/layer'],
  build: {
    transpile: ['good']
  }
})

或者在Layer的nuxt.config.ts中配置Nitro的外部依赖处理：

export default defineNuxtConfig({
  nitro: {
    externals: {
      inline: ['good']
    }
  }
})

4. 重新安装依赖并清理缓存 #

执行以下命令确保依赖正确链接并清除Nuxt缓存：

pnpm install
pnpm run dev --clear-cache

原因说明 #

第三方包supervillains来自公共npm仓库，pnpm会自动处理其依赖解析；但本地工作区包需要通过workspace:*协议明确声明，同时Nuxt需要被配置为转译或内联这类本地包，否则在运行时无法正确解析模块路径。

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