@module-federation/next-transpile-modules
Next.js plugin to transpile code from node_modules (supports TypeScript)
Last updated 3 months ago by zackljackson .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @module-federation/next-transpile-modules 
SYNC missed versions from official npm registry.

Next.js + Transpile node_modules

Build Status Dependencies

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.

What problems does it solve?

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

Compatibility table

Next.js version Plugin version
Next.js 9.2 3.x
Next.js 8 / 9 2.x
Next.js 6 / 7 1.x

Installation

npm install --save next-transpile-modules

or

yarn add next-transpile-modules

Usage

Classic:

// 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).

Scoped packages

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']);

// ...

With next-compose-plugins:

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

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

CSS support

Since next-transpile-modules@3 and next@>9.2, this plugin will also transpile CSS included in your transpiled packages:

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} />;
}

FAQ

What is the difference with @weco/next-plugin-transpile-modules?

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

I have trouble making it work with Next.js 7

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.

I have trouble with transpilation and Flow/TypeScript

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.

I have trouble with transpilation and Yarn workspaces

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).

I have trouble with Yarn and hot reloading

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.

I have trouble making it work with Lerna

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 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.

But... I really need to make it work with Lerna!

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;
  }
});

Current Tags

  • 3.0.2-beta.1                                ...           latest (3 months ago)

2 Versions

  • 3.0.2-beta.1                                ...           3 months ago
  • 3.0.2-beta.0                                ...           3 months ago
Maintainers (2)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (2)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |