File size: 57,153 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 |
import { existsSync } from 'fs'
import { basename, extname, join, relative, isAbsolute, resolve } from 'path'
import { pathToFileURL } from 'url'
import findUp from 'next/dist/compiled/find-up'
import * as Log from '../build/output/log'
import * as ciEnvironment from '../server/ci-info'
import {
CONFIG_FILES,
PHASE_DEVELOPMENT_SERVER,
PHASE_EXPORT,
PHASE_PRODUCTION_BUILD,
PHASE_PRODUCTION_SERVER,
} from '../shared/lib/constants'
import { defaultConfig, normalizeConfig } from './config-shared'
import type {
ExperimentalConfig,
NextConfigComplete,
NextConfig,
TurbopackLoaderItem,
NextAdapter,
} from './config-shared'
import { loadWebpackHook } from './config-utils'
import { imageConfigDefault } from '../shared/lib/image-config'
import type { ImageConfig } from '../shared/lib/image-config'
import { loadEnvConfig, updateInitialEnv } from '@next/env'
import { flushAndExit } from '../telemetry/flush-and-exit'
import { findRootDir } from '../lib/find-root'
import { setHttpClientAndAgentOptions } from './setup-http-agent-env'
import { pathHasPrefix } from '../shared/lib/router/utils/path-has-prefix'
import { matchRemotePattern } from '../shared/lib/match-remote-pattern'
import type { ZodError } from 'next/dist/compiled/zod'
import { hasNextSupport } from '../server/ci-info'
import { transpileConfig } from '../build/next-config-ts/transpile-config'
import { dset } from '../shared/lib/dset'
import { normalizeZodErrors } from '../shared/lib/zod'
import { HTML_LIMITED_BOT_UA_RE_STRING } from '../shared/lib/router/utils/is-bot'
import { findDir } from '../lib/find-pages-dir'
import { CanaryOnlyError, isStableBuild } from '../shared/lib/canary-only'
import { interopDefault } from '../lib/interop-default'
import { djb2Hash } from '../shared/lib/hash'
export { normalizeConfig } from './config-shared'
export type { DomainLocale, NextConfig } from './config-shared'
function normalizeNextConfigZodErrors(
error: ZodError<NextConfig>
): [errorMessages: string[], shouldExit: boolean] {
let shouldExit = false
const issues = normalizeZodErrors(error)
return [
issues.flatMap(({ issue, message }) => {
if (issue.path[0] === 'images') {
// We exit the build when encountering an error in the images config
shouldExit = true
}
return message
}),
shouldExit,
]
}
export function warnOptionHasBeenDeprecated(
config: NextConfig,
nestedPropertyKey: string,
reason: string,
silent: boolean
): boolean {
let hasWarned = false
if (!silent) {
let current = config
let found = true
const nestedPropertyKeys = nestedPropertyKey.split('.')
for (const key of nestedPropertyKeys) {
if (current[key] !== undefined) {
current = current[key]
} else {
found = false
break
}
}
if (found) {
Log.warnOnce(reason)
hasWarned = true
}
}
return hasWarned
}
export function warnOptionHasBeenMovedOutOfExperimental(
config: NextConfig,
oldExperimentalKey: string,
newKey: string,
configFileName: string,
silent: boolean
) {
if (config.experimental && oldExperimentalKey in config.experimental) {
if (!silent) {
Log.warn(
`\`experimental.${oldExperimentalKey}\` has been moved to \`${newKey}\`. ` +
`Please update your ${configFileName} file accordingly.`
)
}
let current = config
const newKeys = newKey.split('.')
while (newKeys.length > 1) {
const key = newKeys.shift()!
current[key] = current[key] || {}
current = current[key]
}
current[newKeys.shift()!] = (config.experimental as any)[oldExperimentalKey]
}
return config
}
function warnCustomizedOption(
config: NextConfig,
key: string,
defaultValue: any,
customMessage: string,
configFileName: string,
silent: boolean
) {
const segs = key.split('.')
let current = config
while (segs.length >= 1) {
const seg = segs.shift()!
if (!(seg in current)) {
return
}
current = current[seg]
}
if (!silent && current !== defaultValue) {
Log.warn(
`The "${key}" option has been modified. ${customMessage ? customMessage + '. ' : ''}It should be removed from your ${configFileName}.`
)
}
}
function assignDefaults(
dir: string,
userConfig: NextConfig & { configFileName: string },
silent: boolean
): NextConfigComplete {
const configFileName = userConfig.configFileName
if (typeof userConfig.exportTrailingSlash !== 'undefined') {
if (!silent) {
Log.warn(
`The "exportTrailingSlash" option has been renamed to "trailingSlash". Please update your ${configFileName}.`
)
}
if (typeof userConfig.trailingSlash === 'undefined') {
userConfig.trailingSlash = userConfig.exportTrailingSlash
}
delete userConfig.exportTrailingSlash
}
// Handle deprecation of experimental.dynamicIO and migrate to experimental.cacheComponents
if (userConfig.experimental?.dynamicIO !== undefined) {
warnOptionHasBeenDeprecated(
userConfig,
'experimental.dynamicIO',
`\`experimental.dynamicIO\` has been renamed to \`experimental.cacheComponents\`. Please update your ${configFileName} file accordingly.`,
silent
)
// If cacheComponents was not explicitly set by the user (i.e., it's still the default value),
// use the dynamicIO value. We check against the user config, not the merged result.
if (userConfig.experimental?.cacheComponents === undefined) {
userConfig.experimental.cacheComponents =
userConfig.experimental.dynamicIO
}
// Remove the deprecated property
delete userConfig.experimental.dynamicIO
}
const config = Object.keys(userConfig).reduce<{ [key: string]: any }>(
(currentConfig, key) => {
const value = userConfig[key]
if (value === undefined || value === null) {
return currentConfig
}
if (key === 'distDir') {
if (typeof value !== 'string') {
throw new Error(
`Specified distDir is not a string, found type "${typeof value}"`
)
}
const userDistDir = value.trim()
// don't allow public as the distDir as this is a reserved folder for
// public files
if (userDistDir === 'public') {
throw new Error(
`The 'public' directory is reserved in Next.js and can not be set as the 'distDir'. https://nextjs.org/docs/messages/can-not-output-to-public`
)
}
// make sure distDir isn't an empty string as it can result in the provided
// directory being deleted in development mode
if (userDistDir.length === 0) {
throw new Error(
`Invalid distDir provided, distDir can not be an empty string. Please remove this config or set it to undefined`
)
}
}
if (key === 'pageExtensions') {
if (!Array.isArray(value)) {
throw new Error(
`Specified pageExtensions is not an array of strings, found "${value}". Please update this config or remove it.`
)
}
if (!value.length) {
throw new Error(
`Specified pageExtensions is an empty array. Please update it with the relevant extensions or remove it.`
)
}
value.forEach((ext) => {
if (typeof ext !== 'string') {
throw new Error(
`Specified pageExtensions is not an array of strings, found "${ext}" of type "${typeof ext}". Please update this config or remove it.`
)
}
})
}
const defaultValue = (defaultConfig as Record<string, unknown>)[key]
if (
!!value &&
value.constructor === Object &&
typeof defaultValue === 'object'
) {
currentConfig[key] = {
...defaultValue,
...Object.keys(value).reduce<any>((c, k) => {
const v = value[k]
if (v !== undefined && v !== null) {
c[k] = v
}
return c
}, {}),
}
} else {
currentConfig[key] = value
}
return currentConfig
},
{}
) as NextConfig & { configFileName: string }
const result = {
...defaultConfig,
...config,
experimental: {
...defaultConfig.experimental,
...config.experimental,
},
}
// ensure correct default is set for api-resolver revalidate handling
if (!result.experimental?.trustHostHeader && ciEnvironment.hasNextSupport) {
result.experimental.trustHostHeader = true
}
if (
result.experimental?.allowDevelopmentBuild &&
process.env.NODE_ENV !== 'development'
) {
throw new Error(
`The experimental.allowDevelopmentBuild option requires NODE_ENV to be explicitly set to 'development'.`
)
}
if (isStableBuild()) {
// Prevents usage of certain experimental features outside of canary
if (result.experimental?.ppr) {
throw new CanaryOnlyError({ feature: 'experimental.ppr' })
} else if (result.experimental?.cacheComponents) {
throw new CanaryOnlyError({ feature: 'experimental.cacheComponents' })
} else if (result.experimental?.turbopackPersistentCaching) {
throw new CanaryOnlyError({
feature: 'experimental.turbopackPersistentCaching',
})
}
}
if (result.output === 'export') {
if (result.i18n) {
throw new Error(
'Specified "i18n" cannot be used with "output: export". See more info here: https://nextjs.org/docs/messages/export-no-i18n'
)
}
if (!hasNextSupport) {
if (result.rewrites) {
Log.warn(
'Specified "rewrites" will not automatically work with "output: export". See more info here: https://nextjs.org/docs/messages/export-no-custom-routes'
)
}
if (result.redirects) {
Log.warn(
'Specified "redirects" will not automatically work with "output: export". See more info here: https://nextjs.org/docs/messages/export-no-custom-routes'
)
}
if (result.headers) {
Log.warn(
'Specified "headers" will not automatically work with "output: export". See more info here: https://nextjs.org/docs/messages/export-no-custom-routes'
)
}
}
}
if (typeof result.assetPrefix !== 'string') {
throw new Error(
`Specified assetPrefix is not a string, found type "${typeof result.assetPrefix}" https://nextjs.org/docs/messages/invalid-assetprefix`
)
}
if (typeof result.basePath !== 'string') {
throw new Error(
`Specified basePath is not a string, found type "${typeof result.basePath}"`
)
}
if (result.basePath !== '') {
if (result.basePath === '/') {
throw new Error(
`Specified basePath /. basePath has to be either an empty string or a path prefix"`
)
}
if (!result.basePath.startsWith('/')) {
throw new Error(
`Specified basePath has to start with a /, found "${result.basePath}"`
)
}
if (result.basePath !== '/') {
if (result.basePath.endsWith('/')) {
throw new Error(
`Specified basePath should not end with /, found "${result.basePath}"`
)
}
if (result.assetPrefix === '') {
result.assetPrefix = result.basePath
}
if (result.amp?.canonicalBase === '') {
result.amp.canonicalBase = result.basePath
}
}
}
if (result?.images) {
const images: ImageConfig = result.images
if (typeof images !== 'object') {
throw new Error(
`Specified images should be an object received ${typeof images}.\nSee more info here: https://nextjs.org/docs/messages/invalid-images-config`
)
}
if (images.localPatterns) {
if (!Array.isArray(images.localPatterns)) {
throw new Error(
`Specified images.localPatterns should be an Array received ${typeof images.localPatterns}.\nSee more info here: https://nextjs.org/docs/messages/invalid-images-config`
)
}
// avoid double-pushing the same pattern if it already exists
const hasMatch = images.localPatterns.some(
(pattern) =>
pattern.pathname === '/_next/static/media/**' && pattern.search === ''
)
if (!hasMatch) {
// static import images are automatically allowed
images.localPatterns.push({
pathname: '/_next/static/media/**',
search: '',
})
}
}
if (images.remotePatterns) {
if (!Array.isArray(images.remotePatterns)) {
throw new Error(
`Specified images.remotePatterns should be an Array received ${typeof images.remotePatterns}.\nSee more info here: https://nextjs.org/docs/messages/invalid-images-config`
)
}
// We must convert URL to RemotePattern since URL has a colon in the protocol
// and also has additional properties we want to filter out. Also, new URL()
// accepts any protocol so we need manual validation here.
images.remotePatterns = images.remotePatterns.map(
({ protocol, hostname, port, pathname, search }) => {
const proto = protocol?.replace(/:$/, '')
if (!['http', 'https', undefined].includes(proto)) {
throw new Error(
`Specified images.remotePatterns must have protocol "http" or "https" received "${proto}".`
)
}
return {
protocol: proto as 'http' | 'https' | undefined,
hostname,
port,
pathname,
search,
}
}
)
// static images are automatically prefixed with assetPrefix
// so we need to ensure _next/image allows downloading from
// this resource
if (config.assetPrefix?.startsWith('http')) {
try {
const url = new URL(config.assetPrefix)
const hasMatchForAssetPrefix = images.remotePatterns.some((pattern) =>
matchRemotePattern(pattern, url)
)
// avoid double-pushing the same pattern if it already can be matched
if (!hasMatchForAssetPrefix) {
images.remotePatterns.push({
hostname: url.hostname,
protocol: url.protocol.replace(/:$/, '') as 'http' | 'https',
port: url.port,
})
}
} catch (error) {
throw new Error(
`Invalid assetPrefix provided. Original error: ${error}`
)
}
}
}
if (images.domains) {
if (!Array.isArray(images.domains)) {
throw new Error(
`Specified images.domains should be an Array received ${typeof images.domains}.\nSee more info here: https://nextjs.org/docs/messages/invalid-images-config`
)
}
}
if (!images.loader) {
images.loader = 'default'
}
if (
images.loader !== 'default' &&
images.loader !== 'custom' &&
images.path === imageConfigDefault.path
) {
throw new Error(
`Specified images.loader property (${images.loader}) also requires images.path property to be assigned to a URL prefix.\nSee more info here: https://nextjs.org/docs/api-reference/next/legacy/image#loader-configuration`
)
}
if (
images.path === imageConfigDefault.path &&
result.basePath &&
!pathHasPrefix(images.path, result.basePath)
) {
images.path = `${result.basePath}${images.path}`
}
// Append trailing slash for non-default loaders and when trailingSlash is set
if (
images.path &&
!images.path.endsWith('/') &&
(images.loader !== 'default' || result.trailingSlash)
) {
images.path += '/'
}
if (images.loaderFile) {
if (images.loader !== 'default' && images.loader !== 'custom') {
throw new Error(
`Specified images.loader property (${images.loader}) cannot be used with images.loaderFile property. Please set images.loader to "custom".`
)
}
const absolutePath = join(dir, images.loaderFile)
if (!existsSync(absolutePath)) {
throw new Error(
`Specified images.loaderFile does not exist at "${absolutePath}".`
)
}
images.loaderFile = absolutePath
}
}
warnCustomizedOption(
result,
'experimental.esmExternals',
true,
'experimental.esmExternals is not recommended to be modified as it may disrupt module resolution',
configFileName,
silent
)
warnOptionHasBeenDeprecated(
result,
'experimental.instrumentationHook',
`\`experimental.instrumentationHook\` is no longer needed, because \`instrumentation.js\` is available by default. You can remove it from ${configFileName}.`,
silent
)
warnOptionHasBeenDeprecated(
result,
'experimental.after',
`\`experimental.after\` is no longer needed, because \`after\` is available by default. You can remove it from ${configFileName}.`,
silent
)
warnOptionHasBeenDeprecated(
result,
'devIndicators.appIsrStatus',
`\`devIndicators.appIsrStatus\` is deprecated and no longer configurable. Please remove it from ${configFileName}.`,
silent
)
warnOptionHasBeenDeprecated(
result,
'devIndicators.buildActivity',
`\`devIndicators.buildActivity\` is deprecated and no longer configurable. Please remove it from ${configFileName}.`,
silent
)
const hasWarnedBuildActivityPosition = warnOptionHasBeenDeprecated(
result,
'devIndicators.buildActivityPosition',
`\`devIndicators.buildActivityPosition\` has been renamed to \`devIndicators.position\`. Please update your ${configFileName} file accordingly.`,
silent
)
if (
hasWarnedBuildActivityPosition &&
result.devIndicators !== false &&
'buildActivityPosition' in result.devIndicators &&
result.devIndicators.buildActivityPosition !== result.devIndicators.position
) {
Log.warnOnce(
`The \`devIndicators\` option \`buildActivityPosition\` ("${result.devIndicators.buildActivityPosition}") conflicts with \`position\` ("${result.devIndicators.position}"). Using \`buildActivityPosition\` ("${result.devIndicators.buildActivityPosition}") for backward compatibility.`
)
result.devIndicators.position = result.devIndicators.buildActivityPosition
}
warnOptionHasBeenMovedOutOfExperimental(
result,
'bundlePagesExternals',
'bundlePagesRouterDependencies',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'serverComponentsExternalPackages',
'serverExternalPackages',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'relay',
'compiler.relay',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'styledComponents',
'compiler.styledComponents',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'emotion',
'compiler.emotion',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'reactRemoveProperties',
'compiler.reactRemoveProperties',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'removeConsole',
'compiler.removeConsole',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'swrDelta',
'expireTime',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'outputFileTracingRoot',
'outputFileTracingRoot',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'outputFileTracingIncludes',
'outputFileTracingIncludes',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'outputFileTracingExcludes',
'outputFileTracingExcludes',
configFileName,
silent
)
if ((result.experimental as any).outputStandalone) {
if (!silent) {
Log.warn(
`experimental.outputStandalone has been renamed to "output: 'standalone'", please move the config.`
)
}
result.output = 'standalone'
}
if (
typeof result.experimental?.serverActions?.bodySizeLimit !== 'undefined'
) {
const value = parseInt(
result.experimental.serverActions?.bodySizeLimit.toString()
)
if (isNaN(value) || value < 1) {
throw new Error(
'Server Actions Size Limit must be a valid number or filesize format larger than 1MB: https://nextjs.org/docs/app/api-reference/next-config-js/serverActions#bodysizelimit'
)
}
}
warnOptionHasBeenMovedOutOfExperimental(
result,
'transpilePackages',
'transpilePackages',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'skipMiddlewareUrlNormalize',
'skipMiddlewareUrlNormalize',
configFileName,
silent
)
warnOptionHasBeenMovedOutOfExperimental(
result,
'skipTrailingSlashRedirect',
'skipTrailingSlashRedirect',
configFileName,
silent
)
if (
result?.outputFileTracingRoot &&
!isAbsolute(result.outputFileTracingRoot)
) {
result.outputFileTracingRoot = resolve(result.outputFileTracingRoot)
if (!silent) {
Log.warn(
`outputFileTracingRoot should be absolute, using: ${result.outputFileTracingRoot}`
)
}
}
if (result?.turbopack?.root && !isAbsolute(result.turbopack.root)) {
result.turbopack.root = resolve(result.turbopack.root)
if (!silent) {
Log.warn(
`turbopack.root should be absolute, using: ${result.turbopack.root}`
)
}
}
// only leverage deploymentId
if (process.env.NEXT_DEPLOYMENT_ID) {
result.deploymentId = process.env.NEXT_DEPLOYMENT_ID
}
if (result?.outputFileTracingRoot && !result?.turbopack?.root) {
dset(result, ['turbopack', 'root'], result.outputFileTracingRoot)
}
// use the highest level lockfile as tracing root
if (!result?.outputFileTracingRoot || !result?.turbopack?.root) {
let rootDir = findRootDir(dir)
if (rootDir) {
if (!result?.outputFileTracingRoot) {
result.outputFileTracingRoot = rootDir
}
if (!result?.turbopack?.root) {
dset(result, ['turbopack', 'root'], rootDir)
}
}
}
setHttpClientAndAgentOptions(result || defaultConfig)
if (result.i18n) {
const hasAppDir = Boolean(findDir(dir, 'app'))
if (hasAppDir) {
warnOptionHasBeenDeprecated(
result,
'i18n',
`i18n configuration in ${configFileName} is unsupported in App Router.\nLearn more about internationalization in App Router: https://nextjs.org/docs/app/building-your-application/routing/internationalization`,
silent
)
}
const { i18n } = result
const i18nType = typeof i18n
if (i18nType !== 'object') {
throw new Error(
`Specified i18n should be an object received ${i18nType}.\nSee more info here: https://nextjs.org/docs/messages/invalid-i18n-config`
)
}
if (!Array.isArray(i18n.locales)) {
throw new Error(
`Specified i18n.locales should be an Array received ${typeof i18n.locales}.\nSee more info here: https://nextjs.org/docs/messages/invalid-i18n-config`
)
}
if (i18n.locales.length > 100 && !silent) {
Log.warn(
`Received ${i18n.locales.length} i18n.locales items which exceeds the recommended max of 100.\nSee more info here: https://nextjs.org/docs/advanced-features/i18n-routing#how-does-this-work-with-static-generation`
)
}
const defaultLocaleType = typeof i18n.defaultLocale
if (!i18n.defaultLocale || defaultLocaleType !== 'string') {
throw new Error(
`Specified i18n.defaultLocale should be a string.\nSee more info here: https://nextjs.org/docs/messages/invalid-i18n-config`
)
}
if (typeof i18n.domains !== 'undefined' && !Array.isArray(i18n.domains)) {
throw new Error(
`Specified i18n.domains must be an array of domain objects e.g. [ { domain: 'example.fr', defaultLocale: 'fr', locales: ['fr'] } ] received ${typeof i18n.domains}.\nSee more info here: https://nextjs.org/docs/messages/invalid-i18n-config`
)
}
if (i18n.domains) {
const invalidDomainItems = i18n.domains.filter((item) => {
if (!item || typeof item !== 'object') return true
if (!item.defaultLocale) return true
if (!item.domain || typeof item.domain !== 'string') return true
if (item.domain.includes(':')) {
console.warn(
`i18n domain: "${item.domain}" is invalid it should be a valid domain without protocol (https://) or port (:3000) e.g. example.vercel.sh`
)
return true
}
const defaultLocaleDuplicate = i18n.domains?.find(
(altItem) =>
altItem.defaultLocale === item.defaultLocale &&
altItem.domain !== item.domain
)
if (!silent && defaultLocaleDuplicate) {
console.warn(
`Both ${item.domain} and ${defaultLocaleDuplicate.domain} configured the defaultLocale ${item.defaultLocale} but only one can. Change one item's default locale to continue`
)
return true
}
let hasInvalidLocale = false
if (Array.isArray(item.locales)) {
for (const locale of item.locales) {
if (typeof locale !== 'string') hasInvalidLocale = true
for (const domainItem of i18n.domains || []) {
if (domainItem === item) continue
if (domainItem.locales && domainItem.locales.includes(locale)) {
console.warn(
`Both ${item.domain} and ${domainItem.domain} configured the locale (${locale}) but only one can. Remove it from one i18n.domains config to continue`
)
hasInvalidLocale = true
break
}
}
}
}
return hasInvalidLocale
})
if (invalidDomainItems.length > 0) {
throw new Error(
`Invalid i18n.domains values:\n${invalidDomainItems
.map((item: any) => JSON.stringify(item))
.join(
'\n'
)}\n\ndomains value must follow format { domain: 'example.fr', defaultLocale: 'fr', locales: ['fr'] }.\nSee more info here: https://nextjs.org/docs/messages/invalid-i18n-config`
)
}
}
if (!Array.isArray(i18n.locales)) {
throw new Error(
`Specified i18n.locales must be an array of locale strings e.g. ["en-US", "nl-NL"] received ${typeof i18n.locales}.\nSee more info here: https://nextjs.org/docs/messages/invalid-i18n-config`
)
}
const invalidLocales = i18n.locales.filter(
(locale: any) => typeof locale !== 'string'
)
if (invalidLocales.length > 0) {
throw new Error(
`Specified i18n.locales contains invalid values (${invalidLocales
.map(String)
.join(
', '
)}), locales must be valid locale tags provided as strings e.g. "en-US".\n` +
`See here for list of valid language sub-tags: http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry`
)
}
if (!i18n.locales.includes(i18n.defaultLocale)) {
throw new Error(
`Specified i18n.defaultLocale should be included in i18n.locales.\nSee more info here: https://nextjs.org/docs/messages/invalid-i18n-config`
)
}
const normalizedLocales = new Set()
const duplicateLocales = new Set()
i18n.locales.forEach((locale) => {
const localeLower = locale.toLowerCase()
if (normalizedLocales.has(localeLower)) {
duplicateLocales.add(locale)
}
normalizedLocales.add(localeLower)
})
if (duplicateLocales.size > 0) {
throw new Error(
`Specified i18n.locales contains the following duplicate locales:\n` +
`${[...duplicateLocales].join(', ')}\n` +
`Each locale should be listed only once.\n` +
`See more info here: https://nextjs.org/docs/messages/invalid-i18n-config`
)
}
// make sure default Locale is at the front
i18n.locales = [
i18n.defaultLocale,
...i18n.locales.filter((locale) => locale !== i18n.defaultLocale),
]
const localeDetectionType = typeof i18n.localeDetection
if (
localeDetectionType !== 'boolean' &&
localeDetectionType !== 'undefined'
) {
throw new Error(
`Specified i18n.localeDetection should be undefined or a boolean received ${localeDetectionType}.\nSee more info here: https://nextjs.org/docs/messages/invalid-i18n-config`
)
}
}
if (result.devIndicators !== false && result.devIndicators?.position) {
const { position } = result.devIndicators
const allowedValues = [
'top-left',
'top-right',
'bottom-left',
'bottom-right',
]
if (!allowedValues.includes(position)) {
throw new Error(
`Invalid "devIndicator.position" provided, expected one of ${allowedValues.join(
', '
)}, received ${position}`
)
}
}
if (result.experimental) {
result.experimental.cacheLife = {
...defaultConfig.experimental?.cacheLife,
...result.experimental.cacheLife,
}
const defaultDefault = defaultConfig.experimental?.cacheLife?.['default']
if (
!defaultDefault ||
defaultDefault.revalidate === undefined ||
defaultDefault.expire === undefined ||
!defaultConfig.experimental?.staleTimes?.static
) {
throw new Error('No default cacheLife profile.')
}
const defaultCacheLifeProfile = result.experimental.cacheLife['default']
if (!defaultCacheLifeProfile) {
result.experimental.cacheLife['default'] = defaultDefault
} else {
if (defaultCacheLifeProfile.stale === undefined) {
const staticStaleTime = result.experimental.staleTimes?.static
defaultCacheLifeProfile.stale =
staticStaleTime ?? defaultConfig.experimental?.staleTimes?.static
}
if (defaultCacheLifeProfile.revalidate === undefined) {
defaultCacheLifeProfile.revalidate = defaultDefault.revalidate
}
if (defaultCacheLifeProfile.expire === undefined) {
defaultCacheLifeProfile.expire =
result.expireTime ?? defaultDefault.expire
}
}
// This is the most dynamic cache life profile.
const secondsCacheLifeProfile = result.experimental.cacheLife['seconds']
if (
secondsCacheLifeProfile &&
secondsCacheLifeProfile.stale === undefined
) {
// We default this to whatever stale time you had configured for dynamic content.
// Since this is basically a dynamic cache life profile.
const dynamicStaleTime = result.experimental.staleTimes?.dynamic
secondsCacheLifeProfile.stale =
dynamicStaleTime ?? defaultConfig.experimental?.staleTimes?.dynamic
}
}
if (result.experimental?.cacheHandlers) {
const allowedHandlerNameRegex = /[a-z-]/
if (typeof result.experimental.cacheHandlers !== 'object') {
throw new Error(
`Invalid "experimental.cacheHandlers" provided, expected an object e.g. { default: '/my-handler.js' }, received ${JSON.stringify(result.experimental.cacheHandlers)}`
)
}
const handlerKeys = Object.keys(result.experimental.cacheHandlers)
const invalidHandlerItems: Array<{ key: string; reason: string }> = []
for (const key of handlerKeys) {
if (key === 'private') {
invalidHandlerItems.push({
key,
reason:
'The cache handler for "use cache: private" cannot be customized.',
})
} else if (!allowedHandlerNameRegex.test(key)) {
invalidHandlerItems.push({
key,
reason: 'key must only use characters a-z and -',
})
} else {
const handlerPath = (
result.experimental.cacheHandlers as {
[handlerName: string]: string | undefined
}
)[key]
if (handlerPath && !existsSync(handlerPath)) {
invalidHandlerItems.push({
key,
reason: `cache handler path provided does not exist, received ${handlerPath}`,
})
}
}
if (invalidHandlerItems.length) {
throw new Error(
`Invalid handler fields configured for "experimental.cacheHandler":\n${invalidHandlerItems.map((item) => `${key}: ${item.reason}`).join('\n')}`
)
}
}
}
const userProvidedModularizeImports = result.modularizeImports
// Unfortunately these packages end up re-exporting 10600 modules, for example: https://unpkg.com/browse/@mui/icons-material@5.11.16/esm/index.js.
// Leveraging modularizeImports tremendously reduces compile times for these.
result.modularizeImports = {
...(userProvidedModularizeImports || {}),
// This is intentionally added after the user-provided modularizeImports config.
'@mui/icons-material': {
transform: '@mui/icons-material/{{member}}',
},
lodash: {
transform: 'lodash/{{member}}',
},
}
const userProvidedOptimizePackageImports =
result.experimental?.optimizePackageImports || []
result.experimental.optimizePackageImports = [
...new Set([
...userProvidedOptimizePackageImports,
'lucide-react',
'date-fns',
'lodash-es',
'ramda',
'antd',
'react-bootstrap',
'ahooks',
'@ant-design/icons',
'@headlessui/react',
'@headlessui-float/react',
'@heroicons/react/20/solid',
'@heroicons/react/24/solid',
'@heroicons/react/24/outline',
'@visx/visx',
'@tremor/react',
'rxjs',
'@mui/material',
'@mui/icons-material',
'recharts',
'react-use',
'effect',
'@effect/schema',
'@effect/platform',
'@effect/platform-node',
'@effect/platform-browser',
'@effect/platform-bun',
'@effect/sql',
'@effect/sql-mssql',
'@effect/sql-mysql2',
'@effect/sql-pg',
'@effect/sql-sqlite-node',
'@effect/sql-sqlite-bun',
'@effect/sql-sqlite-wasm',
'@effect/sql-sqlite-react-native',
'@effect/rpc',
'@effect/rpc-http',
'@effect/typeclass',
'@effect/experimental',
'@effect/opentelemetry',
'@material-ui/core',
'@material-ui/icons',
'@tabler/icons-react',
'mui-core',
// We don't support wildcard imports for these configs, e.g. `react-icons/*`
// so we need to add them manually.
// In the future, we should consider automatically detecting packages that
// need to be optimized.
'react-icons/ai',
'react-icons/bi',
'react-icons/bs',
'react-icons/cg',
'react-icons/ci',
'react-icons/di',
'react-icons/fa',
'react-icons/fa6',
'react-icons/fc',
'react-icons/fi',
'react-icons/gi',
'react-icons/go',
'react-icons/gr',
'react-icons/hi',
'react-icons/hi2',
'react-icons/im',
'react-icons/io',
'react-icons/io5',
'react-icons/lia',
'react-icons/lib',
'react-icons/lu',
'react-icons/md',
'react-icons/pi',
'react-icons/ri',
'react-icons/rx',
'react-icons/si',
'react-icons/sl',
'react-icons/tb',
'react-icons/tfi',
'react-icons/ti',
'react-icons/vsc',
'react-icons/wi',
]),
]
if (!result.htmlLimitedBots) {
// @ts-expect-error: override the htmlLimitedBots with default string, type covert: RegExp -> string
result.htmlLimitedBots = HTML_LIMITED_BOT_UA_RE_STRING
}
// "use cache" was originally implicitly enabled with the cacheComponents flag, so
// we transfer the value for cacheComponents to the explicit useCache flag to ensure
// backwards compatibility.
if (result.experimental.useCache === undefined) {
result.experimental.useCache = result.experimental.cacheComponents
}
// If cacheComponents is enabled, we also enable PPR.
if (result.experimental.cacheComponents) {
if (
userConfig.experimental?.ppr === false ||
userConfig.experimental?.ppr === 'incremental'
) {
throw new Error(
`\`experimental.ppr\` can not be \`${JSON.stringify(userConfig.experimental?.ppr)}\` when \`experimental.cacheComponents\` is \`true\`. PPR is implicitly enabled when Cache Components is enabled.`
)
}
result.experimental.ppr = true
}
return result as NextConfigComplete
}
async function applyModifyConfig(
config: NextConfigComplete,
phase: string,
silent: boolean
): Promise<NextConfigComplete> {
if (
// TODO: should this be called for server start as
// adapters shouldn't be relying on "next start"
[PHASE_PRODUCTION_BUILD, PHASE_PRODUCTION_SERVER].includes(phase) &&
config.experimental?.adapterPath
) {
const adapterMod = interopDefault(
await import(
pathToFileURL(require.resolve(config.experimental.adapterPath)).href
)
) as NextAdapter
if (typeof adapterMod.modifyConfig === 'function') {
if (!silent) {
Log.info(`Applying modifyConfig from ${adapterMod.name}`)
}
config = await adapterMod.modifyConfig(config)
}
}
return config
}
// Cache config with keys to handle multiple configurations (e.g., multi-zone)
const configCache = new Map<
string,
{
rawConfig: any
config: NextConfigComplete
configuredExperimentalFeatures: ConfiguredExperimentalFeature[]
}
>()
// Generate cache key based on parameters that affect config output
// We need a unique key for cache because there can be multiple values
function getCacheKey(
phase: string,
dir: string,
customConfig?: object | null,
reactProductionProfiling?: boolean,
debugPrerender?: boolean
): string {
// The next.config.js is unique per project, so we can use the dir as the major key
// to generate the unique config key.
const keyData = JSON.stringify({
dir,
phase,
hasCustomConfig: Boolean(customConfig),
reactProductionProfiling: Boolean(reactProductionProfiling),
debugPrerender: Boolean(debugPrerender),
})
return djb2Hash(keyData).toString(36)
}
export default async function loadConfig(
phase: string,
dir: string,
{
customConfig,
rawConfig,
silent = true,
reportExperimentalFeatures,
reactProductionProfiling,
debugPrerender,
}: {
customConfig?: object | null
rawConfig?: boolean
silent?: boolean
reportExperimentalFeatures?: (
configuredExperimentalFeatures: ConfiguredExperimentalFeature[]
) => void
reactProductionProfiling?: boolean
debugPrerender?: boolean
} = {}
): Promise<NextConfigComplete> {
// Generate cache key based on parameters that affect config output
const cacheKey = getCacheKey(
phase,
dir,
customConfig,
reactProductionProfiling,
debugPrerender
)
// Check if we have a cached result
const cachedResult = configCache.get(cacheKey)
if (cachedResult) {
// Call the experimental features callback if provided
if (reportExperimentalFeatures) {
reportExperimentalFeatures(cachedResult.configuredExperimentalFeatures)
}
// Return raw config if requested and available
if (rawConfig && cachedResult.rawConfig) {
return cachedResult.rawConfig
}
return cachedResult.config
}
// Original implementation continues below...
if (!process.env.__NEXT_PRIVATE_RENDER_WORKER) {
try {
loadWebpackHook()
} catch (err) {
// this can fail in standalone mode as the files
// aren't traced/included
if (!process.env.__NEXT_PRIVATE_STANDALONE_CONFIG) {
throw err
}
}
}
if (process.env.__NEXT_PRIVATE_STANDALONE_CONFIG) {
// we don't apply assignDefaults or modifyConfig here as it
// has already been applied
const standaloneConfig = JSON.parse(
process.env.__NEXT_PRIVATE_STANDALONE_CONFIG
)
// Cache the standalone config
configCache.set(cacheKey, {
config: standaloneConfig,
rawConfig: standaloneConfig,
configuredExperimentalFeatures: [],
})
return standaloneConfig
}
const curLog = silent
? {
warn: () => {},
info: () => {},
error: () => {},
}
: Log
loadEnvConfig(dir, phase === PHASE_DEVELOPMENT_SERVER, curLog)
let configFileName = 'next.config.js'
const configuredExperimentalFeatures: ConfiguredExperimentalFeature[] = []
if (customConfig) {
const config = await applyModifyConfig(
assignDefaults(
dir,
{
configOrigin: 'server',
configFileName,
...customConfig,
},
silent
) as NextConfigComplete,
phase,
silent
)
// Cache the custom config result
configCache.set(cacheKey, {
config,
rawConfig: customConfig,
configuredExperimentalFeatures,
})
reportExperimentalFeatures?.(configuredExperimentalFeatures)
return config
}
const path = await findUp(CONFIG_FILES, { cwd: dir })
// If config file was found
if (path?.length) {
configFileName = basename(path)
let userConfigModule: any
try {
const envBefore = Object.assign({}, process.env)
// `import()` expects url-encoded strings, so the path must be properly
// escaped and (especially on Windows) absolute paths must pe prefixed
// with the `file://` protocol
if (process.env.__NEXT_TEST_MODE === 'jest') {
// dynamic import does not currently work inside of vm which
// jest relies on so we fall back to require for this case
// https://github.com/nodejs/node/issues/35889
userConfigModule = require(path)
} else if (configFileName === 'next.config.ts') {
userConfigModule = await transpileConfig({
nextConfigPath: path,
configFileName,
cwd: dir,
})
} else {
userConfigModule = await import(pathToFileURL(path).href)
}
const newEnv: typeof process.env = {} as any
for (const key of Object.keys(process.env)) {
if (envBefore[key] !== process.env[key]) {
newEnv[key] = process.env[key]
}
}
updateInitialEnv(newEnv)
if (rawConfig) {
// Cache the raw config
configCache.set(cacheKey, {
config: userConfigModule as NextConfigComplete,
rawConfig: userConfigModule,
configuredExperimentalFeatures,
})
reportExperimentalFeatures?.(configuredExperimentalFeatures)
return userConfigModule
}
} catch (err) {
// TODO: Modify docs to add cases of failing next.config.ts transformation
curLog.error(
`Failed to load ${configFileName}, see more info here https://nextjs.org/docs/messages/next-config-error`
)
throw err
}
const loadedConfig = Object.freeze(
(await normalizeConfig(
phase,
interopDefault(userConfigModule)
)) as NextConfig
)
if (loadedConfig.experimental) {
for (const name of Object.keys(
loadedConfig.experimental
) as (keyof ExperimentalConfig)[]) {
const value = loadedConfig.experimental[name]
if (name === 'turbo' && !process.env.TURBOPACK) {
// Ignore any Turbopack config if Turbopack is not enabled
continue
}
addConfiguredExperimentalFeature(
configuredExperimentalFeatures,
name,
value
)
}
}
// Clone a new userConfig each time to avoid mutating the original
const userConfig = cloneObject(loadedConfig) as NextConfig
// Always validate the config against schema in non minimal mode.
// Only validate once in the root Next.js process, not in forked processes.
const isRootProcess = typeof process.send !== 'function'
if (!process.env.NEXT_MINIMAL && isRootProcess) {
// We only validate the config against schema in non minimal mode
const { configSchema } =
require('./config-schema') as typeof import('./config-schema')
const state = configSchema.safeParse(userConfig)
if (!state.success) {
// error message header
const messages = [`Invalid ${configFileName} options detected: `]
const [errorMessages, shouldExit] = normalizeNextConfigZodErrors(
state.error
)
// ident list item
for (const error of errorMessages) {
messages.push(` ${error}`)
}
// error message footer
messages.push(
'See more info here: https://nextjs.org/docs/messages/invalid-next-config'
)
if (shouldExit) {
for (const message of messages) {
console.error(message)
}
await flushAndExit(1)
} else {
for (const message of messages) {
curLog.warn(message)
}
}
}
}
if (userConfig.target && userConfig.target !== 'server') {
throw new Error(
`The "target" property is no longer supported in ${configFileName}.\n` +
'See more info here https://nextjs.org/docs/messages/deprecated-target-config'
)
}
if (userConfig.amp?.canonicalBase) {
const { canonicalBase } = userConfig.amp || ({} as any)
userConfig.amp = userConfig.amp || {}
userConfig.amp.canonicalBase =
(canonicalBase?.endsWith('/')
? canonicalBase.slice(0, -1)
: canonicalBase) || ''
}
if (reactProductionProfiling) {
userConfig.reactProductionProfiling = reactProductionProfiling
}
if (
userConfig.experimental?.turbo?.loaders &&
!userConfig.experimental?.turbo?.rules
) {
curLog.warn(
'experimental.turbo.loaders is now deprecated. Please update next.config.js to use experimental.turbo.rules as soon as possible.\n' +
'The new option is similar, but the key should be a glob instead of an extension.\n' +
'Example: loaders: { ".mdx": ["mdx-loader"] } -> rules: { "*.mdx": ["mdx-loader"] }" }\n' +
'See more info here https://nextjs.org/docs/app/api-reference/next-config-js/turbo'
)
const rules: Record<string, TurbopackLoaderItem[]> = {}
for (const [ext, loaders] of Object.entries(
userConfig.experimental.turbo.loaders
)) {
rules['*' + ext] = loaders as TurbopackLoaderItem[]
}
userConfig.experimental.turbo.rules = rules
}
if (userConfig.experimental?.turbo) {
curLog.warn(
'The config property `experimental.turbo` is deprecated. Move this setting to `config.turbopack` as Turbopack is now stable.'
)
// Merge the two configs, preferring values in `config.turbopack`.
userConfig.turbopack = {
...userConfig.experimental.turbo,
...userConfig.turbopack,
}
userConfig.experimental.turbopackMemoryLimit ??=
userConfig.experimental.turbo.memoryLimit
userConfig.experimental.turbopackMinify ??=
userConfig.experimental.turbo.minify
userConfig.experimental.turbopackTreeShaking ??=
userConfig.experimental.turbo.treeShaking
userConfig.experimental.turbopackSourceMaps ??=
userConfig.experimental.turbo.sourceMaps
}
if (userConfig.experimental?.useLightningcss) {
const { loadBindings } =
require('../build/swc') as typeof import('../build/swc')
const isLightningSupported = (await loadBindings())?.css?.lightning
if (!isLightningSupported) {
curLog.warn(
`experimental.useLightningcss is set, but the setting is disabled because next-swc/wasm does not support it yet.`
)
userConfig.experimental.useLightningcss = false
}
}
// serialize the regex config into string
if (userConfig?.htmlLimitedBots instanceof RegExp) {
// @ts-expect-error: override the htmlLimitedBots with default string, type covert: RegExp -> string
userConfig.htmlLimitedBots = userConfig.htmlLimitedBots.source
}
enforceExperimentalFeatures(userConfig, {
isDefaultConfig: false,
configuredExperimentalFeatures,
debugPrerender,
phase,
})
const completeConfig = assignDefaults(
dir,
{
configOrigin: relative(dir, path),
configFile: path,
configFileName,
...userConfig,
},
silent
) as NextConfigComplete
const finalConfig = await applyModifyConfig(completeConfig, phase, silent)
// Cache the final result
configCache.set(cacheKey, {
config: finalConfig,
rawConfig: userConfigModule, // Store the original user config module
configuredExperimentalFeatures,
})
if (reportExperimentalFeatures) {
reportExperimentalFeatures(configuredExperimentalFeatures)
}
return finalConfig
} else {
const configBaseName = basename(CONFIG_FILES[0], extname(CONFIG_FILES[0]))
const unsupportedConfig = findUp.sync(
[
`${configBaseName}.cjs`,
`${configBaseName}.cts`,
`${configBaseName}.mts`,
`${configBaseName}.json`,
`${configBaseName}.jsx`,
`${configBaseName}.tsx`,
],
{ cwd: dir }
)
if (unsupportedConfig?.length) {
throw new Error(
`Configuring Next.js via '${basename(
unsupportedConfig
)}' is not supported. Please replace the file with 'next.config.js', 'next.config.mjs', or 'next.config.ts'.`
)
}
}
const clonedDefaultConfig = cloneObject(defaultConfig) as NextConfig
enforceExperimentalFeatures(clonedDefaultConfig, {
isDefaultConfig: true,
configuredExperimentalFeatures,
debugPrerender,
phase,
})
// always call assignDefaults to ensure settings like
// reactRoot can be updated correctly even with no next.config.js
const completeConfig = assignDefaults(
dir,
{ ...clonedDefaultConfig, configFileName },
silent
) as NextConfigComplete
setHttpClientAndAgentOptions(completeConfig)
const finalConfig = await applyModifyConfig(completeConfig, phase, silent)
// Cache the default config result
configCache.set(cacheKey, {
config: finalConfig,
rawConfig: clonedDefaultConfig,
configuredExperimentalFeatures,
})
if (reportExperimentalFeatures) {
reportExperimentalFeatures(configuredExperimentalFeatures)
}
return finalConfig
}
export type ConfiguredExperimentalFeature = {
key: keyof ExperimentalConfig
value: ExperimentalConfig[keyof ExperimentalConfig]
reason?: string
}
function enforceExperimentalFeatures(
config: NextConfig,
options: {
isDefaultConfig: boolean
configuredExperimentalFeatures: ConfiguredExperimentalFeature[] | undefined
debugPrerender: boolean | undefined
phase: string
}
) {
const {
configuredExperimentalFeatures,
debugPrerender,
isDefaultConfig,
phase,
} = options
config.experimental ??= {}
if (
debugPrerender &&
(phase === PHASE_PRODUCTION_BUILD || phase === PHASE_EXPORT)
) {
setExperimentalFeatureForDebugPrerender(
config.experimental,
'serverSourceMaps',
true,
configuredExperimentalFeatures
)
setExperimentalFeatureForDebugPrerender(
config.experimental,
process.env.TURBOPACK ? 'turbopackMinify' : 'serverMinification',
false,
configuredExperimentalFeatures
)
setExperimentalFeatureForDebugPrerender(
config.experimental,
'enablePrerenderSourceMaps',
true,
configuredExperimentalFeatures
)
setExperimentalFeatureForDebugPrerender(
config.experimental,
'prerenderEarlyExit',
false,
configuredExperimentalFeatures
)
}
// TODO: Remove this once we've made Cache Components the default.
if (
process.env.__NEXT_EXPERIMENTAL_CACHE_COMPONENTS === 'true' &&
// We do respect an explicit value in the user config.
(config.experimental.ppr === undefined ||
(isDefaultConfig && !config.experimental.ppr))
) {
config.experimental.ppr = true
if (configuredExperimentalFeatures) {
addConfiguredExperimentalFeature(
configuredExperimentalFeatures,
'ppr',
true,
'enabled by `__NEXT_EXPERIMENTAL_CACHE_COMPONENTS`'
)
}
}
// TODO: Remove this once we've made Cache Components the default.
if (
process.env.__NEXT_EXPERIMENTAL_PPR === 'true' &&
// We do respect an explicit value in the user config.
(config.experimental.ppr === undefined ||
(isDefaultConfig && !config.experimental.ppr))
) {
config.experimental.ppr = true
if (configuredExperimentalFeatures) {
addConfiguredExperimentalFeature(
configuredExperimentalFeatures,
'ppr',
true,
'enabled by `__NEXT_EXPERIMENTAL_PPR`'
)
}
}
// TODO: Remove this once we've made Client Segment Cache the default.
if (
process.env.__NEXT_EXPERIMENTAL_PPR === 'true' &&
// We do respect an explicit value in the user config.
(config.experimental.clientSegmentCache === undefined ||
(isDefaultConfig && !config.experimental.clientSegmentCache))
) {
config.experimental.clientSegmentCache = true
if (configuredExperimentalFeatures) {
addConfiguredExperimentalFeature(
configuredExperimentalFeatures,
'clientSegmentCache',
true,
'enabled by `__NEXT_EXPERIMENTAL_PPR`'
)
}
}
// TODO: Remove this once we've made Cache Components the default.
if (
process.env.__NEXT_EXPERIMENTAL_CACHE_COMPONENTS === 'true' &&
// We do respect an explicit value in the user config.
(config.experimental.cacheComponents === undefined ||
(isDefaultConfig && !config.experimental.cacheComponents))
) {
config.experimental.cacheComponents = true
if (configuredExperimentalFeatures) {
addConfiguredExperimentalFeature(
configuredExperimentalFeatures,
'cacheComponents',
true,
'enabled by `__NEXT_EXPERIMENTAL_CACHE_COMPONENTS`'
)
}
}
if (
config.experimental.enablePrerenderSourceMaps === undefined &&
config.experimental.cacheComponents === true
) {
config.experimental.enablePrerenderSourceMaps = true
if (configuredExperimentalFeatures) {
addConfiguredExperimentalFeature(
configuredExperimentalFeatures,
'enablePrerenderSourceMaps',
true,
'enabled by `experimental.cacheComponents`'
)
}
}
}
function addConfiguredExperimentalFeature<
KeyType extends keyof ExperimentalConfig,
>(
configuredExperimentalFeatures: ConfiguredExperimentalFeature[],
key: KeyType,
value: ExperimentalConfig[KeyType],
reason?: string
) {
if (value !== (defaultConfig.experimental as Record<string, unknown>)[key]) {
configuredExperimentalFeatures.push({ key, value, reason })
}
}
function setExperimentalFeatureForDebugPrerender<
KeyType extends keyof ExperimentalConfig,
>(
experimentalConfig: ExperimentalConfig,
key: KeyType,
value: ExperimentalConfig[KeyType],
configuredExperimentalFeatures: ConfiguredExperimentalFeature[] | undefined
) {
if (experimentalConfig[key] !== value) {
experimentalConfig[key] = value
if (configuredExperimentalFeatures) {
const action =
value === true ? 'enabled' : value === false ? 'disabled' : 'set'
const reason = `${action} by \`--debug-prerender\``
addConfiguredExperimentalFeature(
configuredExperimentalFeatures,
key,
value,
reason
)
}
}
}
function cloneObject(obj: any): any {
// Primitives & null
if (obj === null || typeof obj !== 'object') {
return obj
}
// RegExp → clone via constructor
if (obj instanceof RegExp) {
return new RegExp(obj.source, obj.flags)
}
// Function → just reuse the function reference
if (typeof obj === 'function') {
return obj
}
// Arrays → map each element
if (Array.isArray(obj)) {
return obj.map(cloneObject)
}
// Detect non‑plain objects (class instances)
const proto = Object.getPrototypeOf(obj)
const isPlainObject = proto === Object.prototype || proto === null
// If it's not a plain object, just return the original
if (!isPlainObject) {
return obj
}
// Plain object → create a new object with the same prototype
// and copy all properties, cloning data properties and keeping
// accessor properties (getters/setters) as‑is.
const result = Object.create(proto)
for (const key of Reflect.ownKeys(obj)) {
const descriptor = Object.getOwnPropertyDescriptor(obj, key)
if (descriptor && (descriptor.get || descriptor.set)) {
// Accessor property → copy descriptor as‑is (get/set functions)
Object.defineProperty(result, key, descriptor)
} else {
// Data property → clone the value
result[key] = cloneObject(obj[key])
}
}
return result
}
|