rollup-plugin-progress

1.1.2 verified Mon Apr 27 auth: no javascript abandoned

A Rollup plugin that displays a progress bar and the current module being transpiled during the build process. Version 1.1.2 (latest as of 2017) is stable with no active development. It provides real-time feedback via a progress bar and the filename of the current module, with an option to preserve terminal output (clearLine: false). Differentiator: simple, lightweight, no frills; minimal compared to alternatives like rollup-plugin-visualizer or rollup-plugin-progress-plugin.

Common errors

error Error: Cannot find module 'rollup-plugin-progress' ↓

cause Package not installed or missing from node_modules.

fix

Run npm install rollup-plugin-progress --save-dev

error TypeError: progress is not a function ↓

cause Using named import instead of default import.

fix

Replace import { progress } from 'rollup-plugin-progress' with import progress from 'rollup-plugin-progress'

Warnings

gotcha clearLine defaults to true, which clears the progress output after completion, hiding it from logs. ↓

fix Set clearLine: false if you want to preserve the progress output.

gotcha Plugin may not work with Rollup >=3 due to API changes; last update was for Rollup 0.x/1.x. ↓

fix Consider using rollup-plugin-progress-plugin or omit progress plugin.

gotcha No TypeScript type definitions are provided. ↓

fix Install @types/rollup-plugin-progress if needed, or use a require() with type assertion.

Install

npm install rollup-plugin-progress

yarn add rollup-plugin-progress

pnpm add rollup-plugin-progress

Imports

default

wrong

const progress = require('rollup-plugin-progress')

correct

import progress from 'rollup-plugin-progress'

Package is CJS, but default export works in both ESM and CJS environments.

progress

wrong

import { progress } from 'rollup-plugin-progress'

correct

import progress from 'rollup-plugin-progress'

Default export only; named import does not exist.

Quickstart

Shows how to configure the progress plugin with Rollup, including the optional clearLine flag.

import { rollup } from 'rollup';
import progress from 'rollup-plugin-progress';

rollup({
  input: 'src/index.js',
  plugins: [
    progress({
      clearLine: false // default: true
    })
  ]
}).then(bundle => {
  bundle.write({ file: 'dist/bundle.js', format: 'iife' });
});