@nrwl/rollup

What is @nrwl/rollup?

@nrwl/rollup is a package that provides support for building and bundling JavaScript and TypeScript libraries using Rollup within the Nx workspace. It simplifies the configuration and integration of Rollup in Nx projects, allowing developers to efficiently bundle their code.

What are @nrwl/rollup's main functionalities?

Library Bundling

This feature allows you to bundle a TypeScript library into a single JavaScript file using Rollup. The configuration specifies the input file, output file, and format, along with necessary plugins for resolving modules, handling commonjs, and compiling TypeScript.

module.exports = {
  input: 'src/index.ts',
  output: {
    file: 'dist/bundle.js',
    format: 'cjs'
  },
  plugins: [
    require('@rollup/plugin-node-resolve').nodeResolve(),
    require('@rollup/plugin-commonjs')(),
    require('@rollup/plugin-typescript')()
  ]
};

Nx Integration

This feature demonstrates how to use the createRollupConfig function provided by @nrwl/rollup to generate a Rollup configuration that is integrated with Nx. This simplifies the setup process and ensures compatibility with Nx workspace conventions.

const { createRollupConfig } = require('@nrwl/rollup');

module.exports = createRollupConfig({
  input: 'src/index.ts',
  output: {
    file: 'dist/bundle.js',
    format: 'esm'
  }
});

Custom Plugin Support

This feature shows how to extend the Rollup configuration with custom plugins. By using the createRollupConfig function, you can easily add your own plugins to the Rollup build process, allowing for greater customization and flexibility.

const { createRollupConfig } = require('@nrwl/rollup');
const myCustomPlugin = require('./my-custom-plugin');

module.exports = createRollupConfig({
  input: 'src/index.ts',
  output: {
    file: 'dist/bundle.js',
    format: 'umd'
  },
  plugins: [myCustomPlugin()]
});

Other packages similar to @nrwl/rollup

rollup

Rollup is a module bundler for JavaScript which compiles small pieces of code into something larger and more complex, such as a library or application. It is the core tool that @nrwl/rollup builds upon, providing a more general-purpose solution without the Nx-specific integrations.

webpack

Webpack is a popular module bundler that can handle not only JavaScript but also assets like HTML, CSS, and images. It offers a more comprehensive and flexible solution compared to Rollup, but it can be more complex to configure. Unlike @nrwl/rollup, it is not specifically tailored for Nx workspaces.

parcel

Parcel is a web application bundler that offers a zero-configuration setup. It is designed to be easy to use and fast, making it a good alternative for smaller projects or developers who prefer minimal configuration. However, it lacks the deep Nx integration provided by @nrwl/rollup.

README

@nrwl/rollup has been renamed to @nx/rollup!

@nrwl/rollup has been renamed to @nx/rollup. Please use that instead.

Read more here

@nrwl/rollup will no longer be published in the future.

Nx: Smart Monorepos · Fast CI

Nx is a build system, optimized for monorepos, with plugins for popular frameworks and tools and advanced CI capabilities including caching and distribution.