NNext.js 中文网 GitHub

typescript

Next.js 默认会报告 TypeScript 错误。在此了解如何选择退出此行为。

通过 next.config.js 中的 typescript 选项配置 TypeScript 行为:

next.config.js
module.exports = {
  typescript: {
    ignoreBuildErrors: false,
    tsconfigPath: 'tsconfig.json',
  },
}

选项#

选项类型默认值描述
ignoreBuildErrorsbooleanfalse即使存在 TypeScript 错误,也允许生产构建完成。
tsconfigPathstring'tsconfig.json'自定义 tsconfig.json 文件的路径。

ignoreBuildErrors#

当项目中存在 TypeScript 错误时,Next.js 会使你的生产构建(next build)失败。

如果你希望 Next.js 即使应用程序有错误也冒险生成生产代码,可以禁用内置的类型检查步骤。

请注意,这会完全跳过 TypeScript 类型检查步骤。它不会运行 TypeScript 并抑制错误,而是完全绕过检查。

如果禁用该选项,请务必在构建或部署流程中运行类型检查,否则可能非常危险。

next.config.js
module.exports = {
  typescript: {
    // !! 警告 !!
    // 危险:即使项目存在类型错误,
    // 也允许生产构建成功完成。
    // !! 警告 !!
    ignoreBuildErrors: true,
  },
}

tsconfigPath#

为构建或工具使用不同的 TypeScript 配置文件:

next.config.js
module.exports = {
  typescript: {
    tsconfigPath: 'tsconfig.build.json',
  },
}

有关更多详情,请参阅 TypeScript 配置页面。

Next.js 中文网