NestJS TypeORM配置CLI选项无效：cli属性不存在类型报错

问题原因 #

TypeOrmModuleOptions是NestJS封装的数据库连接配置类型，不包含cli相关属性——cli配置是给TypeORM命令行工具单独使用的，不属于应用运行时的数据库连接配置项，因此直接放在TypeOrmModuleOptions类型的对象里会触发TypeScript类型检查错误。

解决方案 #

方案1：拆分配置（推荐，符合TypeORM最佳实践）

单独创建TypeORM CLI专用的配置文件（如data-source.ts，TypeORM v0.3+推荐使用DataSource方式），同时在NestJS中复用该配置：

1. 创建src/data-source.ts文件：

import { DataSource, DataSourceOptions } from 'typeorm';
import { join } from 'path';

export const dataSourceOptions: DataSourceOptions = {
  type: 'postgres',
  host: process.env.POSTGRES_HOST,
  port: Number(process.env.POSTGRES_PORT),
  username: process.env.POSTGRES_USER,
  password: process.env.POSTGRES_PASSWORD,
  database: process.env.POSTGRES_DB,
  entities: [join(__dirname, '**', '*.entity.{ts,js}')],
  synchronize: false,
  migrations: ['dist/src/db/migrations/*.js'],
  cli: {
    migrationsDir: 'src/db/migrations',
  },
};

const dataSource = new DataSource(dataSourceOptions);
export default dataSource;

2. 在NestJS的AppModule中复用该配置：

import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { dataSourceOptions } from './data-source';

@Module({
  imports: [TypeOrmModule.forRoot(dataSourceOptions)],
})
export class AppModule {}

3. 在package.json中添加迁移命令脚本：

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

运行npm run migration:generate --name=InitialMigration时，TypeORM CLI会自动创建src/db/migrations文件夹（如果不存在）并生成迁移文件。

方案2：类型断言跳过检查（不推荐，失去类型安全）

如果不想拆分文件，可通过类型断言强制跳过TypeScript的类型检查：

import { TypeOrmModuleOptions } from '@nestjs/typeorm';
import { join } from 'path';

const typeConfigDatabase = {
  type: 'postgres',
  host: process.env.POSTGRES_HOST,
  port: Number(process.env.POSTGRES_PORT),
  username: process.env.POSTGRES_USER,
  password: process.env.POSTGRES_PASSWORD,
  database: process.env.POSTGRES_DB,
  entities: [join(__dirname, '**', '*.entity.{ts,js}')],
  synchronize: false,
  migrations: ['dist/src/db/migrations/*.js'],
  cli: {
    migrationsDir: 'src/db/migrations',
  },
} as TypeOrmModuleOptions & { cli: { migrationsDir: string } };

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