next.config.js 配置选项
Next.js 可以通过项目目录根目录中的 next.config.js 文件进行配置(例如,与 package.json 同级),并使用默认导出。
// @ts-check
/** @type {import('next').NextConfig} */
const nextConfig = {
/* 在这里配置选项 */
}
module.exports = nextConfigECMAScript 模块
next.config.js 是一个常规的 Node.js 模块,而不是 JSON 文件。它被 Next.js 服务器和构建阶段使用,不会包含在浏览器构建中。
如果你需要使用 ECMAScript 模块,可以使用 next.config.mjs:
// @ts-check
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {
/* 在这里配置选项 */
}
export default nextConfig值得注意的是:目前不支持使用
.cjs、.cts或.mts扩展名的next.config文件。
配置作为函数
你也可以使用函数:
// @ts-check
export default (phase, { defaultConfig }) => {
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {
/* 在这里配置选项 */
}
return nextConfig
}异步配置
从 Next.js 12.1.0 开始,你可以使用异步函数:
// @ts-check
module.exports = async (phase, { defaultConfig }) => {
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {
/* 在这里配置选项 */
}
return nextConfig
}Phase
phase 是加载配置时的当前上下文。你可以查看可用的 phases。Phases 可以从 next/constants 导入:
// @ts-check
const { PHASE_DEVELOPMENT_SERVER } = require('next/constants')
module.exports = (phase, { defaultConfig }) => {
if (phase === PHASE_DEVELOPMENT_SERVER) {
return {
/* 仅开发环境的配置选项 */
}
}
return {
/* 除开发环境外所有阶段的配置选项 */
}
}TypeScript
如果你在项目中使用 TypeScript,可以使用 next.config.ts 在配置中使用 TypeScript:
import type { NextConfig } from 'next'
const nextConfig: NextConfig = {
/* 在这里配置选项 */
}
export default nextConfig注释行是你可以放置 next.config.js 允许的配置的地方,这些配置定义在此文件中。
然而,所有配置都不是必需的,也没有必要理解每个配置的作用。相反,在本节中搜索你需要启用或修改的功能,它们会告诉你该怎么做。
避免使用目标 Node.js 版本中不可用的新 JavaScript 特性。
next.config.js不会被 Webpack 或 Babel 解析。
本页面记录了所有可用的配置选项:
单元测试(实验性)
从 Next.js 15.1 开始,next/experimental/testing/server 包包含了帮助对 next.config.js 文件进行单元测试的实用工具。
unstable_getResponseFromNextConfig 函数使用提供的请求信息运行 next.config.js 中的 headers、redirects 和 rewrites 函数,并返回包含路由结果的 NextResponse。
来自
unstable_getResponseFromNextConfig的响应仅考虑next.config.js字段,不考虑代理或文件系统路由,因此生产环境中的结果可能与单元测试不同。
import {
getRedirectUrl,
unstable_getResponseFromNextConfig,
} from 'next/experimental/testing/server'
const response = await unstable_getResponseFromNextConfig({
url: 'https://nextjs.org/test',
nextConfig: {
async redirects() {
return [{ source: '/test', destination: '/test2', permanent: false }]
},
},
})
expect(response.status).toEqual(307)
expect(getRedirectUrl(response)).toEqual('https://nextjs.org/test2')