1.1.2 • Published 4 years ago
webpack-dev-server-status-bar v1.1.2
Webpack dev server status bar
when webpack status changes from idle -> compiling -> error / warning, a thin bar at the top of the page that changes colors.
Its essentially a nice unobtrusive webpack status notification system
Usage
Add webpack-dev-server-status-bar
as an entry point if invoked via dev-server
Example:
const path = require('path');
const webpack = require('webpack');
const isDevServer = process.argv.some(s => s.match(/webpack-dev-server$/));
const webpackConfig = {
entry: {
app: ["./src/index.js"],
},
output: {
path: path.join(__dirname, `build`),
filename: `[name].bundle.js`,
},
module: {
rules: [
// <loader rules here>
]
},
plugins: [
new webpack.NoEmitOnErrorsPlugin(),
]
};
if (isDevServer) {
webpackConfig.entry.app.push(`webpack-dev-server-status-bar`);
}
module.exports = webpackConfig;
Status Colors
Connected and Idle
Disconnected
Detected change and compiling
Compiled with warnings
Compiled with errors
Customizing
See index.js
for how they are used.
window.__webpackStatusElem__
HTMLElement Element to apply the style on. Default is top leveldiv#__webpack_status_bar__
.window.__webpackEventColors__
Object Override default colors.window.__webpackStatusStyleFunction__
Function Compute custom css style based on status[data-webpack-status]
Attribute to be used with CSS selectors. See colors objects for available values.
Please note that if you want to keep away custom configs from your production codebase, than you should add these inside your own modules.
Customization example
// In webpack config
if (isDevServer) {
webpackConfig.entry.app.push(`./src/webpackStatusBar`);
}
// ./src/webpackStatusBar
window.__webpackStatusElem__ = document.getElementById('my-webpack-status-bar');
window.__webpackStatusColors__ = {
ok: `#0000ff`, // very green
errors: `#ff0000`, // as red as red can be
// see index.js for event names and colors
};
/**
* @typedef {object} WebpackStatus
* @prop {string} event - name of event e.g `ok`, `invalid` `warnings` e.t.c
* @prop {string} color - css color from webpackStatusColors
* @prop {number} progress - progress percentage if event is `progress` else 100
* @prop {string} message - a progress message e.g `compiling`, `emitting` e.t.c
*
* @param {WebpackStatus} status
* @returns {{[prop: string]: any}} - a styles property bag
*/
window.__webpackStatusStyleFunction__ = status => ({
border: `1px solid ${status.color}`,
position: `absolute`,
top: `0px`,
width: `${status.progress}vw`,
content: status.event,
})
require(`webpack-dev-server-status-bar`);