@netlify/plugin-nextjs 4.0.0-rc.2 → 4.0.0

package/README.md

@@ -1,9 +1,6 @@
-![Next.js on Netlify Build Plugin](next-on-netlify.png)
+![Essential Next.js Build Plugin](next-on-netlify.png)
 
-# Essential Next.js Build Plugin (beta)
-
-:warning: This is the beta version of the Essential Next.js plugin. For the stable version, refer to
-[Essential Next.js plugin v3](https://github.com/netlify/netlify-plugin-nextjs/tree/v3#readme) :warning:
+# Essential Next.js Build Plugin
 
 <p align="center">
   <a aria-label="npm version" href="https://www.npmjs.com/package/@netlify/plugin-nextjs">
@@ -19,36 +16,46 @@
 Version 4 is a complete rewrite of the Essential Next.js plugin. For full details of everything that's new, check out
 [the v4 release notes](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/release-notes/v4.md)
 
-## Installing the beta
+## Installing the plugin
 
-- Install the module:
+The plugin installs automatically for new Next.js sites on Netlify. You can also install it manually like this:
 
 ```shell
-npm install -D @netlify/plugin-nextjs@beta
+npm install -D @netlify/plugin-nextjs
 ```
 
-- Change the `publish` directory to `.next` and add the plugin to `netlify.toml` if not already installed:
+...then add the plugin to your `netlify.toml` file:
 
 ```toml
-[build]
-publish = ".next"
-
 [[plugins]]
 package = "@netlify/plugin-nextjs"
 ```
 
-If you previously set a custom `distDir` in your `next.config.js`, or set `node_bundler` or `external_node_modules` in
-your `netlify.toml` these are no longer needed and can be removed.
+## Migrating from an older version of the plugin
+
+You can manually upgrade from the previous version of the plugin by running the following command:
+
+```shell
+npm install -D @netlify/plugin-nextjs@latest
+```
+
+Change the `publish` directory to `.next`:
+
+```toml
+[build]
+publish = ".next"
+```
+
+If you previously set these values, they're no longer needed and can be removed:
+
+- `distDir` in your `next.config.js`
+- `node_bundler = "esbuild"` in `netlify.toml`
+- `external_node_modules` in `netlify.toml`
 
 The `serverless` and `experimental-serverless-trace` targets are deprecated in Next 12, and all builds with this plugin
 will now use the default `server` target. If you previously set the target in your `next.config.js`, you should remove
 it.
 
-If you are using a monorepo you will need to change `publish` to point to the full path to the built `.next` directory,
-which may be in a subdirectory. If you have changed your `distDir` then it will need to match that.
-
-If you are using Nx, then you will need to point `publish` to the folder inside `dist`, e.g. `dist/apps/myapp/.next`.
-
 If you currently use redirects or rewrites on your site, see
 [the Rewrites and Redirects guide](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/redirects-rewrites.md)
 for information on changes to how they are handled in this version.
@@ -57,7 +64,20 @@ If you want to use Next 12's beta Middleware feature, this will mostly work as e
 [read the docs on some caveats and workarounds](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/middleware.md)
 that are currently needed.
 
-## Beta feedback
+## Monorepos
+
+If you are using a monorepo you will need to change `publish` to point to the full path to the built `.next` directory,
+which may be in a subdirectory. If you have changed your `distDir` then it will need to match that.
+
+If you are using Nx, then you will need to point `publish` to the folder inside `dist`, e.g. `dist/apps/myapp/.next`.
+
+## Incremental Static Regeneration (ISR)
+
+The Essential Next.js plugin now fully supports ISR on Netlify. For more details see
+[the ISR docs](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/isr.md).
+
+## Feedback
 
-Please share any thoughts, feedback or questions about the beta
-[in our discussion](https://github.com/netlify/netlify-plugin-nextjs/discussions/706).
+If you think you have found a bug in the plugin,
+[please open an issue](https://github.com/netlify/netlify-plugin-nextjs/issues). If you have comments or feature
+requests, [see the dicussion board](https://github.com/netlify/netlify-plugin-nextjs/discussions)

package/lib/helpers/verification.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logBetaMessage = exports.checkZipSize = exports.checkForRootPublish = exports.checkNextSiteHasBuilt = exports.checkForOldFunctions = exports.verifyNetlifyBuildVersion = void 0;
+exports.checkZipSize = exports.checkForRootPublish = exports.checkNextSiteHasBuilt = exports.checkForOldFunctions = exports.verifyNetlifyBuildVersion = void 0;
 const fs_1 = require("fs");
 const path_1 = __importStar(require("path"));
 const chalk_1 = require("chalk");
@@ -61,9 +61,12 @@ const checkForOldFunctions = async ({ functions }) => {
 exports.checkForOldFunctions = checkForOldFunctions;
 const checkNextSiteHasBuilt = ({ publish, failBuild, }) => {
     if (!fs_1.existsSync(path_1.default.join(publish, 'BUILD_ID'))) {
+        const outWarning = path_1.default.basename(publish) === 'out'
+            ? `Your publish directory is set to "out", but in most cases it should be ".next".`
+            : `In most cases it should be set to ".next", unless you have chosen a custom "distDir" in your Next config.`;
         return failBuild(outdent_1.outdent `
-      The directory "${path_1.default.relative(process.cwd(), publish)}" does not contain a Next.js production build. Perhaps the build command was not run, or you specified the wrong publish directory. 
-      In most cases it should be set to the site's ".next" directory path, unless you have chosen a custom "distDir" in your Next config. 
+      The directory "${path_1.default.relative(process.cwd(), publish)}" does not contain a Next.js production build. Perhaps the build command was not run, or you specified the wrong publish directory.
+      ${outWarning}
       If you are using "next export" then the Essential Next.js plugin should be removed. See https://ntl.fyi/remove-plugin for details.
     `);
     }
@@ -116,8 +119,3 @@ const checkZipSize = async (file, maxSize = constants_1.LAMBDA_MAX_SIZE) => {
     console.log(chalk_1.greenBright `\n\nFor more information on fixing this, see ${chalk_1.blueBright `https://ntl.fyi/large-next-functions`}`);
 };
 exports.checkZipSize = checkZipSize;
-const logBetaMessage = () => console.log(chalk_1.greenBright(outdent_1.outdent `
-        Thank you for trying the Essential Next.js beta plugin. 
-        Please share feedback (both good and bad) at ${chalk_1.blueBright `https://ntl.fyi/next-beta-feedback`}
-      `));
-exports.logBetaMessage = logBetaMessage;

package/lib/index.js

@@ -11,7 +11,6 @@ const verification_1 = require("./helpers/verification");
 const plugin = {
     async onPreBuild({ constants, netlifyConfig, utils: { build: { failBuild }, cache, }, }) {
         var _a;
-        verification_1.logBetaMessage();
         const { publish } = netlifyConfig.build;
         verification_1.checkForRootPublish({ publish, failBuild });
         verification_1.verifyNetlifyBuildVersion({ failBuild, ...constants });
@@ -53,8 +52,5 @@ const plugin = {
         const { basePath } = await config_1.getNextConfig({ publish: netlifyConfig.build.publish, failBuild });
         await files_1.unpatchNextFiles(basePath);
     },
-    onEnd() {
-        verification_1.logBetaMessage();
-    },
 };
 module.exports = plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "4.0.0-rc.2",
+  "version": "4.0.0",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "lib/index.js",
   "files": [
@@ -74,7 +74,7 @@
     "@babel/core": "^7.15.8",
     "@babel/preset-env": "^7.15.8",
     "@babel/preset-typescript": "^7.16.0",
-    "@netlify/build": "^20.2.0",
+    "@netlify/build": "^20.3.0",
     "@netlify/eslint-config-node": "^4.0.0",
     "@testing-library/cypress": "^8.0.1",
     "@types/fs-extra": "^9.0.13",