TypeScript 错误 Cannot use import statement outside a module
要解决 TypeScript 中的“Cannot use import statement outside a module”错误,需要在 tsconfig.json
文件中将 module 选项设置为 commonjs,并确保编译 TypeScript 文件(例如使用 ts-node),而不是使用 node 直接运行它们。
{
"compilerOptions": {
"target": "es6",
"module": "commonjs",
"esModuleInterop": true,
// ... 其他选项
}
}
module 选项设置程序的模块系统。
esModuleInterop 选项默认设置为 false,这使其将 CommonJS 模块视为类似于 ES6 模块。 这会导致一些问题。 将 esModuleInterop 设置为 true 可以解决这些问题。
TypeScript 中“Cannot use import statement outside a module”错误的另一个常见原因是尝试直接使用 node 运行 TypeScript 文件,例如 node src/index.ts
。 这不起作用,因为我们首先必须将文件转换为 JavaScript,然后才能使用 node.js 运行它。
如果我们错误地配置了使用 babel 或 ts-node 的 TypeScript 项目,情况也是如此。
我们的 TypeScript 文件是否被转译为构建目录中的 JavaScript 文件? 构建目录应该只包含 JavaScript 文件。 如果它包含 TypeScript 文件,则我们项目配置不正确。
如果我们的项目使用 ts-node,则可以尝试在 tsconfig.json 中添加覆盖,将模块设置为 commonjs。
{
"ts-node": {
// 这些选项是仅由 ts-node 使用的覆盖
"compilerOptions": {
"module": "commonjs"
}
},
"compilerOptions": {
// ... 我们的配置项
},
}
我们应该检查的另一件事是 package.json 文件中的 main 属性指向我们的 index.js 文件,而不是 index.ts 文件。
查看我们通过 tsconfig.json 文件中的 outDir
选项设置的build文件夹。 我们配置可能有误,仍然可以在build目录中生成 TypeScript 文件。
如果上述建议都不起作用,请查看使用 ts-node 的 TypeScript 项目的工作配置。
这是一个较完整的 tsconfig.json 文件。
{
"compilerOptions": {
"skipLibCheck": true,
"target": "es6",
"module": "commonjs",
"moduleResolution": "node",
"allowJs": true,
"resolveJsonModule": true,
"esModuleInterop": true,
"outDir": "./build",
"rootDir": "src",
},
"include": ["src/**/*"],
"exclude": ["node_modules"]
}
确保包含数组指向包含项目所有必要文件的目录。
这是一个 package.json 文件。
{
"name": "example",
"version": "1.0.0",
"main": "build/index.js",
"scripts": {
"build": "rimraf ./build && tsc",
"dev": "nodemon",
"start": "npm run build && node build/index.js",
},
"devDependencies": {
"@types/node": "^17.0.21",
"nodemon": "^2.0.15",
"rimraf": "^3.0.0",
"ts-node": "^10.4.0",
"typescript": "^4.6.2"
}
}
这里是 nodemon.json
配置文件,它位于同一目录中。
{
"watch": ["src"],
"ext": ".ts,.js",
"ignore": [],
"exec": "ts-node --files ./src/index.ts"
}
此项目结构假定我们将所有 TypeScript 文件放在一个名为 src 的目录中,并且在 src/index.ts 下有一个 index.ts 入口点。
ts-node 包会将我们的代码转换为 JavaScript 并使用 node.js 运行它。
我们的构建文件将位于 build 目录中。 请注意,我们的 build 目录不应包含任何 TypeScript 文件,而应仅包含 JavaScript 文件。
如果我们的 build 目录包含 TypeScript 文件,则项目中存在配置错误。