NNext.js 中文网 GitHub

useTypeScriptCli

experimental

在生产构建期间运行项目本地的 TypeScript CLI 进行类型检查。

默认情况下,next build 会运行项目本地的 tsc 命令,而不是加载 TypeScript JavaScript 编译器 API。这支持 TypeScript 6,并在 TypeScript 7 的 JavaScript API 尚不可用时使其可用。

在你的项目中安装 TypeScript 7:

bash · pnpm
pnpm add -D typescript@^7
bash · npm
npm install -D typescript@^7
bash · yarn
yarn add -D typescript@^7
bash · bun
bun add -D typescript@^7

CLI 检查器默认启用。要改用 TypeScript JavaScript 编译器 API,请将 experimental.useTypeScriptCli 设置为 false:

next.config.ts
import type { NextConfig } from 'next'

const nextConfig: NextConfig = {
  experimental: {
    useTypeScriptCli: false,
  },
}

export default nextConfig
next.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
  experimental: {
    useTypeScriptCli: false,
  },
}

module.exports = nextConfig

如果你在使用 TypeScript 7 时选择退出,next build 会退出,因为 TypeScript JavaScript 编译器 API 不可用。

行为#

  • 在运行检查器之前,Next.js 仍会生成 next-env.d.ts 和路由类型,并应用其推荐的 tsconfig 设置。
  • TypeScript 诊断信息直接由 tsc 打印。不会应用 Next.js 特有的代码框架和错误重写。
  • 会检查配置的 tsconfig 文件所选定的完整项目,包括测试文件以及(在被包含时).next/dev/types。--debug-build-paths 选项不会限制此集合,并且与 CLI 检查器一起使用时会产生警告。
  • typescript.tsconfigPath 选择传递给 tsc 的项目。
  • typescript.ignoreBuildErrors 会跳过类型检查步骤,包括 CLI 检查器。

了解更多关于在 Next.js 中使用 TypeScript 7的信息。

Next.js 中文网