NX monorepo下MikroORM CLI配置失败求助

问题概述 #

在NX monorepo环境中将MikroORM作为库使用时，启动MikroORM CLI始终失败，尝试了package.json配置和.env变量配置两种方式，均出现不同错误。

使用package.json配置的情况 #

相关配置文件

package.json 中的 MikroORM 配置：

{
   "name":"@my-app",
   "version":"1.0.0",
   "license":"MIT",
   "scripts":{},
   "private":true,
   "dependencies":{},
   "devDependencies":{},
   "mikro-orm":{
      "useTsNode":true,
      "tsConfigPath":"./libs/database/tsconfig.orm.json",
      "configPaths":[
         "./libs/database/src/lib/mikro-orm.config.ts",
         "./dist/libs/database/src/lib/mikro-orm.config.js"
      ]
   }
}

MikroORM 配置文件（mikro-orm.config.ts）：

import { ConfigService } from '@nestjs/config'
import { MikroOrmModuleOptions } from '@mikro-orm/nestjs'
import { MySqlDriver, ReflectMetadataProvider } from '@mikro-orm/mysql'
import { SeedManager } from '@mikro-orm/seeder'
import { Migrator } from '@mikro-orm/migrations'

import { SoftDeletableHandlerSubscriber } from '@my-app/core'

const mikroOrmConfig = {
    user: process.env['DB_USERNAME'],
    host: process.env['DB_HOST'],
    password: process.env['DB_PASSWORD'],
    dbName: process.env['DB_NAME'],
    port: parseInt(process.env['DB_PORT'] as string),

    driver: MySqlDriver,
    autoLoadEntities: true,
    entities: ['dist/**/entities/*.js'],
    entitiesTs: ['src/**/entities/*.ts'],
    metadataProvider: ReflectMetadataProvider,
    extensions: [SoftDeletableHandlerSubscriber, SeedManager, Migrator],
    registerRequestContext: true,
    allowGlobalContext: process.env['NODE_ENV'] === 'test',
    migrations: {
        tableName: 'migration',
        path: './migrations',
        snapshot: true
    },
    seeder: {
        path: './seeders',
        pathTs: './seeders',
        defaultSeeder: 'DatabaseSeeder',
        glob: '!(*.d).{js,ts}',
        emit: 'ts',
        fileName: (className: string) => className
    }
} as MikroOrmModuleOptions

export default mikroOrmConfig

tsconfig.orm.json：

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "moduleResolution": "NodeNext"
  }
}

继承的 tsconfig.json：

{
  "extends": "../../tsconfig.base.json",
  "compilerOptions": {
    "module": "commonjs",
    "forceConsistentCasingInFileNames": true,
    "strict": true,
    "noImplicitOverride": true,
    "noPropertyAccessFromIndexSignature": true,
    "noImplicitReturns": true,
    "noFallthroughCasesInSwitch": true
  },
  "files": [],
  "include": [],
  "references": [
    {
      "path": "./tsconfig.lib.json"
    },
    {
      "path": "./tsconfig.spec.json"
    }
  ]
}

运行报错

执行 npx mikro-orm debug 后报错：

Current MikroORM CLI configuration
 - dependencies:
   - mikro-orm 6.2.9
   - node 18.17.0
   - typescript 5.3.3
 - package.json found
 - ts-node enabled
 - searched config paths:
   - C:/Work/my-company/my-app/code/my-app-backend/libs/database/src/lib/mikro-orm.config.ts (found)
   - C:/Work/my-company/my-app/code/my-app-backend/dist/libs/database/src/lib/mikro-orm.config.js (found)     
   - C:/Work/my-company/my-app/code/my-app-backend/src/mikro-orm.config.ts (not found)
   - C:/Work/my-company/my-app/code/my-app-backend/mikro-orm.config.ts (not found)
   - C:/Work/my-company/my-app/code/my-app-backend/dist/mikro-orm.config.js (not found)
   - C:/Work/my-company/my-app/code/my-app-backend/mikro-orm.config.js (not found)
- configuration not found (No database specified, please fill in `dbName` or `clientUrl` option)

使用.env变量配置的情况 #

.env 变量内容

# MIKRO ORM
MIKRO_ORM_CLI_USE_TS_NODE=true
MIKRO_ORM_CLI_ALWAYS_ALLOW_TS=true
MIKRO_ORM_CLI_CONFIG="./libs/database/src/lib/mikro-orm.config.ts"
MIKRO_ORM_CLI_TS_CONFIG_PATH="./libs/database/tsconfig.json"

运行报错

执行 npx mikro-orm debug 后报错：

Current MikroORM CLI configuration
 - dependencies:
   - mikro-orm 6.2.9
   - node 18.17.0
   - typescript 5.3.3
 - package.json found
 - ts-node enabled
 - searched config paths:
   - C:/Work/my-company/my-app/code/my-app-backend/libs/database/src/lib/mikro-orm.config.ts (found)
   - C:/Work/my-company/my-app/code/my-app-backend/src/mikro-orm.config.ts (not found)
   - C:/Work/my-company/my-app/code/my-app-backend/mikro-orm.config.ts (not found)
   - C:/Work/my-company/my-app/code/my-app-backend/dist/mikro-orm.config.js (not found)
   - C:/Work/my-company/my-app/code/my-app-backend/mikro-orm.config.js (not found)
- configuration not found (Cannot use import statement outside a module)

后续调整后的问题 #

仅使用.env变量配置（移除package.json中的MikroORM配置）

.env 变量内容：

MIKRO_ORM_CLI_USE_TS_NODE=true
MIKRO_ORM_CLI_CONFIG="./libs/database/src/lib/mikro-orm.config.ts"
MIKRO_ORM_CLI_TS_CONFIG_PATH="./libs/database/tsconfig.json"

运行报错

执行命令后报错：

Current MikroORM CLI configuration
 - dependencies:
   - mikro-orm 6.2.9
   - node 18.17.0
   - typescript 5.3.3
 - package.json found
 - ts-node enabled
 - searched config paths:
   - C:/Work/my-company/my-app/code/my-app-backend/dist/mikro-orm.config.js (not found)
   - C:/Work/my-company/my-app/code/my-app-backend/mikro-orm.config.js (not found)
- configuration not found (MikroORM config file not found in ['./dist/mikro-orm.config.js', './mikro-orm.config.js'])

使用package.json方式并添加import 'dotenv/config'后的问题

在 mikro-orm.config.ts 顶部添加 import 'dotenv/config' 后CLI可运行，但将 tsConfigPath 改为 tsconfig.json 时出现编译错误：

Current MikroORM CLI configuration
     - dependencies:
       - mikro-orm 6.2.9
       - node 18.17.0
       - typescript 5.3.3
     - package.json found
     - ts-node enabled
     - searched config paths:
       - C:/Work/my-company/my-app/code/my-app-backend/libs/database/src/lib/mikro-orm.config.ts (found)
       - C:/Work/my-company/my-app/code/my-app-backend/dist/libs/database/src/lib/mikro-orm.config.js (found)     
       - C:/Work/my-company/my-app/code/my-app-backend/src/mikro-orm.config.ts (not found)
       - C:/Work/my-company/my-app/code/my-app-backend/mikro-orm.config.ts (not found)
       - C:/Work/my-company/my-app/code/my-app-backend/dist/mikro-orm.config.js (not found)
       - C:/Work/my-company/my-app/code/my-app-backend/mikro-orm.config.js (not found)
    - configuration not found (⨯ Unable to compile TypeScript:
    error TS5109: Option 'moduleResolution' must be set to '
    NodeNext' (or left unspecified) when option 'module' is set to 'NodeNext'.
    )

解决方案 #

1. 修复环境变量未加载问题 #

在 mikro-orm.config.ts 顶部添加环境变量加载代码，确保CLI能读取到DB相关环境变量：

import 'dotenv/config' // 优先加载环境变量
import { ConfigService } from '@nestjs/config'
// ... 其余配置代码不变

2. 解决TypeScript模块解析冲突 #

调整TypeScript配置，确保module与moduleResolution匹配：

• 若保留module: commonjs，修改 tsconfig.orm.json：

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "moduleResolution": "node" // 改为node，与commonjs模块匹配
  }
}

• 若使用NodeNext模块系统，修改 tsconfig.json：

{
  "extends": "../../tsconfig.base.json",
  "compilerOptions": {
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "forceConsistentCasingInFileNames": true,
    "strict": true,
    "noImplicitOverride": true,
    "noPropertyAccessFromIndexSignature": true,
    "noImplicitReturns": true,
    "noFallthroughCasesInSwitch": true
  },
  // ... 其余配置不变
}

3. 修正.env配置的路径与模块问题 #

使用.env配置时，调整以下内容：

• 将MIKRO_ORM_CLI_TS_CONFIG_PATH指向专门的ORM配置文件：./libs/database/tsconfig.orm.json
• 确保环境变量名正确，useTsNode=true已启用，CLI能识别TS配置文件

4. 适配NX Monorepo路径 #

调整配置文件中的路径为根目录相对路径：

// MikroORM配置文件中修改路径
entities: ['dist/libs/**/entities/*.js'],
entitiesTs: ['libs/**/entities/*.ts'],
migrations: {
    tableName: 'migration',
    path: './libs/database/migrations', // 改为根相对路径
    snapshot: true
},
seeder: {
    path: './libs/database/seeders', // 改为根相对路径
    pathTs: './libs/database/seeders',
    defaultSeeder: 'DatabaseSeeder',
    glob: '!(*.d).{js,ts}',
    emit: 'ts',
    fileName: (className: string) => className
}

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