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

Beautiful formatting for Webpack messages; ported from Create React App!
https://github.com/lukeed/webpack-format-messages

console create-react-app prettify pretty-print stats webpack

Last synced: 3 months ago
JSON representation

Beautiful formatting for Webpack messages; ported from Create React App!

• Host: GitHub
• URL: https://github.com/lukeed/webpack-format-messages
• Owner: lukeed
• License: mit
• Created: 2017-07-21T02:08:22.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-12-09T19:54:01.000Z (almost 3 years ago)
• Last Synced: 2024-05-11T20:34:09.412Z (6 months ago)
• Topics: console, create-react-app, prettify, pretty-print, stats, webpack
• Language: JavaScript
• Size: 17.6 KB
• Stars: 109
• Watchers: 4
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

• awesome-list - webpack-format-messages

README

        
# webpack-format-messages

> Beautiful formatting for Webpack messages; ported from [Create React App](https://github.com/facebookincubator/create-react-app)!

The console output from CRA is very well-done! Unfortunately, the only way to use it is to install _all_ of `react-dev-utils`, which is quite a module-rich tree. While there is **nothing** wrong with this, many times I'd prefer a quick install for my custom Webpack configs (which aren't always React-related).

If you are already using `react-dev-utils`, you do not need this module and should do this instead:

```js

const formatMessages = require('react-dev-utils/formatWebpackMessages');

```

#### Differences

The source code of this module is (nearly) a direct copy-paste of the original file. Only two modifications have been made:

1. The code has been tailored to run in a Node-specific environment --- the original can also be run in the browser.

2. The module input expects a Webpack `stats` object --- the original required a `toJson()` transformation

## Install

```

$ npm install webpack-format-messages --save-dev

```

## Usage

```js

const webpack = require('webpack');

const formatMessages = require('webpack-format-messages');

// or

const { formatMessages } = require('webpack-format-messages');

const compiler = webpack(/* config */);

compiler.hooks.invalid.tap('invalid', function() {

  console.log('Compiling...');

});

compiler.hooks.done.tap('done', (stats) => {

  const messages = formatMessages(stats);

  if (!messages.errors.length && !messages.warnings.length) {

    console.log('Compiled successfully!');

  }

  if (messages.errors.length) {

    console.log('Failed to compile.');

    messages.errors.forEach(e => console.log(e));

    return;

  }

  if (messages.warnings.length) {

    console.log('Compiled with warnings.');

    messages.warnings.forEach(w => console.log(w));

  }

});

```

## API

### formatMessages(stats)

Returns: `{ errors: string[], warnings: string[] }`

Extracts & prettifies warning and error messages from Webpack.

> **Note:** This is also the `default` export.

#### stats

Type: `Object`

A Webpack [`stats`](https://github.com/webpack/docs/wiki/node.js-api#stats) object.

### formatMessage(message)

Returns: `string`

Transforms an individual webpack `stats` message object into a string.

> **Note:** You probably don't want to use this directly! It's used by `formatMessages` for you.

## Related

* [`webpack-messages`](https://github.com/lukeed/webpack-messages) -- Wraps this module as a Webpack plugin, with lifecycle hooks

## Credits

This module is pulled directly from [`react-dev-utils`](https://github.com/facebookincubator/create-react-app/tree/master/packages/react-dev-utils), provided by Facebook Incubator.

This package exists solely as a standalone install~!