simple-progress-webpack-plugin

simple-progress-webpack-plugin

A simple progress plugin for Webpack, coming with four different logging output formats.

What it does

simple-progress-webpack-plugin is a plugin for Webpack. It improves the overall Webpack Developer Experience by showing a much more detailed and also visually appealing build progress in the command line. Four different output formats are available, from which two are ready to be used in a CI environment (such as GitHub Actions).

How to install

You can get the simple-progress-webpack-plugin via npm by adding it as a new dev-dependency to your package.json file and running npm install. Alternatively, run the following command:

npm install simple-progress-webpack-plugin --save-dev

Requirements

• simple-progress-webpack-plugin requires NodeJS 12 (or higher) to be installed

How to use

To use the plugin, import it into your Webpack configuration file and instantiate it within the list of plugins:

const SimpleProgressWebpackPlugin = require('simple-progress-webpack-plugin');

const webpackConfig = {
  plugins: [new SimpleProgressWebpackPlugin()];
}

How to customize

To customize the plugin, pass options to the constructor of the plugin:

plugins: [
  new SimpleProgressWebpackPlugin({
    format: 'compact',
  }),
];

Options

The following options exist, all of them totally optional:

Option	Description
color	Use colorized console output (might not be available on some CI systems) → Default value: true
format	Logging output format → Default value: compact
name	Name of the build → Default value. Webpack: Starting ...

Logging Formats

The following is a list of available logging output formats. While compact is the default format, expanded is the recommended one for being used within a CI environment.

minimal

The minimal logger prints everything into a single line, constantly updated during the build. This makes it look pretty similar to what the Angular CLI outputs during build. So, if you're a minimalist, this is probably the right logger for you!

Probably not the best choice for your CI!

simple

The simple logger prints each build step, omitting further details. It's simply simple!

compact (default)

The compact logger prints each build step with further details (such as the sub-progress and several sub-steps) while still not taking up too much space (thus the name compact).

Probably not the best choice for your CI!

expanded

The expanded logger is pretty similar to the compact logger, but prints every sub-step into its own separate line.

verbose

The verbose logger logs everything. Like, everything! The full truth, every crucial detail Webpack has to offer. Best use it for debugging purposes (or for finding bugs in this plugin).

Similar / related projects

• Progress Bar Webpack Plugin is an alternative progress plugin for webpack. However, instead of just logging out colored text it uses an animated progress bar. Perfect for anyone who likes bars more than stupid text!
• Ghost Progress Webpack Plugin is a no side effects progress plugin for webpack. It can output progress and does not affect the output log of other tools, and is more suitable for use in a development server environment.
• Friendly Errors Webpack Plugin complements either this plugin or the Progress Bar Webpack Plugin described above. It gives developer a cleaner, more detailed screen once the build has finished. Definitely worth checking out!

Changelog

2.0.0 (2021-04-27)

Wow, more than 3 years since the last release? Time for some updates, I guess. This release mostly adds requested features, but also now requires you to use at least NodeJS 12.

Features

• Add long requested simple logging format, similar to compact but more CI friendly (#63)
• Add name option to customize build title (#62)

Bug Fixes

• Fix the build name appearing multiple times (#60)

Documentation

• Add new preview images, update README (#64)

Chores

• Migrate code base to TypeScript, emit both ESM and CJS bundles in build, add linter, and migrate to GitHub actions (#60)

BREAKING CHANGES

• NodeJS 12 (or higher) is now required

<br>