如何在pnpm monorepo中运行非根目录下的CodeceptJS测试？

问题背景 #

项目采用PNPM工作区搭建Monorepo结构，目录如下：

root
|
├──node_modules
│  
├──packages
|  |
│  ├──package1
│  │   ├──node_modules
|  |   ├──ui_tests
|  |   |  ├──codecept.conf.ts
|  |   |  └──login_ui_test.ts
|  |   |
|  |   ├──api_tests
|  |   |  ├──codecept.conf.ts
|  |   |  └──login_api_test.ts
|  |   |  
│  │   └──package.json
|  |   
│  └──package2
│     ├──node_modules
|     ├──ui_tests
|     ├──api_tests
│     └──package.json
|  
└──package.json

为实现UI/API测试独立配置，将codecept.conf.ts放在三级目录下。执行命令pnpm exec codeceptjs run --config ./package1/api_tests/codecept.conf.ts时，先后出现两个错误：

1. 类型错误：error TS2503: Cannot find namespace 'CodeceptJS'
2. 容器注入错误：Object of type _a is not defined in container

解决方案 #

1. 修复CodeceptJS类型未识别问题 #

不要通过import Codecept from "codeceptjs"导入类型，而是通过全局类型引用解决：

• 在每个codecept.conf.ts文件顶部添加类型引用声明：

  /// <reference types="codeceptjs" />
  

• 确认依赖安装：CodeceptJS v3+内置类型，无需额外安装@types/codeceptjs；若为旧版本，执行pnpm add @types/codeceptjs -D --filter package1安装类型包。
• 检查tsconfig.json配置：确保types数组包含codeceptjs，或typeRoots包含node_modules/@types，示例片段：

  {
    "compilerOptions": {
      "types": ["codeceptjs", "node"]
    }
  }
  

2. 修复容器注入异常问题 #

该错误由配置文件导入方式错误导致测试容器初始化失败，按以下步骤处理：

• 移除codecept.conf.ts中的import Codecept from "codeceptjs"语句，CodeceptJS配置文件依赖全局类型，无需显式导入。
• 确保配置文件结构正确，以API测试配置为例：

  /// <reference types="codeceptjs" />
  
  export const config: CodeceptJS.MainConfig = {
    tests: './login_api_test.ts',
    output: './output',
    helpers: {
      REST: {
        endpoint: 'https://your-api-endpoint.com'
      }
    },
    include: {},
    name: 'package1-api-tests'
  }
  

• 调整执行命令的路径，从根目录执行时使用绝对路径（避免相对路径歧义）：

  pnpm exec codeceptjs run --config packages/package1/api_tests/codecept.conf.ts
  

• 确认package1的依赖完整性：执行pnpm add codeceptjs ts-node codeceptjs-rest -D --filter package1（根据测试类型替换helper，如UI测试用playwright或puppeteer），确保依赖在子包中正确安装。

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