Transpile untranspiled modules from node_modules using the Next.js Babel configuration. Makes it easy to have local libraries and keep a slick, manageable dev experience.

Supports all extensions supported by Next.js: .js, .jsx, .ts, .tsx, .mjs, .css, .scss and .sass.

This plugin aims to solve the following challenges:

• code transpilation from local packages (think: a monorepo with a styleguide package)
• code transpilation from NPM modules using ES6 imports (e.g lodash-es)

What this plugin does not aim to solve:

• any-package IE11-compatible maker

npm install --save next-transpile-modules

or

yarn add next-transpile-modules

// next.config.js
const withTM = require('next-transpile-modules')(['somemodule', 'and-another']); // pass the modules you would like to see transpiled

module.exports = withTM();

note: please declare withTM as your last plugin (the "most nested" one).

You can include scoped packages or nested ones:

const withTM = require('next-transpile-modules')(['@shared/ui', '@shared/utils']);

// ...

const withTM = require('next-transpile-modules')(['styleguide/components']);

// ...

const withPlugins = require('next-compose-plugins');
const withTM = require('next-transpile-modules')(['some-module', 'and-another']);

module.exports = withPlugins([withTM], {
  // ...
});

Since next-transpile-modules@3 and next@>9.2, this plugin can also transpile CSS included in your transpiled packages. SCSS/SASS is also supported since [email protected].

In your transpiled package:

// shared-ui/components/Button.js
import styles from './Button.module.css';

function Button(props) {
  return (
    <button type='button' className={styles.error}>
      {props.children}
    </button>
  );
}

export default Button;

/* shared-ui/components/Button.module.js */
.error {
  color: white;
  background-color: red;
}

In your app:

// next.config.js
const withTM = require('next-transpile-modules')(['shared-ui']);

// ...

// pages/home.jsx
import React from 'react';
import Button from 'shared-ui/components/Button';

const HomePage = () => {
  return (
    <main>
      {/* will output <button class="Button_error__xxxxx"> */}
      <Button>Styled button</Button>
    </main>
  );
};

export default HomePage;

It also supports global CSS import packages located in node_modules:

// pages/_app.js
import 'shared-ui/styles/global.css'; // will be imported globally

export default function MyApp({ Component, pageProps }) {
  return <Component {...pageProps} />;
}

• it is maintained, @weco's seems dead
• it supports TypeScript
• it supports CSS modules (since Next.js 9.2)
• it supports .mjs

Next.js 7 introduced Webpack 4 and Babel 7, which changed a couple of things, especially for TypeScript and Flow plugins.

If you have a transpilation error when loading a page, check that your babel.config.js is up to date and valid, you may have forgotten a preset there.

In your Next.js app, make sure you use a babel.config.js and not a .babelrc as Babel's configuration file (see explanation below).

Since Next.js 9, you probably don't need that file anymore, as TypeScript is supported natively.

If you get a transpilation error when using Yarn workspaces, make sure you are using a babel.config.js and not a .babelrc. The former is a project-wide Babel configuration, when the latter works for relative paths only (and won't work as Yarn install dependencies in a parent directory).

Make sure you are using a babel.config.js and not a .babelrc. The former is a project-wide Babel configuration, when the latter works for relative paths only.

If you add a local library (let's say with yarn add ../some-shared-module), Yarn will copy those files by default, instead of symlinking them. So your changes to the initial folder won't be copied to your Next.js node_modules directory.

You can go back to npm, or use Yarn workspaces. See an example in the official Next.js repo.

Lerna's purpose is to publish different packages from a monorepo, it does not help for and does not intend to help local development with local modules (<- this, in caps).

This is not coming from me, but from Lerna's maintainer.

So you are probably using it wrong, and I advice you to use npm or Yarn workspaces instead.

You may need to tell your Webpack configuration how to properly resolve your scoped packages, as they won't be installed in your Next.js directory, but the root of your Lerna setup.

const withTM = require('next-transpile-modules')(['@your-project/shared', '@your-project/styleguide']);

module.exports = withTM({
  webpack: (config, options) => {
    config.resolve.alias = {
      ...config.resolve.alias,
      // Will make webpack look for these modules in parent directories
      '@your-project/shared': require.resolve('@your-project/shared'),
      '@your-project/styleguide': require.resolve('@your-project/styleguide')
      // ...
    };
    return config;
  }
});

It can happen that when using next-transpile-modules with a local package and npm, you end up with duplicated dependencies in your final Next.js build. It is important to understand why it happens.

Let's take the following setup: one Next.js app ("Consumer"), and one Styleguide library.

You will probably have react as a peerDependencies and as a devDependecy of the Styleguide. If you use npm i, it will create a symlink to your Styleguide package in your "Consumer" node_modules.

The thing is in this shared package, you also have a node_modules. So when your shared modules requires, let's say react, Webpack will resolve it to the version in your Styleguide's node_modules, and not your Consumer's node_modules. Hence the duplicated react in your final bundles.

You can tell Webpack how to resolve the react of your Styleguide to use the version in your Next.js app like that:

const withTM = require('next-transpile-modules')(['styleguide']);

module.exports = withTM({
  webpack: (config) => {
+   config.resolve.alias['react'] = path.resolve(__dirname, '.', 'node_modules', 'react');

    return config
  },
});

Please note, the above will only work if react is properly declared as peerDependencies or devDependencies in your referenced package.

It is not a great solution, but it works. Any help to find a more future-proof solution is welcome.