https://github.com/lukeed/webpack-messages

Beautifully format Webpack messages throughout your bundle lifecycle(s)!
https://github.com/lukeed/webpack-messages

console create-react-app error-handling formatter messages prettify pretty-print webpack webpack-plugin

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/lukeed/webpack-messages
• Owner: lukeed
• License: mit
• Created: 2017-07-28T20:08:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-02-24T12:38:13.000Z (over 2 years ago)
• Last Synced: 2024-05-11T20:37:58.483Z (6 months ago)
• Topics: console, create-react-app, error-handling, formatter, messages, prettify, pretty-print, webpack, webpack-plugin
• Language: JavaScript
• Size: 177 KB
• Stars: 246
• Watchers: 4
• Forks: 20
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

• awesome-list - webpack-messages

README

        
# 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

```js

// 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`](https://github.com/webpack/docs/wiki/node.js-api#stats) object.

## License

MIT © [Luke Edwards](https://lukeed.com)