webpack-messages's Introduction

webpack-messages

Beautifully format Webpack messages throughout your bundle lifecycle(s)!

Default

Default Error

Named Bundles

Named Bundle Error

Custom Logger

Named Bundle Error w/ Custom Logger

Install

$ npm install webpack-messages --save-dev

Usage

// webpack.config.js
const WebpackMessages = require('webpack-messages');

module.exports = {
  // ...
  plugins: [
    new WebpackMessages({
      name: 'client',
      logger: str => console.log(`>> ${str}`)
    })
  ]
}

API

WebpackMessages(options)

options.name

Type: String

Optionally provide a name for your bundle. Strongly recommended when compiling multiple bundles!

options.logger

Type: Function
Default: str => console.log(str)

Replace the default function -- ideal for prepending a symbol or namespace to your messages.

Function receives a (colorized) message string as its only parameter.

options.onComplete

Type: Function

Run a custom function once a bundle has been compiled successfully. If provided, the default success handler will not run.

Function receives a formatted name string (or '') and the Webpack stats object.

License

MIT © Luke Edwards

webpack-messages's People

Contributors

Stargazers

Watchers

webpack-messages's Issues

[Question] Does this work with webpack-dev-server?

Hi! Does this package work with webpack-dev-server? And if so, is there any kind of special configuration which I would need to make it work?

It doesn't seem to be working for me. Here's an overview of the relevant parts of my webpack.config.js:

const WebpackMessages = require('webpack-messages');

const config = {
  mode: 'development',
  devServer: {
    hot: true,
    port: 3001,
    historyApiFallback: true,
    host: '0.0.0.0',
    disableHostCheck: true,
    contentBase: path.resolve(__dirname, '../dist')
  },
  plugins: [
    new WebpackMessages({
      name: 'myapp'
    }),
  ]
};

Seems like it should be working, but I just get the usual (ugly) webpack output.

Adding types for `webpack-messages`

Thanks for this library, @lukeed.

When looking at converting Webpack configurations to Typescript, I discovered that they were no type declarations for this package. I’ve taken the time to create a declaration for our internal use, but would love to share these with others. Several ways forward are possible, and I would love to have your thoughts on which works best for you:

use JSDoc type declarations into this package. I’ve already created a fork with them
only bring the type declaration as a one-off into this package. I’ve already created a fork with it.
convert this project to typescript. I’ve created a fork for that, too, but you may have no interest to maintain a TS codebase
~~you don’t want to hear about Typescript, and I’ll raise a DefinitelyTyped package on my own. I’m happy with that option too!~~

Disable auto-reloading of the terminal

Hello, this package is really useful for me but I've found that the terminal (ZSH) does a clear screen when webpack compiles and outputs the messages.

Is there a setting that doesn't clear the terminal output so that the log messages just get appended to the terminal?

Thanks

Recommend Projects

lukeed / webpack-messages Goto Github PK