feat: merge next-on-netlify into the core plugin repo (#106)

* foundation: embed NoN into plugin under src/

* wip: updates to test paths, but things still aren’t working

* fix: use next@^10.0.6 for i18n

* [email protected] release

* wip: start changelog entry for review

* chore: update version + installation instructions

* fix: edit for clarity

Co-authored-by: rstavchansky <[email protected]>

* fix: add link + edit for clarity

Co-authored-by: rstavchansky <[email protected]>

* fix: add UI-based install back in

* fix: add NoN migration guide link

* fix: include src in published package

* [email protected] release

* fix: package description

* fix: next 10.0.8 changes loadConfig to be async (#105)

* fix: 10.0.8 changes loadConfig to be async

* wip: make literally everything async bc loadConfig

* wip: fix i18n bug, got 10.0.6 tests to pass

* wip: NoN tests pass on 10.0.8 but plugin test chdir fixture issue

* Fix bug with Jest

* fix: delete TO-DO

Co-authored-by: ehmicky <[email protected]>

Co-authored-by: Lindsay Levine <[email protected]>
Co-authored-by: rstavchansky <[email protected]>
Co-authored-by: lindsaylevine <[email protected]>
Co-authored-by: ehmicky <[email protected]>

Author: 4 people

.prettierignore

@@ -21,3 +21,5 @@ __mocks__
 test/fixtures
 test/sample
 next.config.js
+src/cypress/builds/
+src/tests/builds/

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 3.0.0 (2021-03-??)
+
+- feat: merge `next-on-netlify` into `@netlify/plugin-nextjs`
+  
+  This improves our ability to maintain the plugin, reduces confusion about how to configure Next.js support for Netlify builds, and prepares the plugin for something we're pretty dang excited about: automatic installation for new Next.js projects!
+
+> **NOTE: There are no breaking changes for existing plugin users.** This is a major release because we're bringing an external package into the plugin _and_ turning on automatic installation for new Next.js projects on Netlify. This doesn't break anything, but it's a big enough change that we wanted to treat it as a major release.
+
+### Migrating from v2 to v3
+
+If you've installed this plugin via Netlify's UI, no action is necessary. The upgrade is automatic.
+
+If you've installed this plugin manually in your `netlify.toml`, you can upgrade two ways:
+
+1. Manually update to the latest version using `npm i @netlify/plugin-nextjs@latest`.
+2. If you prefer to automatically get updates, remove this plugin from your project and `netlify.toml`, then [install the plugin using the Netlify UI](http://app.netlify.com/plugins/@netlify/plugin-nextjs/install).
+
+### Migrating from the original `next-on-netlify` package
+
+As part of the 3.0.0 release, `next-on-netlify` has been deprecated and merged into the Essential Next.js Build Plugin. If your site is using the `next-on-netlify` package, you'll need to switch over to the plugin to get future updates.
+
+For instructions on migrating from `next-on-netlify` to the Essential Next.js Build Plugin, please see the [migration guide on the `next-on-netlify` repo](https://github.com/netlify/next-on-netlify/blob/main/MIGRATING.md).
+
 ## 2.0.1 (2021-02-17)
 
 - fail build if plugin cant load next.config.js ([#99](https://github.com/netlify/netlify-plugin-nextjs/pull/99))

README.md

@@ -1,6 +1,6 @@
 ![Next.js on Netlify Build Plugin](next-on-netlify.png)
 
-# Next.js Build Plugin
+# Essential Next.js Build Plugin
 
 <p align="center">
   <a aria-label="npm version" href="https://www.npmjs.com/package/@netlify/plugin-nextjs">
@@ -26,46 +26,50 @@ This build plugin is a utility for supporting Next.js on Netlify. To enable serv
 
 ## Installation and Configuration
 
-There are two ways to install the plugin in your Next.js on Netlify site: with the Netlify UI or with file-based installation.
+### For new Next.js sites
 
-**UI-based Installation**
+As of v3.0.0, all new sites deployed to Netlify with Next.js will automatically install this plugin for a seamless experience deploying Next.js on Netlify!
 
-You can install this plugin using this [direct in-app installation link](http://app.netlify.com/plugins/@netlify/plugin-nextjs/install) or from your team's [Plugins directory](https://app.netlify.com/plugins) in the Netlify UI.
+This means that you don't have to do anything — just build and deploy your site to Netlify as usual and we'll handle the rest.
 
-Read more about [UI-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#ui-installation) in our docs.
+You're able to [remove the plugin](https://docs.netlify.com/configure-builds/build-plugins/#remove-a-plugin) at any time by visiting the **Plugins** tab for your site in the Netlify UI.
 
-**File-based Installation**
+### UI-based installation for existing Next.js sites
 
-1. Create a `netlify.toml` in the root of your project. Your file should include the plugins section below:
+If your Next.js project is already deployed to Netlify, use the Netlify UI to [install the Essential Next.js Build Plugin](http://app.netlify.com/plugins/@netlify/plugin-nextjs/install) in a few clicks.
 
-    ```toml
-    [build]
-      command = "npm run build"
-      publish = "out"
+### Manual installation
 
-    [[plugins]]
-      package = "@netlify/plugin-nextjs"
-    ```
+1\. Create a `netlify.toml` in the root of your project. Your file should include the plugins section below:
+
+```toml
+[build]
+  command = "npm run build"
+  publish = "out"
+
+[[plugins]]
+  package = "@netlify/plugin-nextjs"
+```
 
  You can also add context-specific properties and environment variables to your `netlify.toml`. Read more about [deploy contexts](https://docs.netlify.com/configure-builds/file-based-configuration/#deploy-contexts) in our docs. For example:
 
-    ```toml
-    [context.production.environment]
-    NEXT_SERVERLESS = "true"
-    NODE_ENV = "production"
-    ```
+```toml
+[context.production.environment]
+NEXT_SERVERLESS = "true"
+NODE_ENV = "production"
+```
 
-2. From your project's base directory, use `npm`, `yarn`, or any other Node.js package manager to add this plugin to `devDependencies` in `package.json`.
+2\. From your project's base directory, use `npm`, `yarn`, or any other Node.js package manager to add this plugin to `devDependencies` in `package.json`.
 
-    ```
-    npm install -D @netlify/plugin-nextjs
-    ```
+```
+npm install -D @netlify/plugin-nextjs
+```
 
-    or
+or
 
-    ```
-    yarn add -D @netlify/plugin-nextjs
-    ```
+```
+yarn add -D @netlify/plugin-nextjs
+```
 
 Read more about [file-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#file-based-installation) in our docs.
 

helpers/doesNotNeedPlugin.js

@@ -13,7 +13,7 @@ const doesNotNeedPlugin = async ({ netlifyConfig, packageJson, utils }) => {
   return (
     isStaticExportProject({ build, scripts }) ||
     doesSiteUseNextOnNetlify({ packageJson }) ||
-    !hasCorrectNextConfig({ nextConfigPath, failBuild: utils.build.failBuild })
+    !(await hasCorrectNextConfig({ nextConfigPath, failBuild: utils.build.failBuild }))
   )
 }
 

helpers/hasCorrectNextConfig.js

@@ -1,7 +1,7 @@
 const path = require('path')
 
 // Checks if site has the correct next.cofig.js
-const hasCorrectNextConfig = ({ nextConfigPath, failBuild }) => {
+const hasCorrectNextConfig = async ({ nextConfigPath, failBuild }) => {
   // In the plugin's case, no config is valid because we'll make it ourselves
   if (nextConfigPath === undefined) return true
 
@@ -14,7 +14,7 @@ const hasCorrectNextConfig = ({ nextConfigPath, failBuild }) => {
   const acceptableTargets = ['serverless', 'experimental-serverless-trace']
   let nextConfig
   try {
-    nextConfig = loadConfig(PHASE_PRODUCTION_BUILD, path.resolve('.'))
+    nextConfig = await loadConfig(PHASE_PRODUCTION_BUILD, path.resolve('.'))
   } catch (error) {
     return failBuild('Error loading your next.config.js.', { error })
   }

index.js

@@ -3,6 +3,7 @@ const path = require('path')
 const util = require('util')
 const makeDir = require('make-dir')
 const findUp = require('find-up')
+const nextOnNetlify = require('./src/index.js')
 
 const validateNextUsage = require('./helpers/validateNextUsage')
 const doesNotNeedPlugin = require('./helpers/doesNotNeedPlugin')
@@ -53,11 +54,7 @@ module.exports = {
 
     await makeDir(PUBLISH_DIR)
 
-    // We cannot load `next-on-netlify` (which depends on `next`) at the
-    // top-level because we validate whether the site is using `next`
-    // inside `onPreBuild`.
-    const nextOnNetlify = require('next-on-netlify')
-    nextOnNetlify({ functionsDir: FUNCTIONS_SRC, publishDir: PUBLISH_DIR })
+    await nextOnNetlify({ functionsDir: FUNCTIONS_SRC, publishDir: PUBLISH_DIR })
   },
 }