TypeORM初始化项目执行migration:generate时报import语句语法错误

这个报错的核心原因是直接调用TypeORM CLI时，Node默认使用CommonJS规范加载文件，无法识别TypeScript的ESM import语法，也不会自动编译TS实体文件，可通过以下两种方法解决：

方法1：使用ts-node执行CLI（开发环境推荐） #

• 第一步：安装ts-node开发依赖

yarn add ts-node -D

• 第二步：修改项目根目录下package.json的scripts字段，新增专门的typeorm执行命令

"scripts": {
  "typeorm": "ts-node ./node_modules/typeorm/cli.js"
}

• 第三步：确认ormconfig.json配置文件中的实体、迁移路径匹配TS文件路径，参考配置如下：

{
  "entities": [
    "src/entity/**/*.ts"
  ],
  "migrations": [
    "src/migration/**/*.ts"
  ],
  "subscribers": [
    "src/subscriber/**/*.ts"
  ],
  "cli": {
    "entitiesDir": "src/entity",
    "migrationsDir": "src/migration",
    "subscribersDir": "src/subscriber"
  }
}

• 第四步：重新执行迁移生成命令即可正常运行

yarn typeorm migration:generate -n User

方法2：先编译TS代码再运行CLI #

如果不想额外安装ts-node，可以先编译项目的TS代码为JS文件，再调用CLI执行操作：

• 第一步：修改ormconfig.json的实体、迁移路径，指向编译后的dist目录下的JS文件
• 第二步：依次执行编译、生成迁移命令

yarn build
yarn typeorm migration:generate -n User

额外检查项 #

如果执行上述操作后仍然报错，可检查tsconfig.json的配置是否符合要求：

• module配置不要设置为ESNext/ES6，开发环境建议设置为CommonJS
• 确保esModuleInterop和allowSyntheticDefaultImports两个配置项为开启状态
• 确认package.json中没有设置"type": "module"，否则会和ts-node的CommonJS运行模式冲突

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