webpackbar

What is webpackbar?

webpackbar is a progress bar plugin for Webpack that provides a visual indication of the build process. It helps developers understand the progress of their Webpack builds by displaying a progress bar in the terminal or console.

What are webpackbar's main functionalities?

Basic Progress Bar

This feature adds a basic progress bar to your Webpack build process. By including the WebpackBar plugin in your Webpack configuration, you can see a progress bar in the terminal that indicates the build progress.

const WebpackBar = require('webpackbar');

module.exports = {
  plugins: [
    new WebpackBar()
  ]
};

Customizing the Progress Bar

This feature allows you to customize the progress bar by setting options such as the name and color. The 'name' option sets a custom name for the progress bar, and the 'color' option sets a custom color.

const WebpackBar = require('webpackbar');

module.exports = {
  plugins: [
    new WebpackBar({
      name: 'MyApp',
      color: '#f56be2'
    })
  ]
};

Profile Mode

This feature enables profile mode, which provides detailed timing information about the build process. By setting the 'profile' option to true, you can get insights into the time taken by different parts of the build.

const WebpackBar = require('webpackbar');

module.exports = {
  plugins: [
    new WebpackBar({
      profile: true
    })
  ]
};

Other packages similar to webpackbar

progress-bar-webpack-plugin

progress-bar-webpack-plugin is another plugin that provides a progress bar for Webpack builds. It is similar to webpackbar in that it displays a progress bar in the terminal, but it may not offer as many customization options as webpackbar.

webpack-dashboard

webpack-dashboard is a plugin that provides a more comprehensive dashboard for Webpack builds, including a progress bar, build statistics, and error reporting. It offers more features compared to webpackbar but may be more complex to set up.

webpack-build-notifier

webpack-build-notifier is a plugin that provides desktop notifications for Webpack build events. While it does not provide a progress bar, it offers a different way to stay informed about the build process by sending notifications when builds start, succeed, or fail.

README

Elegant ProgressBar and Profiler for Webpack

✔ Display elegant progress bar while building or watch

✔ Support of multiply concurrent builds (useful for SSR)

✔ Pretty print filename and loaders

✔ Windows compatible

✔ Customizable

✔ Advanced build profiler

Multi progress bars

Build Profiler

Getting Started

To begin, you'll need to install webpackbar:

Using npm:

npm install webpackbar

Using yarn:

yarn add webpackbar

Then add the reporter as a plugin to your webpack config.

webpack.config.js

const webpack = require('webpack');
const WebpackBar = require('webpackbar');

module.exports = {
  context: path.resolve(__dirname),
  devtool: 'source-map',
  entry: './entry.js',
  output: {
    filename: './output.js',
    path: path.resolve(__dirname)
  },
  plugins: [
    new WebpackBar()
  ]
};

Options

name

• Default: webpack

Display name

color

• Default: green

Display color (can be hex (#xxyyzz) or a web color like green)

profile

• Default: false

Enable profiler

stream

Default: process.stdout

Output stream.

showCursor

Default: false

Show the cursor. This can be useful when a CLI accepts input from a user.

clear

• Default: true

Auto clear console when compile is finished.

Maintainers

Pooya Parsa

Changelog

1.2.1 (2018-03-27)

Bug Fixes

• default clear to true (528b769)

<a name="1.2.0"></a>