chore: removing mentions of plugin (#1537)

sarahetter · ericapisani · web-flow · commit aacefc4a22b4 · 2022-08-17T14:34:32.000Z
* chore: bug report template

* chore: gh actions

* chore: misc

* chore: misc

* chore: src messages/comments

* chore: test

* chore: readme

* chore: Update demos/next-export/README.md

Co-authored-by: Erica Pisani &lt;pisani.erica@gmail.com&gt;

* chore: Update docs/middleware.md

Co-authored-by: Erica Pisani &lt;pisani.erica@gmail.com&gt;

* chore: Update docs/middleware.md

Co-authored-by: Erica Pisani &lt;pisani.erica@gmail.com&gt;

* chore: Update docs/redirects-rewrites.md

Co-authored-by: Erica Pisani &lt;pisani.erica@gmail.com&gt;

* chore: remove install info in readme

* chore: changes from Kyles review

* chore: rename variable after merge

Co-authored-by: Erica Pisani &lt;pisani.erica@gmail.com&gt;
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -39,12 +39,12 @@ body:
   - type: markdown
     attributes:
       value: |
-        Check out [CONTRIBUTING.md](https://github.com/netlify/netlify-plugin-nextjs/blob/main/CONTRIBUTING.md#what-is-a-reproducible-test-case) for advice on producing a reproduction repo.
+        Check out [CONTRIBUTING.md](https://github.com/netlify/next-runtime/blob/main/CONTRIBUTING.md#what-is-a-reproducible-test-case) for advice on producing a reproduction repo.
   - type: input
-    id: plugin-version
+    id: runtime-version
     attributes:
-      label: Plugin version
-      description: The version of `@netlify/plugin-nextjs` that you are using. (This is in the build logs)
+      label: Next Runtime version
+      description: The version of `@netlify/next-runtime` that you are using. (This is in the build logs)
       placeholder: x.x.x
     validations:
       required: true
@@ -74,7 +74,7 @@ body:
       value: |
         <details>
           <summary>`netlify.toml`</summary>
-          
+
         ```toml
         # Paste content of your `netlify.toml` file here
         ```
@@ -89,7 +89,7 @@ body:
       value: |
         <details>
           <summary>`_redirects`</summary>
-          
+
         ```toml
         # Paste content of your `_redirects` file here
         ```
@@ -104,7 +104,7 @@ body:
       value: |
         <details>
           <summary>`next.config.js`</summary>
-          
+
         ```toml
         # Paste content of your `next.config.js` file here. Check there is no private info in there.
         ```
@@ -118,7 +118,7 @@ body:
       value: |
         <details>
           <summary>Build logs</summary>
-          
+
         ```
         # Paste logs here
         ```
@@ -133,7 +133,7 @@ body:
       value: |
         <details>
           <summary>Function logs</summary>
-          
+
         ```
         # Paste logs here
         ```
@@ -150,7 +150,7 @@ body:
       value: |
         <details>
           <summary>generated .next JSON files</summary>
-          
+
         ```
         # Paste file contents here. Please check there isn't any private info in them
         # You can either build locally, or download the deploy from Netlify by clicking the arrow next to the deploy time.
diff --git a/.github/workflows/cypress-canary.yml b/.github/workflows/cypress-canary.yml
@@ -63,7 +63,7 @@ jobs:
           record: true
           parallel: true
           config-file: cypress/config/canary.json
-          group: 'Next Plugin - Demo Canary'
+          group: 'Next Runtime - Demo Canary'
           spec: cypress/integration/canary/*
         env:
           DEBUG: '@cypress/github-action'
diff --git a/.github/workflows/cypress-demo-nx.yml b/.github/workflows/cypress-demo-nx.yml
@@ -63,7 +63,7 @@ jobs:
           record: true
           parallel: true
           config-file: cypress/config/nx-demo.json
-          group: 'Next Plugin - Demo NX'
+          group: 'Next Runtime - Demo NX'
           spec: cypress/integration/nx/*
         env:
           DEBUG: '@cypress/github-action'
diff --git a/.github/workflows/cypress-demo-static.yml b/.github/workflows/cypress-demo-static.yml
@@ -63,7 +63,7 @@ jobs:
           record: true
           parallel: true
           config-file: cypress/config/static-root.json
-          group: 'Next Plugin - Demo Static'
+          group: 'Next Runtime - Demo Static'
           spec: cypress/integration/static-root/*
         env:
           DEBUG: '@cypress/github-action'
diff --git a/.github/workflows/cypress-demo.yml b/.github/workflows/cypress-demo.yml
@@ -63,7 +63,7 @@ jobs:
           record: true
           parallel: true
           config-file: cypress/config/ci.json
-          group: 'Next Plugin - Demo'
+          group: 'Next Runtime - Demo'
           spec: cypress/integration/default/*
         env:
           DEBUG: '@cypress/github-action'
diff --git a/.github/workflows/cypress-middleware.yml b/.github/workflows/cypress-middleware.yml
@@ -63,7 +63,7 @@ jobs:
           record: true
           parallel: true
           config-file: cypress/config/middleware.json
-          group: 'Next Plugin - Middleware'
+          group: 'Next Runtime - Middleware'
           spec: cypress/integration/middleware/*
         env:
           DEBUG: '@cypress/github-action'
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,4 +1,4 @@
-name: Plugin Tests
+name: Next Runtime Tests
 
 on:
   pull_request:
diff --git a/.vscode/feat-test.code-snippets b/.vscode/feat-test.code-snippets
@@ -1,9 +1,9 @@
 {
-	// Place your netlify-plugin-nextjs workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and 
-	// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope 
-	// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is 
-	// used to trigger the snippet and the body will be expanded and inserted. Possible variables are: 
-	// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. 
+	// Place your next-runtime workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
+	// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
+	// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
+	// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
+	// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
 	// Placeholders with the same ids are connected.
 	// Example:
 	"Create Next Test Feature": {
@@ -27,4 +27,4 @@
 		],
 		"description": "Log output to console"
 	}
-}
+}
diff --git a/README.md b/README.md
@@ -1,41 +1,26 @@
-![Essential Next.js Build Plugin](next-on-netlify.png)
+![Next.js Runtime](next-on-netlify.png)
 
-# Essential Next.js Build Plugin
+# Next.js Runtime
 
 <p align="center">
-  <a aria-label="npm version" href="https://www.npmjs.com/package/@netlify/plugin-nextjs">
-    <img alt="" src="https://img.shields.io/npm/v/@netlify/plugin-nextjs">
+  <a aria-label="npm version" href="https://www.npmjs.com/package/@netlify/next-runtime">
+    <img alt="" src="https://img.shields.io/npm/v/@netlify/next-runtime">
   </a>
-  <a aria-label="MIT License" href="https://img.shields.io/npm/l/@netlify/plugin-nextjs">
-    <img alt="" src="https://img.shields.io/npm/l/@netlify/plugin-nextjs">
+  <a aria-label="MIT License" href="https://img.shields.io/npm/l/@netlify/next-runtime">
+    <img alt="" src="https://img.shields.io/npm/l/@netlify/next-runtime">
   </a>
 </p>
 
 ## What's new in this version
 
 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 plugin
-
-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
-```
-
-...then add the plugin to your `netlify.toml` file:
-
-```toml
-[[plugins]]
-package = "@netlify/plugin-nextjs"
-```
+[the v4 release notes](https://github.com/netlify/next-runtime/blob/main/docs/release-notes/v4.md)
 
 ## Deploying
 
-If you build on Netlify, this plugin will work with no additional configuration. However if you are building and
+If you build on Netlify, the Next.js Runtime will work with no additional configuration. However if you are building and
 deploying locally using the Netlify CLI, you must deploy using `netlify deploy --build`. Running the build and deploy
-commands separately will not work, because the plugin will not generate the required configuration.
+commands separately will not work, because the Next.js Runtime will not generate the required configuration.
 
 ## Using `next/image`
 
@@ -55,12 +40,14 @@ may also manually disable the Edge Function by setting the environment variable
 
 ## Returning custom response headers on images handled by `ipx`
 
-Should you wish to return custom response headers on images handled by the [`netlify-ipx`](https://github.com/netlify/netlify-ipx) package, you can add them within your project's `netlify.toml` by targeting the `/_next/image/*` route:
+Should you wish to return custom response headers on images handled by the
+[`netlify-ipx`](https://github.com/netlify/netlify-ipx) package, you can add them within your project's `netlify.toml`
+by targeting the `/_next/image/*` route:
 
 ```
 [[headers]]
   for = "/_next/image/*"
-  
+
   [headers.values]
     Strict-Transport-Security = "max-age=31536000"
     X-Test = 'foobar'
@@ -69,9 +56,9 @@ Should you wish to return custom response headers on images handled by the [`net
 ## Next.js Middleware on Netlify
 
 Next.js Middleware works out of the box on Netlify, but check out the
-[docs on some caveats](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/middleware.md). By default,
-middleware runs using SSR. For better results, you should enable [Netlify Edge Functions](#netlify-edge-functions),
-which ensures middleware runs at the edge. To use Netlify Edge Functions for middleware or to enable
+[docs on some caveats](https://github.com/netlify/next-runtime/blob/main/docs/middleware.md). By default, middleware
+runs using SSR. For better results, you should enable [Netlify Edge Functions](#netlify-edge-functions), which ensures
+middleware runs at the edge. To use Netlify Edge Functions for middleware or to enable
 [edge server rendering](https://nextjs.org/blog/next-12-2#edge-server-rendering-experimental), set the environment
 variable `NEXT_USE_NETLIFY_EDGE` to `true`.
 
@@ -93,16 +80,16 @@ If you are using Nx, then you will need to point `publish` to the folder inside
 
 ## 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).
+The Next.js Runtime fully supports ISR on Netlify. For more details see
+[the ISR docs](https://github.com/netlify/next-runtime/blob/main/docs/isr.md).
 
 ## Use with `next export`
 
-If you are using `next export` to generate a static site, you do not need most of the functionality of this plugin and
-you can remove it. Alternatively you can
+If you are using `next export` to generate a static site, you do not need most of the functionality of this Next.js
+Runtime and you can remove it. Alternatively you can
 [set the environment variable](https://docs.netlify.com/configure-builds/environment-variables/)
-`NETLIFY_NEXT_PLUGIN_SKIP` to `true` and the plugin will handle caching but won't generate any functions for SSR
-support. See [`demos/next-export`](https://github.com/netlify/netlify-plugin-nextjs/tree/main/demos/next-export) for an
+`NETLIFY_NEXT_PLUGIN_SKIP` to `true` and the Next.js Runtime will handle caching but won't generate any functions for
+SSR support. See [`demos/next-export`](https://github.com/netlify/next-runtime/tree/main/demos/next-export) for an
 example.
 
 ## Asset optimization
@@ -113,47 +100,49 @@ that it is not enabled at **Site settings > Build & deploy > Post processing > A
 
 ## Generated functions
 
-This plugin works by generating three Netlify functions that handle requests that haven't been pre-rendered. These are
-`___netlify-handler` (for SSR and API routes), `___netlify-odb-handler` (for ISR and fallback routes), and `_ipx` (for
-images). You can see the requests for these in [the function logs](https://docs.netlify.com/functions/logs/). For ISR
-and fallback routes you will not see any requests that are served from the edge cache, just actual rendering requests.
-These are all internal functions, so you won't find them in your site's own functions directory.
+The Next.js Runtime works by generating three Netlify functions that handle requests that haven't been pre-rendered.
+These are `___netlify-handler` (for SSR and API routes), `___netlify-odb-handler` (for ISR and fallback routes), and
+`_ipx` (for images). You can see the requests for these in
+[the function logs](https://docs.netlify.com/functions/logs/). For ISR and fallback routes you will not see any requests
+that are served from the edge cache, just actual rendering requests. These are all internal functions, so you won't find
+them in your site's own functions directory.
 
-The plugin will also generate a Netlify Edge Function called 'ipx' to handle image content negotiation, and if Edge
-runtime or middleware is enabled it will also generate edge functions for middleware and edge routes.
+The Next.js Runtime will also generate a Netlify Edge Function called 'ipx' to handle image content negotiation, and if
+Edge runtime or middleware is enabled it will also generate edge functions for middleware and edge routes.
 
-## Migrating from an older version of the plugin
+## Manually installing the Next.js Runtime
 
-You can manually upgrade from the previous version of the plugin by running the following command:
+The Next.js Runtime installs automatically for new Next.js sites on Netlify. You can also install it manually like this:
 
 ```shell
-npm install -D @netlify/plugin-nextjs@latest
+npm install -D @netlify/next-runtime
 ```
 
-Change the `publish` directory to `.next`:
+...then add the following to your `netlify.toml` file:
 
 ```toml
-[build]
-publish = ".next"
+[[plugins]]
+package = "@netlify/next-runtime"
 ```
 
+## Manually upgrading from an older version of the Next.js Runtime
+
 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.
+The `serverless` and `experimental-serverless-trace` targets are deprecated in Next 12, and all builds with this Next
+Runtime will now use the default `server` target. If you previously set the target in your `next.config.js`, you should
+remove it.
 
 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. In particular, note that `_redirects` and `_headers`
+[the Rewrites and Redirects guide](https://github.com/netlify/next-runtime/blob/main/docs/redirects-rewrites.md) for
+information on changes to how they are handled in this version. In particular, note that `_redirects` and `_headers`
 files must be placed in `public`, not in the root of the site.
 
 ## Feedback
 
-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)
+If you think you have found a bug in this repo, [please open an issue](https://github.com/netlify/next-runtime/issues).
+If you have comments or feature requests, [see the dicussion board](https://github.com/netlify/next-runtime/discussions)
diff --git a/demos/canary/pages/index.js b/demos/canary/pages/index.js
@@ -12,12 +12,12 @@ export default function Home() {
       <main>
         <h1>Canary Next App</h1>
         <div>
-          <p>Here's where we test out Next's canary features to ensure they work with our plugin .</p>
+          <p>Here's where we test out Next's canary features to ensure they work with our Next Runtime .</p>
         </div>
       </main>
 
       <Image
-        src="https://raw.githubusercontent.com/netlify/netlify-plugin-nextjs/main/next-on-netlify.png"
+        src="https://raw.githubusercontent.com/netlify/next-runtime/main/next-on-netlify.png"
         alt="Picture of the author"
         width={540}
         height={191}
diff --git a/demos/default/pages/broken-image.tsx b/demos/default/pages/broken-image.tsx
@@ -3,7 +3,7 @@ import Image from 'next/image'
 // This should cause an error, because broken-domain is not part of the configured next.config.js image domains
 const Images = () => (
   <Image
-    src="https://broken-domain/netlify/netlify-plugin-nextjs/main/next-on-netlify.png"
+    src="https://broken-domain/netlify/next-runtime/main/next-on-netlify.png"
     alt="Picture of the author"
     width={500}
     height={500}
diff --git a/demos/default/pages/image.js b/demos/default/pages/image.js
@@ -15,7 +15,7 @@ const Images = () => (
     <p>
       <Image src={logo} alt="netlify logomark" />
       <Image
-        src="https://raw.githubusercontent.com/netlify/netlify-plugin-nextjs/main/next-on-netlify.png"
+        src="https://raw.githubusercontent.com/netlify/next-runtime/main/next-on-netlify.png"
         alt="Picture of the author"
         width={500}
         height={500}
diff --git a/demos/next-export/README.md b/demos/next-export/README.md
@@ -1,2 +1,2 @@
-This is an example of a site that uses `next export`. It only uses the plugin for cache handling and sets
+This is an example of a site that uses `next export`. It only uses the Next Runtime for cache handling and sets
 `NETLIFY_NEXT_PLUGIN_SKIP` to disable everything else.
diff --git a/demos/nx-next-monorepo-demo/README.md b/demos/nx-next-monorepo-demo/README.md
@@ -1,6 +1,6 @@
 # NxNextjsMonorepo
 
-This project was generated using [Nx](https://nx.dev). It is a demo site to test that Nx monorepos work properly with the Netlify Essential NextJS plugin.
+This project was generated using [Nx](https://nx.dev). It is a demo site to test that Nx monorepos work properly with the Netlify Next Runtime.
 
 <p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="450"></p>
 
diff --git a/docs/isr.md b/docs/isr.md
@@ -2,9 +2,9 @@
 
 [Incremental static regeneration](https://vercel.com/docs/concepts/next.js/incremental-static-regeneration) is a feature
 of Next.js that allows pages to be updated after a site has been built and deployed. It is now fully supported in
-Netlify by the Essential Next.js plugin, meaning large sites can update pages without needing to rebuild the entire
-site. Unlike server-side rendered pages, the page is not rebuilt for each user, so they load quickly, but unlike
-statically-generated pages they can be periodically updated with new content without a new deploy.
+Netlify by the Next Runtime, meaning large sites can update pages without needing to rebuild the entire site. Unlike
+server-side rendered pages, the page is not rebuilt for each user, so they load quickly, but unlike statically-generated
+pages they can be periodically updated with new content without a new deploy.
 
 ### Using ISR on Netlify
 
@@ -56,8 +56,8 @@ invalidating all persisted pages, you can be confident that this will never happ
 ### On-demand ISR
 
 On-Demand ISR (where a path is manually revalidated) is not currently supported on Netlify.
-[Please let us know](https://github.com/netlify/netlify-plugin-nextjs/discussions/1228) if this feature would be useful
-to you, and if so how you would plan to use it.
+[Please let us know](https://github.com/netlify/next-runtime/discussions/1228) if this feature would be useful to you,
+and if so how you would plan to use it.
 
 ### Alternatives to ISR
 
diff --git a/docs/middleware.md b/docs/middleware.md
diff --git a/docs/redirects-rewrites.md b/docs/redirects-rewrites.md
diff --git a/docs/release-notes/v4.md b/docs/release-notes/v4.md
diff --git a/packages/runtime/src/helpers/cache.ts b/packages/runtime/src/helpers/cache.ts
diff --git a/packages/runtime/src/helpers/verification.ts b/packages/runtime/src/helpers/verification.ts
diff --git a/packages/runtime/src/index.ts b/packages/runtime/src/index.ts
diff --git a/test/index.js b/test/index.js

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Plugin Tests`
	`1`	`+name: Next Runtime Tests`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`pull_request:`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		-This is an example of a site that uses `next export`. It only uses the plugin for cache handling and sets
	`1`	+This is an example of a site that uses `next export`. It only uses the Next Runtime for cache handling and sets
`2`	`2`	`NETLIFY_NEXT_PLUGIN_SKIP` to disable everything else.