NestJS配置TypeORM迁移报错cli属性不存在于TypeOrmModuleOptions

报错核心原因 #

该报错是TypeORM版本不匹配导致的：

• 你当前安装的是TypeORM 0.3.x及以上版本，该版本重构了CLI运行逻辑，已经彻底移除了连接配置中的cli字段，而NestJS对应的TypeOrmModuleOptions类型也同步删除了该属性定义，因此传入cli配置项时会触发TS类型校验错误。
• 网上大部分旧教程是基于TypeORM 0.2.x版本编写，0.2版本确实支持在配置中写cli.migrationsDir指定迁移目录，直接照搬旧教程到0.3版本就会触发该问题。

解决方案 #

方案一：适配0.3.x版本标准写法（推荐） #

• 删除TypeOrmModule.forRoot()配置对象中的整个cli字段，该字段在0.3版本无任何作用。
• 在项目根目录（和package.json同级）新建专门给CLI使用的数据源配置文件data-source.ts，配置内容参考：

import { DataSource } from 'typeorm';
import 'dotenv/config'; // 若使用dotenv读取环境变量需手动引入

export default new DataSource({
  type: 'postgres',
  host: process.env.DB_HOST,
  port: Number(process.env.DB_PORT),
  username: process.env.DB_USERNAME,
  password: process.env.DB_PASSWORD,
  database: process.env.DB_DATABASE,
  entities: ['src/**/*.entity{.ts,.js}'],
  migrations: ['src/migrations/*{.ts,.js}'],
  extra: {
    charset: 'utf8'
  },
  synchronize: false,
  logging: true
});

• 改造TypeOrmModule的引入代码，直接复用数据源配置避免重复编写：

import AppDataSource from './data-source';

@Module({
  imports: [
    TypeOrmModule.forRoot(AppDataSource.options),
    // 其余模块引入
  ]
})
export class AppModule {}

• 在package.json中添加迁移相关脚本，执行CLI命令时显式指定数据源文件：

{
  "scripts": {
    "migration:generate": "typeorm-ts-node-commonjs migration:generate src/migrations/$npm_config_name -d ./data-source.ts",
    "migration:run": "typeorm-ts-node-commonjs migration:run -d ./data-source.ts",
    "migration:revert": "typeorm-ts-node-commonjs migration:revert -d ./data-source.ts"
  }
}

生成迁移时可以直接传name参数，例如执行npm run migration:generate --name=InitUserTable即可自动生成对应命名的迁移文件。

方案二：降级到0.2.x版本兼容旧写法 #

如果不想调整现有配置结构，可以直接降级到支持cli配置项的版本，执行以下命令固定版本：

npm install typeorm@0.2.45 @nestjs/typeorm@8.1.4 --save-exact

降级完成后TS类型校验会自动识别cli字段，不会再抛出该错误，原有配置无需调整即可正常运行。

注意点 #

• 如果项目使用ESM规范，把脚本里的typeorm-ts-node-commonjs替换成typeorm-ts-node-esm即可。
• 0.3版本不再通过cli.migrationsDir指定目录，直接在migrations字段写文件匹配规则就可以让CLI识别迁移文件位置。

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