A Next.js plugin with all of our default configuration, additional next plugins, custom webpack config, etc. This should be implemented by default for all of our web properties that are using Next.js.
The plugin looks like this inside of your next.config.js file:
const withHashicorp = require('@hashicorp/platform-nextjs-plugin')
module.exports = withHashicorp(/* options */)(/* normal nextjs config */)Let's go through the full options:
withHashicorp({
dato: { token: 'xxx', environment: 'xxx' }, // if necessary, override the default datocms token/env with your own
tipBranch: 'main', // configure a branch name for tip.project.io subdomain, to ensure "noindex" http header is set
transpileModules: ['foo'], // third party package names that should be transpiled by babel
nextOptimizedImages: true, // controls whether or not to integrate the next-optimized-images next plugin
})All of these are optional, none are required to make withHashicorp function properly. In fact, we recommend not using any custom options unless you need to.
Out of the box, this plugin adds a couple useful utilities:
These can both be used in any project implementing @hashicorp/platform-nextjs-plugin as described in their readmes.