Set up prettier for automatic code formatting

Make our code look beautiful and consistent :)

Author: FinnWoelm

.prettierignore

@@ -0,0 +1,42 @@
+# Test builds
+cypress/builds/
+tests/builds/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+.next

CHANGELOG.md

@@ -30,14 +30,14 @@
 ## 2.0.0 (2020-06-02)
 
 - **Breaking: You must change your `netlify.toml` configuration for next-on-netlify v2.0.0.** Please [look at the README](https://github.com/netlify/next-on-netlify#3-configure-netlify) for the latest configuration.  
-`next-on-netlify` now builds pre-rendered pages and static assets in `out_publish`. Netlify Functions for SSR pages are built to `out_functions`.
+  `next-on-netlify` now builds pre-rendered pages and static assets in `out_publish`. Netlify Functions for SSR pages are built to `out_functions`.
 - Add support for `getStaticProps` ([#7](https://github.com/netlify/next-on-netlify/issues/7))
 - Add support for `getStaticPaths` with and without fallback ([#7](https://github.com/netlify/next-on-netlify/issues/7))
 - Add support for `getServerSideProps` ([#7](https://github.com/netlify/next-on-netlify/issues/7))
 - Query string parameters are now correctly passed to Next Pages and API endpoints ([#9](https://github.com/netlify/next-on-netlify/issues/9))
 - Response headers are now correctly set ([#9](https://github.com/netlify/next-on-netlify/issues/9#issuecomment-633288179))
 - When a user encounters a 404, `next-on-netlify` now display the NextJS 404 page rather than Netlify's default 404 page. You can [customize the NextJS 404 page](https://nextjs.org/docs/advanced-features/custom-error-page#customizing-the-404-page).
- ([#2](https://github.com/netlify/next-on-netlify/issues/2))
+  ([#2](https://github.com/netlify/next-on-netlify/issues/2))
 - Every page with server-side rendering is now converted to a stand-alone Netlify Function. Previously, all SSR pages were bundled in a single Netlify Function.
 - `next-on-netlify` now prints out which pages are being converted to Netlify Functions for SSR, which pages are served as pre-rendered HTML, and the redirects that are being generated.
 - Adding custom redirects via a `_redirects` file in the project root is no longer supported. Let me know if you want this back. Or define your redirects in `netlify.toml`.

README.md

@@ -21,24 +21,25 @@ Principal Developer Experience Engineer at Netlify, will be joining
 
 next-on-netlify is a utility for hosting NextJS applications with Server-Side Rendering on Netlify. It wraps your NextJS application in a tiny compatibility layer, so that pages can be server-side rendered with Netlify functions.
 
-- Demo: https://next-on.netlify.com/  
+- Demo: https://next-on.netlify.com/
 - Example repository: https://github.com/FinnWoelm/next-on-netlify-demo
 
 ## Table of Contents
-* [Installation](#installation)
-* [Setup](#setup)
-  - [1. Set NextJS  target to serverless](#1-set-nextjs--target-to-serverless)
+
+- [Installation](#installation)
+- [Setup](#setup)
+  - [1. Set NextJS target to serverless](#1-set-nextjs--target-to-serverless)
   - [2. Add postbuild hook](#2-add-postbuild-hook)
   - [3. Configure Netlify](#3-configure-netlify)
-* [Optional Extras](#optional-extras)
+- [Optional Extras](#optional-extras)
   - [Preview Locally](#preview-locally)
   - [Custom Netlify Redirects](#custom-netlify-redirects)
   - [Custom Netlify Functions](#custom-netlify-functions)
-* [Caveats](#caveats)
-  + [Preview Mode](#preview-mode)
-  + [Fallbacks for Pages with `getStaticPaths`](#fallbacks-for-pages-with-getstaticpaths)
-* [Showcase](#showcase)
-* [Credits](#credits)
+- [Caveats](#caveats)
+  - [Preview Mode](#preview-mode)
+  - [Fallbacks for Pages with `getStaticPaths`](#fallbacks-for-pages-with-getstaticpaths)
+- [Showcase](#showcase)
+- [Credits](#credits)
 
 ## Installation
 
@@ -48,7 +49,7 @@ npm install --save next-on-netlify
 
 ## Setup
 
-#### 1. Set NextJS  target to serverless
+#### 1. Set NextJS target to serverless
 
 We must build our NextJS app as a serverless app. You can read more about serverless NextJS [here](https://nextjs.org/docs/api-reference/next.config.js/build-target#serverless-target).
 
@@ -59,13 +60,13 @@ It's super simple. Just create a `next.config.js` file and write the following:
 
 module.exports = {
   // Target must be serverless
-  target: 'serverless'
+  target: "serverless",
 };
 ```
 
 #### 2. Add postbuild hook
 
-The next-on-netlify package adds the `next-on-netlify`  command. When we run this command, some magic happens to prepare our NextJS app for hosting on Netlify*.
+The next-on-netlify package adds the `next-on-netlify` command. When we run this command, some magic happens to prepare our NextJS app for hosting on Netlify\*.
 
 We want the next-on-netlify command to run after we build our NextJS application. So let's add a postbuild hook to our package.json file:
 
@@ -140,6 +141,7 @@ Lastly, add the following lines to your `.gitignore`:
 Now you're all set.
 
 From now on, whenever you want to preview your application locally, just run:
+
 1. `npm run build`: This will run `next build` to build your NextJS app and `next-on-netlify` to prepare your NextJS app for compatibility with Netlify
 1. `netlify dev`: This will emulate Netlify on your computer and let you preview your app on `http://localhost:8888`.
 
@@ -152,7 +154,7 @@ The precedence of these rules are:
 - `next-on-netlify` redirects
 - `netlify.toml`
 
-[Read more about Netlify redirects here](https://docs.netlify.com/routing/redirects/).  
+[Read more about Netlify redirects here](https://docs.netlify.com/routing/redirects/).
 
 #### Custom Netlify Functions
 
@@ -165,7 +167,6 @@ SSR pages and API endpoints. It is currently not possible to create custom Netli
 
 [NextJS Preview Mode](https://nextjs.org/docs/advanced-features/preview-mode) does not work on pages that are pre-rendered (pages with `getStaticProps`). Netlify currently does not support cookie-based redirects, which are needed for supporting preview mode on pre-rendered pages. Preview mode works correctly on any server-side-rendered pages (pages with `getInitialProps` or `getServerSideProps`). See: [Issue #10](https://github.com/netlify/next-on-netlify/issues/10)
 
-
 ### Fallbacks for Pages with `getStaticPaths`
 
 [Fallback pages](https://nextjs.org/docs/basic-features/data-fetching#fallback-true) behave differently with `next-on-netlify` than they do with NextJS. On NextJS, when navigating to a path that is not defined in `getStaticPaths`, it first displays the fallback page. NextJS then generates the HTML in the background and caches it for future requests.
@@ -188,6 +189,7 @@ Are you building something awesome with `next-on-netlify`? 🔥 Let me know and
 📣 Shoutout to [@mottox2](https://github.com/mottox2) (a pioneer of hosting NextJS on Netlify) and [@danielcondemarin](https://github.com/danielcondemarin) (author of serverless-next.js for AWS). The two were big inspirations for this package.
 
 🙌 Big "thank you" to the following people for their contributions, support, and beta testing:
+
 - [@spencewood](https://github.com/spencewood)
 - [@alxhghs](https://github.com/alxhghs)
 - [@gamliela](https://github.com/gamliela)

cypress/fixtures/next.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-  target: 'serverless',
+  target: "serverless",
 };

cypress/fixtures/pages-with-optionalCatchAll/catch/[[...all]].js

@@ -1,50 +1,46 @@
-import { useRouter } from 'next/router'
-import Link from 'next/link'
+import { useRouter } from "next/router";
+import Link from "next/link";
 
 const CatchAll = ({ show }) => {
-  const router = useRouter()
+  const router = useRouter();
 
   // This is never shown on Netlify. We just need it for NextJS to be happy,
   // because NextJS will render a fallback HTML page.
   if (router.isFallback) {
-    return <div>Loading...</div>
+    return <div>Loading...</div>;
   }
 
   return (
     <div>
-      <p>
-        This page uses getStaticProps() to pre-fetch a TV show.
-      </p>
+      <p>This page uses getStaticProps() to pre-fetch a TV show.</p>
 
-      <hr/>
+      <hr />
 
       <h1>Show #{show.id}</h1>
-      <p>
-        {show.name}
-      </p>
+      <p>{show.name}</p>
 
-      <hr/>
+      <hr />
 
       <Link href="/">
         <a>Go back home</a>
       </Link>
     </div>
-  )
-}
+  );
+};
 
 export async function getServerSideProps({ params }) {
   // The ID to render
-  const { all } = params
-  const id = all ? all[0] : 1
+  const { all } = params;
+  const id = all ? all[0] : 1;
 
   const res = await fetch(`https://api.tvmaze.com/shows/${id}`);
   const data = await res.json();
 
   return {
     props: {
-      show: data
-    }
-  }
+      show: data,
+    },
+  };
 }
 
-export default CatchAll
+export default CatchAll;

cypress/fixtures/pages-with-optionalCatchAll/index.js

@@ -1,4 +1,4 @@
-import Link from 'next/link'
+import Link from "next/link";
 
 const Index = () => (
   <div>
@@ -20,6 +20,6 @@ const Index = () => (
       </li>
     </ul>
   </div>
-)
+);
 
-export default Index
+export default Index;

cypress/fixtures/pages/api/enterPreview.js

@@ -1,12 +1,12 @@
 export default async function preview(req, res) {
-  const { query } = req
-  const { id }    = query
+  const { query } = req;
+  const { id } = query;
 
   // Enable Preview Mode by setting the cookies
-  res.setPreviewData({})
+  res.setPreviewData({});
 
   // Redirect to the path from the fetched post
   // We don't redirect to req.query.slug as that might lead to open redirect vulnerabilities
-  res.writeHead(307, { Location: `/previewTest/${id}` })
-  res.end()
+  res.writeHead(307, { Location: `/previewTest/${id}` });
+  res.end();
 }

cypress/fixtures/pages/api/exitPreview.js

@@ -1,8 +1,8 @@
 export default async function exit(_, res) {
   // Exit the current user from "Preview Mode". This function accepts no args.
-  res.clearPreviewData()
+  res.clearPreviewData();
 
   // Redirect the user back to the index page.
-  res.writeHead(307, { Location: '/' })
-  res.end()
+  res.writeHead(307, { Location: "/" });
+  res.end();
 }

cypress/fixtures/pages/api/shows/[...params].js

@@ -1,23 +1,23 @@
 export default async (req, res) => {
   // Get the params and query string parameters
-  const { query } = req
-  const { params, ...queryStringParams } = query
+  const { query } = req;
+  const { params, ...queryStringParams } = query;
 
   // Get the ID of the show
-  const id = params[0]
+  const id = params[0];
 
   // Get the data
-  const fetchRes  = await fetch(`https://api.tvmaze.com/shows/${id}`);
-  const data      = await fetchRes.json();
+  const fetchRes = await fetch(`https://api.tvmaze.com/shows/${id}`);
+  const data = await fetchRes.json();
 
   // If show was found, return it
-  if(fetchRes.status == 200) {
-    res.status(200)
-    res.json({ params, queryStringParams, show: data })
+  if (fetchRes.status == 200) {
+    res.status(200);
+    res.json({ params, queryStringParams, show: data });
   }
   // If show was not found, return error
   else {
-    res.status(404)
-    res.json({ error: "Show not found" })
+    res.status(404);
+    res.json({ error: "Show not found" });
   }
-}
+};

cypress/fixtures/pages/api/shows/[id].js

@@ -1,20 +1,20 @@
 export default async (req, res) => {
   // Get the ID of the show
-  const { query } = req
-  const { id }    = query
+  const { query } = req;
+  const { id } = query;
 
   // Get the data
-  const fetchRes  = await fetch(`https://api.tvmaze.com/shows/${id}`);
-  const data      = await fetchRes.json();
+  const fetchRes = await fetch(`https://api.tvmaze.com/shows/${id}`);
+  const data = await fetchRes.json();
 
   // If show was found, return it
-  if(fetchRes.status == 200) {
-    res.status(200)
-    res.json({ show: data })
+  if (fetchRes.status == 200) {
+    res.status(200);
+    res.json({ show: data });
   }
   // If show was not found, return error
   else {
-    res.status(404)
-    res.json({ error: "Show not found" })
+    res.status(404);
+    res.json({ error: "Show not found" });
   }
-}
+};