README

@gasket/plugin-nextjs

This plugin adds Next.js to your application.

Installation

New apps

Recommended

gasket create <app-name> --plugins @gasket/plugin-nextjs

Existing apps

npm i @gasket/plugin-nextjs next react react-dom

Modify plugins section of your gasket.config.js:

// gasket.config.js
module.exports = {
  plugins: {
    add: [
+      '@gasket/plugin-nextjs'
    ]
  }
}

Configuration

Instead of adding a dedicated next.config.js, the nextConfig property within gasket.config.js is used. Everything you can configure in the next.config can be added here.

It is also possible for apps to config Next.js using the gasket.config.js file. To do so, specify a nextConfig object property in the same form as what you would set for custom configurations or using Next.js plugins.

For general Webpack configurations, it is recommend to utilize features of the Gasket webpack plugin.

Example configuration

module.exports = {
  plugins: {
    add: ['@gasket/nextjs']
  },
  nextConfig: {
    poweredByHeader: false,
    useFileSystemPublicRoutes: false
  }
}

Example with plugins

const withSass = require('@zeit/next-sass');
const withCss = require('@zeit/next-css');

module.exports = {
  plugins: {
    add: ['nextjs']
  },
  nextConfig: withCss(withSass({
    /* config options here */
  }))
}

Internationalized Routing

When using this plugin along with @gasket/plugin-intl to determine and provide locale files, be sure to set the i18n config for defaultLocale and supported locales in the intl plugin config, instead of the nextConfig. This will be used by the Gasket Intl plugin, and also passed along with the Next config for i18n routing.

// gasket.config.js
module.exports = {
  intl: {
+    defaultLocale: 'en-US',
+    locales: ['en-US', 'fr', 'nl-NL']
  },
  nextConfig: {
    i18n: {
-    locales: ['en-US', 'fr', 'nl-NL'],
-    defaultLocale: 'en-US',
    domains: [
      {
        domain: 'example.com',
        defaultLocale: 'en-US',
      },
      {
        domain: 'example.nl',
        defaultLocale: 'nl-NL',
      },
      {
        domain: 'example.fr',
        defaultLocale: 'fr',
      },
    ],
    }
  }
}

Also note when using @gasket/plugin-intl to determine the locale, that the NEXT_LOCALE cookie will have no effect. You can, of course, hook the intlLocale lifecycle in an app to enable that behavior if desired.

Lifecycles

Executed when the next server has been created. It will receive a reference to the created next instance.

module.exports = {
  hooks: {
    /**
    * Modify the Next app instance
    * @param  {Gasket} gasket The Gasket API
    * @param  {Next} next Next app instance
    */
    next: function next(gasket, next) {
      next.setAssetPrefix('https://my.cdn.com/dir/');
    }
  }
}

nextConfig

Executed before the next server has been created. It will receive a reference to the next config. This will allow you to modify the next config before the next server is created.

module.exports = {
  hooks: {
    /**
    * Modify the Next config
    * @param  {Gasket} gasket The Gasket API
    * @param  {Object} config Next config
    * @returns {Object} config
    */
    nextConfig(gasket, config) {
      return {
        ...config,
        modification: 'newValue'
      };
    }
  }
}

nextExpress

Provides access to both next and express instances which allows next.render calls in express-based routes.

module.exports = {
  hooks: {
    nextExpress: function (gasket, { next, express }) {
      express.post('/contact-form', (req, res) => {
        // DO STUFF WITH RECEIVED DATA
        //
        // And once we're done, we can `next.render` to render the `pages/thanks`
        // file as a response.
        next.render(req, res, '/thanks', req.params);
      });
    }
  }
}

License

MIT

Usage no npm install needed!