Skip to content

Commit 8045887

Browse files
authored
fix(templates): add --no-server-fast-refresh to all dev scripts for Next.js 16.2+ compatibility (#16074)
[Next.js 16.2 enables server fast refresh by default](vercel/next.js#91476), which breaks Payload's HMR - config changes don't propagate until a full server restart. Adding `--no-server-fast-refresh` to the dev command fixes it. This is a temporary workaround until the upstream issue is resolved. --- - To see the specific tasks where the Asana app for GitHub is being used, see below: - https://app.asana.com/0/0/1213814287069601
1 parent 1ecd7dd commit 8045887

13 files changed

Lines changed: 23 additions & 12 deletions

File tree

docs/database/migrations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ A common set of scripts in a `package.json`, set up to run migrations in CI, mig
245245
```js
246246
"scripts": {
247247
// For running in dev mode
248-
"dev": "next dev --turbo",
248+
"dev": "next dev --turbo --no-server-fast-refresh",
249249

250250
// To build your Next + Payload app for production
251251
"build": "next build",

docs/getting-started/installation.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ Payload requires the following software:
2525
sure you're using one of the supported version ranges listed above.
2626
</Banner>
2727

28+
<Banner type="warning">
29+
**Next.js 16.2+:** Server fast refresh (enabled by default) breaks Payload HMR - config changes won't propagate until a full server restart. Add `--no-server-fast-refresh` to your dev command as a workaround:
30+
31+
```bash
32+
next dev --no-server-fast-refresh
33+
```
34+
35+
This is a temporary workaround until the upstream issue is resolved.
36+
37+
</Banner>
38+
2839
<Banner type="info">
2940
**Cache Components:** While Next.js `cacheComponents` can be enabled alongside
3041
Payload without causing errors in the admin panel, full compatibility is not

docs/performance/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ In Next.js 15, add `--turbo` to your dev script to significantly speed up your l
213213
```json
214214
{
215215
"scripts": {
216-
"dev": "next dev --turbo"
216+
"dev": "next dev --turbo --no-server-fast-refresh"
217217
}
218218
}
219219
```

templates/_template/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"type": "module",
77
"scripts": {
88
"build": "cross-env NODE_OPTIONS=--no-deprecation next build",
9-
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev",
9+
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev --no-server-fast-refresh",
1010
"devsafe": "rm -rf .next && cross-env NODE_OPTIONS=--no-deprecation next dev",
1111
"generate:importmap": "cross-env NODE_OPTIONS=--no-deprecation payload generate:importmap",
1212
"generate:types": "cross-env NODE_OPTIONS=--no-deprecation payload generate:types",

templates/blank/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"type": "module",
77
"scripts": {
88
"build": "cross-env NODE_OPTIONS=\"--no-deprecation --max-old-space-size=8000\" next build",
9-
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev",
9+
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev --no-server-fast-refresh",
1010
"devsafe": "rm -rf .next && cross-env NODE_OPTIONS=--no-deprecation next dev",
1111
"generate:importmap": "cross-env NODE_OPTIONS=--no-deprecation payload generate:importmap",
1212
"generate:types": "cross-env NODE_OPTIONS=--no-deprecation payload generate:types",

templates/ecommerce/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"type": "module",
77
"scripts": {
88
"build": "cross-env NODE_OPTIONS=\"--no-deprecation --max-old-space-size=8000\" next build",
9-
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev",
9+
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev --no-server-fast-refresh",
1010
"dev:prod": "cross-env NODE_OPTIONS=--no-deprecation rm -rf .next && pnpm build && pnpm start",
1111
"generate:importmap": "cross-env NODE_OPTIONS=--no-deprecation payload generate:importmap",
1212
"generate:types": "cross-env NODE_OPTIONS=--no-deprecation payload generate:types",

templates/plugin/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"build:types": "tsc --outDir dist --rootDir ./src",
3333
"clean": "rimraf {dist,*.tsbuildinfo}",
3434
"copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
35-
"dev": "next dev dev --turbo",
35+
"dev": "next dev dev --turbo --no-server-fast-refresh",
3636
"dev:generate-importmap": "pnpm dev:payload generate:importmap",
3737
"dev:generate-types": "pnpm dev:payload generate:types",
3838
"dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",

templates/website/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"scripts": {
88
"build": "cross-env NODE_OPTIONS=--no-deprecation next build",
99
"postbuild": "next-sitemap --config next-sitemap.config.cjs",
10-
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev",
10+
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev --no-server-fast-refresh",
1111
"dev:prod": "cross-env NODE_OPTIONS=--no-deprecation rm -rf .next && pnpm build && pnpm start",
1212
"generate:importmap": "cross-env NODE_OPTIONS=--no-deprecation payload generate:importmap",
1313
"generate:types": "cross-env NODE_OPTIONS=--no-deprecation payload generate:types",

templates/with-cloudflare-d1/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"deploy": "pnpm run deploy:database && pnpm run deploy:app",
1010
"deploy:app": "opennextjs-cloudflare build --env=$CLOUDFLARE_ENV && opennextjs-cloudflare deploy --env=$CLOUDFLARE_ENV",
1111
"deploy:database": "cross-env NODE_ENV=production PAYLOAD_SECRET=ignore payload migrate && wrangler d1 execute D1 --command 'PRAGMA optimize' --env=$CLOUDFLARE_ENV --remote",
12-
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev",
12+
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev --no-server-fast-refresh",
1313
"devsafe": "rm -rf .next && rm -rf .open-next && cross-env NODE_OPTIONS=--no-deprecation next dev",
1414
"generate:importmap": "cross-env NODE_OPTIONS=--no-deprecation payload generate:importmap",
1515
"generate:types": "pnpm run generate:types:cloudflare && pnpm run generate:types:payload",

templates/with-postgres/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"type": "module",
77
"scripts": {
88
"build": "cross-env NODE_OPTIONS=--no-deprecation next build",
9-
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev",
9+
"dev": "cross-env NODE_OPTIONS=--no-deprecation next dev --no-server-fast-refresh",
1010
"devsafe": "rm -rf .next && cross-env NODE_OPTIONS=--no-deprecation next dev",
1111
"generate:importmap": "cross-env NODE_OPTIONS=--no-deprecation payload generate:importmap",
1212
"generate:types": "cross-env NODE_OPTIONS=--no-deprecation payload generate:types",

0 commit comments

Comments
 (0)